FB2PostureComponent

Overview

Component that manages posture.

Metadata

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

Properties (7)

Name	Type	Description
`CurrentPostureState`	`FB1PostureState`
`GrabStates`	`table<EB1HandType, FB1GrabState>`
`HoldHandTargetEntityId`	`FB1EntityId`
`OneTimePostureAnimIds`	`string[]`
`PickUpContext`	`FB2PickUpContext`
`PutDownContext`	`FB2PutDownContext`
`SlotOccupyStartTicks`	`integer`

Functions (47)

Function	Parameters	Returns	Description
`ApplyOneTimePostureAnimId`	InOneTimePostureAnimId: `string`	`-`	Applies One Time Posture Anim Id.
`ClearCarriedObject`	InHandType: `EB1HandType`, bSetPutDownEntityId: `boolean`	`-`	Clears Carried Object.
`CurrentAnimId`	InAnimSection: `EB1LoopAnimSection`	`string`
`CurrentGrabLoopAnimBodyParts`	`-`	`EB1AnimBodyParts`
`FillCharacterDataCache_Posture`	OutData: `FB1CharacterDataCache_Posture`	`-`
`FindGrabStateByEntityId`	InEntityId: `FB1EntityId`, OutHandType: `EB1HandType`, OutGrabState: `FB1GrabState`	`boolean`	Finds and returns Grab State By Entity Id.
`FindHandByEntityId`	InEntityId: `FB1EntityId`, OutHandType: `EB1HandType`	`boolean`	Finds and returns Hand By Entity Id.
`FindOneTimePostureOverrideAnimId`	InNextPostureId: `string`, InNextSlotDirection: `EB1SlotDirection`, OutOverrideAnimInfo: `FB1OverridePostureAnimInfo`	`boolean`	Finds and returns One Time Posture Override Anim Id.
`GetCurrentGrabEntityId`	InHandType: `EB1HandType`	`FB1EntityId`	Returns Current Grab Entity Id.
`GetCurrentGrabObject`	InHandType: `EB1HandType`	`FB2CarriableObject`	Returns Current Grab Object.
`GetCurrentPostureState`	`-`	`FB1PostureState`	Returns Current Posture State.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetGrabBodyParts`	`-`	`EB1AnimBodyParts`	Returns Grab Body Parts.
`GetGrabState`	InHandType: `EB1HandType`	`FB1GrabState`	Returns Grab State.
`GetHoldHandTargetEntityId`	`-`	`FB1EntityId`	Returns Hold Hand Target Entity Id.
`GetNextPostureId`	`-`	`string?`	Returns Next Posture Id.
`GetPickUpContext`	`-`	`FB2PickUpContext`	Determines where the PickUp notify attaches during Action_PickUp. Called on OnPlay and released on OnFinish.
`GetPutDownContext`	`-`	`FB2PutDownContext`	Determines where to put down during the PutDown notify in Action_PutDownV2. Called on OnPlay and released on OnFinish.
`HasCarriedEntity`	InHandType: `EB1HandType`	`boolean`	Returns whether it has Carried Entity.
`IsCarriedEntity`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Carried Entity.
`IsHandHoldingUmbrella`	InHandType: `EB1HandType`	`boolean`	Returns whether Hand Holding Umbrella.
`IsHoldingHand`	`-`	`boolean`	Returns whether Holding Hand.
`IsHoldingUmbrella`	`-`	`boolean`	Returns whether Holding Umbrella.
`IsOccupyingCarriableObject`	InTargetEntityId: `FB1EntityId`	`boolean`	Returns whether Occupying Carriable Object.
`IsOccupyingPostureSlot`	InTargetEntityId: `FB1EntityId`, InPostureDirection: `EB1SlotDirection`, InSlotName: `string`	`boolean`	Returns whether Occupying Posture Slot.
`IsPosture`	InPostureCategoryId: `string`	`boolean`	Returns whether Posture.
`IsRiddingVehicle`	`-`	`boolean`	Returns whether Ridding Vehicle.
`IsStanding`	`-`	`boolean`	Returns whether Standing.
`OnChangeGrowthStep`	InPrev: `EB1GrowthStep`, InCurr: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`PlayPostureLoopAnim`	`-`	`-`	Plays Posture Loop Anim.
`ReleaseHoldHand`	`-`	`-`
`RemoveOneTimePostureAnimId`	InOneTimePostureAnimId: `string`	`-`	Removes One Time Posture Anim Id.
`ResetPickUpContext`	`-`	`-`	Resets Pick Up Context.
`ResetPutDownContext`	`-`	`-`	Resets Put Down Context.
`SendHoldHandStatePacket`	`-`	`-`	Sends Hold Hand State Packet.
`SetCarriedEntityId`	InHandType: `EB1HandType`, InEntityId: `FB1EntityId`	`-`	Sets Carried Entity Id.
`SetGrabId`	InHandType: `EB1HandType`, InGrabId: `string`	`-`	Sets Grab Id.
`SetGrabState`	InHandType: `EB1HandType`, InEntityId: `FB1EntityId`, InGrabId: `string`	`-`	Sets Grab State.
`SetNextPostureId`	InPostureId: `string?`	`-`	Sets Next Posture Id.
`SetPickUpContext`	InContext: `FB2PickUpContext`	`-`	Sets Pick Up Context.
`SetPostureState`	InPostureState: `FB1PostureState`	`-`	Sets Posture State.
`SetPutDownContext`	InContext: `FB2PutDownContext`	`-`	Sets Put Down Context.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`StopGrabLoopAnimation`	InHandType: `EB1HandType`	`-`	Stops Grab Loop Animation.
`SyncGrabLoopAnimation`	`-`	`-`
`TryHoldHand`	InTargetEntityId: `FB1EntityId`	`boolean`	Initiates holding hands.
`TryPlayGrabLoopAnimation`	InHandType: `EB1HandType`	`boolean`

Override points (14)

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

Function	Parameters	Returns	Description
`Override_ApplyOneTimePostureAnimId`	InOneTimePostureAnimId: `string`	`-`	Applies One Time Posture Anim Id.
`Override_ClearCarriedObject`	InHandType: `EB1HandType`, bSetPutDownEntityId: `boolean`	`-`	Clears Carried Object.
`Override_CurrentAnimId`	InAnimSection: `EB1LoopAnimSection`	`string`
`Override_CurrentGrabLoopAnimBodyParts`	`-`	`EB1AnimBodyParts`
`Override_HasCarriedEntity`	InHandType: `EB1HandType`	`boolean`	Returns whether it has Carried Entity.
`Override_OnChangeGrowthStep`	InPrev: `EB1GrowthStep`, InCurr: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`Override_PlayPostureLoopAnim`	`-`	`-`	Plays Posture Loop Anim.
`Override_ReleaseHoldHand`	`-`	`-`
`Override_RemoveOneTimePostureAnimId`	InOneTimePostureAnimId: `string`	`-`	Removes One Time Posture Anim Id.
`Override_SendHoldHandStatePacket`	`-`	`-`	Sends Hold Hand State Packet.
`Override_StopGrabLoopAnimation`	InHandType: `EB1HandType`	`-`	Stops Grab Loop Animation.
`Override_SyncGrabLoopAnimation`	`-`	`-`
`Override_TryHoldHand`	InTargetEntityId: `FB1EntityId`	`boolean`	Initiates holding hands.
`Override_TryPlayGrabLoopAnimation`	InHandType: `EB1HandType`	`boolean`