Skip to main content

FB2Action_BuyObjectAtTinyShop

Overview

BuyObjectAtTinyShop 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_BuyObjectAtTinyShop')`

Properties (7)

Name	Type	Description
`AnimMontageName`	`string`	Resolved montage row name used to play the pick-up animation
`FakeObjectList`	`FB1EntityId[]`	Same field as B2Action_Buy's fake-object-substitution feature, but unlike Buy.h, never assigned or read here - appears unimplemented in this class
`GrabId`	`string`	Grab table id for the carriable object being picked up
`GrabLoopAnimId`	`string`	Loop animation id for holding the grabbed object, requested for async preload
`PickUpAnimId`	`string`	Resolved animation id for the pick-up motion
`PostureComponent`	`any`	Cached posture component of the self character, used to set the grab id
`bUseFakeObject`	`boolean`	Same field as B2Action_Buy's fake-object-substitution feature, but unlike Buy.h, never assigned or read here - appears unimplemented in this class

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_BuyObjectAtTinyShop.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)