Skip to main content

FB2Script_Time

Overview

Time-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_Time')`

Functions (7)

Function	Parameters	Returns	Description
`Condition_DayOfTheWeek` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsCalendarEventDay` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsWeekday` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_IsWeekend` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_RealDateCondition` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_Time` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`
`Condition_TimeRange` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`

Override points (7)

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

Function	Parameters	Returns	Description
`Override_Condition_DayOfTheWeek` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsCalendarEventDay` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsWeekday` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_IsWeekend` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_RealDateCondition` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_Time` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_TimeRange` (static)	ScriptContext: `FB2ScriptContext`, Condition: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.