FB2DreamComponent
Overview
- Component that manages dreams.
Metadata
| Field | Value |
|---|---|
| Kind | component |
| Environment | B2 - Simulation |
| Category | components |
| Extends | FB2Component |
| Require | require('Components.B2DreamComponent') |
Properties (18)
| Name | Type | Description |
|---|---|---|
BodyMontageId | string | |
ComponentUpdateFlag | boolean | Added a tick-change check to minimize TickableComponent changes on the parent Entity. |
CurrentDreamSequenceId | string | |
CurrentPoolId | string | |
CurrentSleepwalkInteractionBagId | string | |
FaceMontageId | string | |
InitialDuration | integer | Config |
LastToggledTicks | integer | |
NonREMDuration | integer | |
REMDuration | integer | |
ScheduledBodyAnimId | string | |
ScheduledDreamSequenceId | string | |
ScheduledFaceAnimId | string | |
SequenceDuration | integer | |
SleepwalkingBuffId | string | |
bDreaming | boolean | |
bREM | boolean | |
bSleepwalking | boolean |
Functions (20)
| Function | Parameters | Returns | Description |
|---|---|---|---|
FastDreamInterval | bOn: boolean | - | |
ForceDream | bOn: boolean | - | |
ForceDreamPoolId | InDreamPoolId: string | - | |
ForceDreamSequenceId | InDreamSequenceId: string | - | |
ForceSleepwalkingInteractionBagId | InInteractionBagId: string | - | |
GetAwakeScriptId | - | string | Returns Awake Script Id. |
GetDefaultCityMoveDataPolicy | - | EB1CityMoveDataPolicy | Returns Default City Move Data Policy. |
GetDreamImages | OutDreamImages: UObject[] | boolean | Returns Dream Images. |
GetDreamSequence | - | FB1DreamSequenceTableRow | Returns Dream Sequence. |
GetVoiceResourceId | - | string | Returns Voice Resource Id. |
IsREM | - | boolean | Returns whether REM. |
IsSleepwalking | - | boolean | Returns 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 | - | boolean | Returns whether it should Use Scheduler. |
Simulate | InCount: integer, OutResultStr: string | - |
Override points (11)
Implement these in Lua as FB2DreamComponent.Override_Name = function(...) end.
| Function | Parameters | Returns | Description |
|---|---|---|---|
Override_FastDreamInterval | bOn: boolean | - | |
Override_ForceDream | bOn: boolean | - | |
Override_ForceDreamPoolId | InDreamPoolId: string | - | |
Override_ForceDreamSequenceId | InDreamSequenceId: string | - | |
Override_ForceSleepwalkingInteractionBagId | InInteractionBagId: 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 | - | - |