FB2Action_PutDown

Overview

• Put-down action. Difference from the legacy FB2Action_PutDown: GrabEntityId must already be set at OnInit() time.

Metadata

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

Properties (13)

Name	Type	Description
AnimMontageName	string	Montage name resolved from PutDownAnimId to put down grab entity
ChangePostureState	FB1PostureState	Posture state to apply to grab entity after put down (used when grab entity is a character)
CurrentAnimTime	number	Elapsed time of put-down anim montage playback (reset to 0 on OnPlay)
GrabAnimMontageName	string	Montage name of grab entity's holding loop animation (stopped when put down finishes)
GrabId	string	FB1GrabTableRow row id of grab entity (grab type/definition key, not an entity id)
PostureAnimId	string	Anim id for grab entity's target posture (used when grab entity is a character)
PostureAnimMontageName	string	Montage name for grab entity's target posture (used when grab entity is a character)
PutDownAnimId	string	Anim id used to find put-down montage for grab entity
PutDownLocation	FVector	World location to put down grab entity
PutDownMethod	EB1PutDownMethod	How to put down object/character
PutDownRotation	FRotator	World rotation to put down grab entity
SelectedHand	EB1HandType	Hand with grab entity
TotalPlayLength	number	Total play length of put-down anim montage (from montage table row)

Functions (6)

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.
SetPutDownMethod	InMethod: EB1PutDownMethod	-	Sets Put Down Method.

Override points (5)

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