FB2Action_Clean

Overview

• Clean 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_Clean')

Properties (5)

Name	Type	Description
AddingDustyValue	number	Dust-value delta (from the clean object's ReduceDustyValue) applied to nearby dusty objects on finish
ChangeNormalStateObjectTag	string	Tag identifying game objects whose state should reset to Normal when cleaned (CleanDusty only)
EffectiveDistance	number	Max distance from the character within which nearby dusty objects are affected on finish
InDoorObjectId	string	Randomly selected indoor clean-target object id, used when there is no explicit interaction target
OutDoorObjectId	string	Randomly selected outdoor clean-target object id, used when there is no explicit interaction target

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