Skip to main content

FB2StateComponent

Overview

Component that manages entity state.

Metadata

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

Properties (10)

Name	Type	Description
`ActiveDoodleTextureIds`	`string[]`
`CachedCurrentState`	`FB2State`
`CachedStateHash`	`integer`
`ChannelId`	`string`
`LastUpdateSootValue`	`number`
`SpawnedFireId`	`FB1FireId`
`SpawnedFireSiteId`	`FB1EntityId`
`SpreadLevel`	`integer`
`SpreadOriginPos`	`FVector`
`States`	`table<string, FB2State>`

Functions (19)

Function	Parameters	Returns	Description
`ChangeChannel`	InChannelId: `string`, InInstigator: `FB1EntityId`	`-`
`ChangeState`	InStateGroupId: `string`, InStateId: `string`, InInstigator: `FB1EntityId`	`-`
`ClearStateSentInfo`	`-`	`-`	Clears State Sent Info.
`GetCurrentChannelId`	`-`	`string`	Returns Current Channel Id.
`GetCurrentState`	`-`	`FB2State`	Returns Current State.
`GetCurrentStateGroupId`	`-`	`string`	Returns Current State Group Id.
`GetCurrentStateId`	`-`	`string`	Returns Current State Id.
`HasState`	InStateGroupId: `string`, InStateId: `string`	`boolean`	Returns whether it has State.
`IsInState`	InStateGroupId: `string`, InStateId: `string`	`boolean`	Directly iterates the currently held States and checks for a (StateGroupId, StateId) match, regardless of StatePriority registration.
`IsSameState`	InStateGroupId: `string`, InStateId: `string`	`boolean`	Returns whether Same State.
`NotifyOwnerObjectInventory`	`-`	`-`
`NotifyParentObjectInventory`	`-`	`-`
`OnMontageSectionFinished`	InAnimMontageName: `string`, InSectionName: `string`	`-`	Callback invoked on Montage Section Finished.
`RemoveState`	InStateGroupId: `string`, InStateId: `string`	`-`	Removes State.
`SendCurrentStatePacket`	bForceSend: `boolean`	`-`	Sends Current State Packet.
`SendInventoryUpdatePacket`	`-`	`-`	Sends Inventory Update Packet.
`SetSpreadOriginPos`	InOriginPos: `FVector`	`-`	Sets Spread Origin Pos.
`SetSpreadStep`	InSpreadLevel: `integer`	`-`	Sets Spread Step.
`UpdateSootValueInitialState`	`-`	`-`	Updates Soot Value Initial State.

Override points (11)

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

Function	Parameters	Returns	Description
`Override_ChangeChannel`	InChannelId: `string`, InInstigator: `FB1EntityId`	`-`
`Override_ChangeState`	InStateGroupId: `string`, InStateId: `string`, InInstigator: `FB1EntityId`	`-`
`Override_HasState`	InStateGroupId: `string`, InStateId: `string`	`boolean`	Returns whether it has State.
`Override_IsInState`	InStateGroupId: `string`, InStateId: `string`	`boolean`	Directly iterates the currently held States and checks for a (StateGroupId, StateId) match, regardless of StatePriority registration.
`Override_NotifyOwnerObjectInventory`	`-`	`-`
`Override_NotifyParentObjectInventory`	`-`	`-`
`Override_OnMontageSectionFinished`	InAnimMontageName: `string`, InSectionName: `string`	`-`	Callback invoked on Montage Section Finished.
`Override_RemoveState`	InStateGroupId: `string`, InStateId: `string`	`-`	Removes State.
`Override_SendCurrentStatePacket`	bForceSend: `boolean`	`-`	Sends Current State Packet.
`Override_SendInventoryUpdatePacket`	`-`	`-`	Sends Inventory Update Packet.
`Override_UpdateSootValueInitialState`	`-`	`-`	Updates Soot Value Initial State.