FB2Action_PutDownInventoryObject
Overview
- PutDownInventoryObject action. Override the OnPlay/OnFinish/OnPaused/OnCanceled/OnTick timing hooks in Lua.
Metadata
| Field | Value |
|---|---|
| Kind | action |
| Environment | B2 - Simulation |
| Category | actions |
| Extends | FB2Action_Base |
| Require | require('Actions.B2Action_PutDownInventoryObject') |
Properties (6)
| Name | Type | Description |
|---|---|---|
AnimMontageName | string | Montage name resolved from PutDownAnimId to put down the carried object |
CurrentAnimTime | number | Elapsed time of put-down anim montage playback (reset on OnPlay) |
FloorPutDownLocation | FVector | Floor location to put down the carried object when there's no target entity, computed via site pathfinding |
GrabId | string | FB1GrabTableRow row id for the carried object (hardcoded to Food), used to resolve the put-down animation |
PutDownAnimId | string | Anim id used to find the put-down montage for the carried object |
TotalPlayLength | number | Total play length of the resolved put-down anim montage (from montage table row) |
Functions (5)
| 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. |
Override points (5)
Implement these in Lua as FB2Action_PutDownInventoryObject.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) |