Skip to main content

FB2Script_Family

Overview

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

Metadata

FieldValue
Kindscript
EnvironmentB2 - Simulation
Categoryscripts
Requirerequire('Scripts.B2Script_Family')

Functions (30)

FunctionParametersReturnsDescription
Condition_CharacterGroupType (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_CheckTaxPaymentAutomatic (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_CheckTaxPaymentDirect (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_FamilyRelationshipCount (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_HasAccommodationRoom (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_HasFamilyRelationship (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_HasHome (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_HasHomelessSite (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsAccommodationRoom (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsCohabitable (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsFamilyAgeRank (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsFamilyHead (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsFamilyInPastLife (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsFamilyRelationship (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsFullHouseholdMembers (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsGenerationRankDifference (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsGrabbingHouseMate (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsHome (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsHouseMate (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsInSameFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsNPC (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsPlayerFamily (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsPlayerFamilyAndFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsPlayerFamilyOrFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsPlayerFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsPossessedFamilyToday (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Condition_IsSiteScheduleNPC (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1Conditionboolean
Execute_AddFamilyMonitoringNotification (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-
Execute_Cohabit (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-
Execute_SetUseDirectTaxPayment (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-

Override points (30)

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

FunctionParametersReturnsDescription
Override_Condition_CharacterGroupType (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_CheckTaxPaymentAutomatic (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_CheckTaxPaymentDirect (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_FamilyRelationshipCount (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_HasAccommodationRoom (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_HasFamilyRelationship (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_HasHome (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_HasHomelessSite (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsAccommodationRoom (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsCohabitable (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsFamilyAgeRank (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsFamilyHead (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsFamilyInPastLife (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsFamilyRelationship (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsFullHouseholdMembers (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsGenerationRankDifference (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsGrabbingHouseMate (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsHome (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsHouseMate (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsInSameFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsNPC (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsPlayerFamily (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsPlayerFamilyAndFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsPlayerFamilyOrFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsPlayerFamilyTree (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsPossessedFamilyToday (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Condition_IsSiteScheduleNPC (static)InScriptContext: FB2ScriptContext, InConditionParam: FB1ConditionbooleanScript condition check (Condition). Override in Lua to redefine the condition result.
Override_Execute_AddFamilyMonitoringNotification (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-Script execution (Execute). Override in Lua to redefine the behavior.
Override_Execute_Cohabit (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-Script execution (Execute). Override in Lua to redefine the behavior.
Override_Execute_SetUseDirectTaxPayment (static)InScriptContext: FB2ScriptContext, InExecuteParam: FB1Execute-Script execution (Execute). Override in Lua to redefine the behavior.