FB2Action_WalkToHome

Overview

• WalkToHome action. Override the OnPlay/OnFinish/OnPaused/OnCanceled/OnTick timing hooks in Lua.

Metadata

Field	Value
Kind	action
Environment	B2 - Simulation
Category	actions
Extends	FB2Action_WalkTo
Require	require('Actions.B2Action_WalkToHome')

Properties (11)

Name	Type	Description
DespawnSpawnerEntityId	FB1EntityId	Despawn spawner to walk/teleport to when going home via a spawner (invalid when the destination is a residence site)
GetOutOriginSiteEntityId	FB1EntityId	Site the walker was being evicted from when this action started
GetOutResolvedDestination	FVector	Last destination successfully resolved by WalkToHome for the eviction move
HomeSiteEntityId	FB1EntityId
PendingAccommodationRoomId	string	Check-in room purpose to walk to inside the accommodation site during stage-2
PendingAccommodationSiteId	FB1EntityId	Accommodation site id to arrive at before resuming the pending stage-2 accommodation room move
PreviousLocation	FVector	Walker's location on the previous tick, used to detect arrival at the despawn spawner
bArrivedSiteNeedAccommodationRoomMove	boolean	True while arrival at the accommodation is done and a stage-2 accommodation room move is still pending
bDidGetOutFallbackTeleport	boolean	Whether the eviction fallback teleport has already been performed
bHasGetOutResolvedDestination	boolean	Whether an eviction destination was successfully resolved
bUseGetOutFallback	boolean	Whether this WalkToHome action should use the eviction cancellation fallback

Functions (4)

Function	Parameters	Returns	Description
OnCanceled	-	-	Callback invoked on Canceled.
OnFinish	-	-	Callback invoked on Finish.
OnPaused	-	-	Callback invoked on Paused.
OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Callback invoked on Tick.

Override points (4)

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

Function	Parameters	Returns	Description
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_OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Timing hook called every tick while the action runs. (performance-sensitive)