Skip to main content

FB2CoopComponent

Overview

Component that manages co-op interactions.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2CoopComponent')`

Properties (4)

Name	Type	Description
`ConnectedSchedulerId`	`FB1EntityId`
`bCoopPlayerReady`	`boolean`
`bCoopProceed`	`boolean`
`bPlayingCoop`	`boolean`

Functions (18)

Function	Parameters	Returns	Description
`GetConnectedSchedulerId`	`-`	`FB1EntityId`	Returns Connected Scheduler Id.
`GetContextVoiceResourceId`	`-`	`string`	Returns Context Voice Resource Id.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetPlayingCoopType`	`-`	`EB1CoopType`	Returns Playing Coop Type.
`IsCoopPlayerReady`	`-`	`boolean`	Returns whether Coop Player Ready.
`IsCoopProceed`	`-`	`boolean`	Returns whether Coop Proceed.
`IsPlayingCoop`	`-`	`boolean`	Returns whether Playing Coop.
`OnAsyncLoadFinished`	InSchedulerId: `FB1EntityId`	`-`	Callback invoked on Async Load Finished.
`OnEndCoop`	`-`	`-`	Callback invoked on End Coop.
`OnEndCoopInteraction`	InParam: `FB2OnEndCoopInteractionParam`	`-`	Callback invoked on End Coop Interaction.
`OnFinishedActionContext`	`-`	`-`	Callback invoked on Finished Action Context.
`OnLeaveZoiGroup`	`-`	`-`	Callback invoked on Leave Zoi Group.
`OnStartCoop`	InSchedulerId: `FB1EntityId`	`-`	Callback invoked on Start Coop.
`RequestCancelCurrentCoop`	InCoopResult: `EB1CoopResult`	`-`	Requests Cancel Current Coop.
`ResetActionContexts`	`-`	`-`	Resets Action Contexts.
`SetCoopPlayerReady`	InReady: `boolean`	`-`	Sets Coop Player Ready.
`SetCoopProceed`	InReady: `boolean`	`-`	Sets Coop Proceed.
`SetPlayingCoop`	InValue: `boolean`	`-`	Sets Playing Coop.

Override points (7)

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

Function	Parameters	Returns	Description
`Override_OnAsyncLoadFinished`	InSchedulerId: `FB1EntityId`	`-`	Callback invoked on Async Load Finished.
`Override_OnEndCoop`	`-`	`-`	Callback invoked on End Coop.
`Override_OnFinishedActionContext`	`-`	`-`	Callback invoked on Finished Action Context.
`Override_OnLeaveZoiGroup`	`-`	`-`	Callback invoked on Leave Zoi Group.
`Override_OnStartCoop`	InSchedulerId: `FB1EntityId`	`-`	Callback invoked on Start Coop.
`Override_RequestCancelCurrentCoop`	InCoopResult: `EB1CoopResult`	`-`	Requests Cancel Current Coop.
`Override_ResetActionContexts`	`-`	`-`	Resets Action Contexts.