Skip to main content

FB2Action_WalkToScheduleDest

Overview

  • Action that moves to the current CustomSchedule slot's destination (RoomPurpose or GotoOtherSite).

Metadata

FieldValue
Kindaction
EnvironmentB2 - Simulation
Categoryactions
ExtendsFB2Action_WalkTo
Requirerequire('Actions.B2Action_WalkToScheduleDest')

Properties (2)

NameTypeDescription
PendingRoomSiteEntityIdFB1EntityIdDestination site id to arrive at before resuming the pending stage-2 room move
bArrivedSiteNeedRoomMovebooleanCross-site two-stage move state. True when the character is outside the destination room's site and fell back to stage 1 (site-to-site move). A one-shot flag to continue the stage-2 move to the room via another RequestPath after arriving at the site. Not snapshotted (transient state); when reset to false on save/restore, it ends normally at the site arrival point (the room move can be redone by re-clicking).

Functions (4)

FunctionParametersReturnsDescription
OnCanceled--Callback invoked on Canceled.
OnFinish--Callback invoked on Finish.
OnPaused--Callback invoked on Paused.
OnTickDeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number-Callback invoked on Tick.

Override points (4)

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

FunctionParametersReturnsDescription
Override_OnCanceled--Timing hook called when the action is canceled.
Override_OnFinish--Timing hook called when the action finishes.
Override_OnPaused--Timing hook called when the action is paused.
Override_OnTickDeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number-Timing hook called every tick while the action runs. (performance-sensitive)