Skip to main content

FB2Script_Stat

Overview

Stat-domain game-rule script (Condition_/Execute_ static functions). Override in Lua with Override_.

Metadata

Field	Value
Kind	`script`
Environment	B2 - Simulation
Category	`scripts`
Require	`require('Scripts.B2Script_Stat')`

Functions (13)

Function	Parameters	Returns	Description
`Condition_Stat` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`
`Execute_AddScaledStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_AddStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_AddTransientDesireStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_ChangeAdmitDesireBoost` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_ChangeJoyfulDesireBoost` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_ModifyChildrenStatsWithTag` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`
`Execute_ModifyGrabbedObjectStat` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`
`Execute_ModifyStatRangeWithObjectTag` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`
`Execute_RegisterStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_RemoveStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_RemoveTransientDesireStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`
`Execute_TryAddStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`

Override points (13)

Implement these in Lua as FB2Script_Stat.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_Condition_Stat` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Execute_AddScaledStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_AddStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_AddTransientDesireStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ChangeAdmitDesireBoost` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ChangeJoyfulDesireBoost` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ModifyChildrenStatsWithTag` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ModifyGrabbedObjectStat` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ModifyStatRangeWithObjectTag` (static)	InScriptContext: `FB2ScriptContext`, InExecute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_RegisterStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_RemoveStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_RemoveTransientDesireStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_TryAddStat` (static)	ScriptContext: `FB2ScriptContext`, Execute: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.