FB2Action_Eat

Overview

• Eat action. Override the OnPlay/OnFinish/OnPaused/OnCanceled/OnTick timing hooks in Lua.

Metadata

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

Properties (6)

Name	Type	Description
FoodObject	any	Food game object being eaten
HeadAnimId	string	Animation id for the head/facial eating montage, provided via the action's S2 param
HeadAnimMontageName	string	Resolved montage name for the head anim, used to play the facial eating montage
PrevRemainCalorie	number	Food's remaining calorie value captured at action start, used to compute consumed calories on finish
ProgressTime	number	Total duration required to eat the food, computed from remaining calories and time-to-eat
SelectedHand	EB1HandType	Hand holding the food object, used to select the one-hand eating animation variant

Functions (6)

Function	Parameters	Returns	Description
GetActionOneLoopPlayLength	-	number	Returns Action One Loop Play Length.
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_Eat.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)