Skip to main content

FB2SubActionComponent

Overview

Component that manages sub-actions.

Metadata

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

Properties (3)

Name	Type	Description
`CurrentSubAction`	`any`
`Histories`	`FB2SubActionHistory[]`
`SubActions`	`any[]`

Functions (19)

Function	Parameters	Returns	Description
`AddHistory`	InHistory: `FB2SubActionHistory`	`-`	Adds History.
`CancelSubAction`	`-`	`-`
`CancelSubActionByType`	InSubActionType: `EB1SubActionType`	`-`
`FindHistoryByTargetId`	InTargetId: `FB1EntityId`	`FB2SubActionHistory`	Finds and returns History By Target Id.
`FindHistoryByTargetIdAndType`	InTargetId: `FB1EntityId`, InSubActionType: `EB1SubActionType`	`FB2SubActionHistory`	Finds and returns History By Target Id And Type.
`FinishSubAction`	InSubActionType: `EB1SubActionType`	`-`
`ForceStartSubAction`	InType: `EB1SubActionType`	`boolean`	Force-starts a SubAction, bypassing the IsSubActionStartable() gating, when immediate playback is needed (e.g. a hit reaction). Any in-progress SubAction is first cleaned up via FinishSubAction. ClearCharacterState is recommended before calling.
`GetCurrentSubAction`	Self: `FB2SubActionComponent`	`-`	Returns Current Sub Action.
`GetCurrentSubActionType`	`-`	`EB1SubActionType`	Returns Current Sub Action Type.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetSubAction`	Self: `FB2SubActionComponent`, Type: `EB1SubActionType`	`-`	Returns Sub Action.
`GetType`	`-`	`EB2ComponentType`	Returns Type.
`IsActive`	InType: `EB1SubActionType`	`boolean`	Returns whether Active.
`IsPlayingHitReaction`	`-`	`boolean`	Returns whether the currently playing SubAction is a hit reaction (attack-hit knockback anim). Used to block adding interactions during a hit reaction.
`IsSubActionStartable`	`-`	`boolean`	Returns whether Sub Action Startable.
`OnFinishSubAction`	`-`	`-`	Callback invoked on Finish Sub Action.
`OnSubActionReady`	`-`	`-`	Callback invoked on Sub Action Ready.
`RequestStart`	InRequest: `FB2SubActionRequest`	`boolean`	Requests Start.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.

Override points (8)

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

Function	Parameters	Returns	Description
`Override_AddHistory`	InHistory: `FB2SubActionHistory`	`-`	Adds History.
`Override_CancelSubAction`	`-`	`-`
`Override_CancelSubActionByType`	InSubActionType: `EB1SubActionType`	`-`
`Override_FinishSubAction`	InSubActionType: `EB1SubActionType`	`-`
`Override_ForceStartSubAction`	InType: `EB1SubActionType`	`boolean`	Force-starts a SubAction, bypassing the IsSubActionStartable() gating, when immediate playback is needed. Any in-progress SubAction is first cleaned up via FinishSubAction.
`Override_OnFinishSubAction`	`-`	`-`	Callback invoked on Finish Sub Action.
`Override_OnSubActionReady`	`-`	`-`	Callback invoked on Sub Action Ready.
`Override_RequestStart`	InRequest: `FB2SubActionRequest`	`boolean`	Requests Start.