Skip to main content

FB2DreamComponent

Overview

  • Component that manages dreams.

Metadata

FieldValue
Kindcomponent
EnvironmentB2 - Simulation
Categorycomponents
ExtendsFB2Component
Requirerequire('Components.B2DreamComponent')

Properties (18)

NameTypeDescription
BodyMontageIdstring
ComponentUpdateFlagbooleanAdded a tick-change check to minimize TickableComponent changes on the parent Entity.
CurrentDreamSequenceIdstring
CurrentPoolIdstring
CurrentSleepwalkInteractionBagIdstring
FaceMontageIdstring
InitialDurationintegerConfig
LastToggledTicksinteger
NonREMDurationinteger
REMDurationinteger
ScheduledBodyAnimIdstring
ScheduledDreamSequenceIdstring
ScheduledFaceAnimIdstring
SequenceDurationinteger
SleepwalkingBuffIdstring
bDreamingboolean
bREMboolean
bSleepwalkingboolean

Functions (20)

FunctionParametersReturnsDescription
FastDreamIntervalbOn: boolean-
ForceDreambOn: boolean-
ForceDreamPoolIdInDreamPoolId: string-
ForceDreamSequenceIdInDreamSequenceId: string-
ForceSleepwalkingInteractionBagIdInInteractionBagId: string-
GetAwakeScriptId-stringReturns Awake Script Id.
GetDefaultCityMoveDataPolicy-EB1CityMoveDataPolicyReturns Default City Move Data Policy.
GetDreamImagesOutDreamImages: UObject[]booleanReturns Dream Images.
GetDreamSequence-FB1DreamSequenceTableRowReturns Dream Sequence.
GetVoiceResourceId-stringReturns Voice Resource Id.
IsREM-booleanReturns whether REM.
IsSleepwalking-booleanReturns whether Sleepwalking.
OnSleepwalkingInteractionFinished--Callback invoked on Sleepwalking Interaction Finished.
RequestEndDream--Requests End Dream.
RequestEndSleepwalking--Requests End Sleepwalking.
RequestStartDream--Requests Start Dream.
ResetCheatData--Resets Cheat Data.
Send_S_InitDream--
ShouldUseScheduler-booleanReturns whether it should Use Scheduler.
SimulateInCount: integer, OutResultStr: string-

Override points (11)

Implement these in Lua as FB2DreamComponent.Override_Name = function(...) end.

FunctionParametersReturnsDescription
Override_FastDreamIntervalbOn: boolean-
Override_ForceDreambOn: boolean-
Override_ForceDreamPoolIdInDreamPoolId: string-
Override_ForceDreamSequenceIdInDreamSequenceId: string-
Override_ForceSleepwalkingInteractionBagIdInInteractionBagId: string-
Override_OnSleepwalkingInteractionFinished--Callback invoked on Sleepwalking Interaction Finished.
Override_RequestEndDream--Requests End Dream.
Override_RequestEndSleepwalking--Requests End Sleepwalking.
Override_RequestStartDream--Requests Start Dream.
Override_ResetCheatData--Resets Cheat Data.
Override_Send_S_InitDream--