Skip to main content

FB2Action_WalkToSharedSiteSpawner

Overview

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

Metadata

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

Properties (2)

NameTypeDescription
DestSpawnerLocationFVectorResolved teleport destination at the linked school site's walk-to point
bTeleportModebooleanIf F2 > 0, teleports to the destination site's SharedSiteSpawner location after arrival.

Functions (5)

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.
SetParams-EB1InteractionCancelReasonSets Params.

Override points (4)

Implement these in Lua as FB2Action_WalkToSharedSiteSpawner.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)