Skip to main content

FB2Action_WaitForAsyncLoad

Overview

Action automatically added when AsyncLoad is used.

Metadata

Field	Value
Kind	`action`
Environment	B2 - Simulation
Category	`actions`
Extends	`FB2Action_Base`
Require	`require('Actions.B2Action_WaitForAsyncLoad')`

Properties (3)

Name	Type	Description
`AsyncLoadId`	`FB1AsyncLoadId`	id of the async load being waited on, set externally via SetAsyncLoadId() and matched in OnFinishAsyncLoad()
`CoopSchedulerId`	`FB1EntityId`	id of the coop scheduler this wait belongs to, set externally via SetCoopSchedulerId() and used to check/notify the shared coop pending-load state
`IsNeedCoopPendingAsyncLoad`	`boolean`	whether the coop scheduler requires waiting for its shared pending-load signal before finishing, computed in InitializeSetting()

Functions (7)

Function	Parameters	Returns	Description
`OnCanceled`	`-`	`-`	Callback invoked on Canceled.
`OnFinish`	`-`	`-`	Callback invoked on Finish.
`OnPaused`	`-`	`-`	Callback invoked on Paused.
`OnPlay`	`-`	`-`	Callback invoked on Play.
`OnTick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Callback invoked on Tick.
`SetAsyncLoadId`	InAsyncLoadId: `FB1AsyncLoadId`	`-`	Sets Async Load Id.
`SetCoopSchedulerId`	InCoopSchedulerId: `FB1EntityId`	`-`	Sets Coop Scheduler Id.

Override points (5)

Implement these in Lua as FB2Action_WaitForAsyncLoad.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_OnPlay`	`-`	`-`	Timing hook called when the action starts (play). Override in Lua to replace the start behavior.
`Override_OnTick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`	Timing hook called every tick while the action runs. (performance-sensitive)