Skip to main content

FB2Script_Currency

Overview

Currency-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_Currency')`

Functions (15)

Function	Parameters	Returns	Description
`Condition_HasEnoughCurrencyForTax` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HasMortgageLoan` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HasUsuryLoan` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_HaveCurrency` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Condition_LoanOverdueCount` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`
`Execute_AddCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_AddCurrencyRange` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_AddCurrencyToHouseholdBiz` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_DeductCurrencyFromHouseholdBiz` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_ExchangeCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_LoanDisbursement` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_LoanRepayment` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_PayTax` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_RefundHouseholdBizPayment` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`
`Execute_SetCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`

Override points (15)

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

Function	Parameters	Returns	Description
`Override_Condition_HasEnoughCurrencyForTax` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HasMortgageLoan` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HasUsuryLoan` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_HaveCurrency` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Condition_LoanOverdueCount` (static)	InScriptContext: `FB2ScriptContext`, InConditionParam: `FB1Condition`	`boolean`	Script condition check (Condition). Override in Lua to redefine the condition result.
`Override_Execute_AddCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_AddCurrencyRange` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_AddCurrencyToHouseholdBiz` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_DeductCurrencyFromHouseholdBiz` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_ExchangeCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_LoanDisbursement` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_LoanRepayment` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_PayTax` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_RefundHouseholdBizPayment` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.
`Override_Execute_SetCurrency` (static)	InScriptContext: `FB2ScriptContext`, InExecuteParam: `FB1Execute`	`-`	Script execution (Execute). Override in Lua to redefine the behavior.