FB2Script_Utils
Overview
- Utils-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_Utils') |
Functions (8)
| Function | Parameters | Returns | Description |
|---|---|---|---|
Condition_NumberOfChildObject (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | |
Condition_NumberOfHouseholdInSite (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | |
Condition_NumberOfObject (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | |
Condition_NumberOfZOI (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | |
Condition_TargetDistance (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | |
Execute_OpenTutorialGuide (static) | InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute | - | |
Execute_ToastMessage (static) | InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute | - | |
GetDistance2DByEntityId (static) | InFromEntityId: FB1EntityId, InToEntityId: FB1EntityId | number | Returns Distance2 DBy Entity Id. |
Override points (7)
Implement these in Lua as FB2Script_Utils.Override_Name = function(...) end.
| Function | Parameters | Returns | Description |
|---|---|---|---|
Override_Condition_NumberOfChildObject (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | Script condition check (Condition). Override in Lua to redefine the condition result. |
Override_Condition_NumberOfHouseholdInSite (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | Script condition check (Condition). Override in Lua to redefine the condition result. |
Override_Condition_NumberOfObject (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | Script condition check (Condition). Override in Lua to redefine the condition result. |
Override_Condition_NumberOfZOI (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | Script condition check (Condition). Override in Lua to redefine the condition result. |
Override_Condition_TargetDistance (static) | InScriptContext: FB2ScriptContext, InConditionParam: FB1Condition | boolean | Script condition check (Condition). Override in Lua to redefine the condition result. |
Override_Execute_OpenTutorialGuide (static) | InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute | - | Script execution (Execute). Override in Lua to redefine the behavior. |
Override_Execute_ToastMessage (static) | InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute | - | Script execution (Execute). Override in Lua to redefine the behavior. |