Skip to main content

FB2Action_CoopSelect

Overview

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

Metadata

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

Properties (7)

Name	Type	Description
`CoopId`	`string`	coop table row id to select participants for, from InAction.S1 or the current interaction's coop-start info
`InteractionBagId`	`string`	current interaction bag id, cached for coop request params and the selection UI packet
`LastCoopResult`	`EB1CoopResult`	result of the last coop start attempt, used to build the result toast message
`ZoiGroupFlags`	`integer`	zoi-group flag bitmask copied from the interaction bag row, forwarded to the coop request
`bIsZoiGroupInteraction`	`boolean`	whether the current interaction was triggered as a user-selected zoi-group coop, used to pick the coop request reason
`bRestore`	`boolean`	whether this action is being resumed mid-play from a save/restore, so redundant toast/UI cleanup and result reporting are skipped
`bSendPacket`	`boolean`	whether a coop-select UI packet was sent, gating whether OnFinish/OnCanceled must unsubscribe/hide UI and whether OnTick auto-finishes

Functions (5)

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.

Override points (5)

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