Skip to main content

FB2ModifierComponent

Overview

  • Component that manages various modifiers.

Metadata

FieldValue
Kindcomponent
EnvironmentB2 - Simulation
Categorycomponents
ExtendsFB2Component
Requirerequire('Components.B2ModifierComponent')

Properties (3)

NameTypeDescription
DebugModifierTypeFiltertable<EB1ModifierType, boolean>
ModifierIdstable<string, boolean>
ModifierMaptable<EB1ModifierType, table<string, FB1ModifierData>>

Functions (7)

FunctionParametersReturnsDescription
AddModifierModifierId: string, bSendEvent: boolean-Adds Modifier.
CalculateModifierValueInModifierType: EB1ModifierType, InKey: string, InValue: number, InIgnoreWorldModifier: booleannumber
CalculateModifierValueExInModifierType: EB1ModifierType, InKey: string, InValue: number, InIgnoreWorldModifier: booleannumberStat optimization-test variant.
GetDefaultCityMoveDataPolicy-EB1CityMoveDataPolicyReturns Default City Move Data Policy.
HasModifierInModifierType: EB1ModifierType, InKey: string, InIgnoreWorldModifier: booleanbooleanReturns whether it has Modifier.
RemoveAllModifiers--Removes All Modifiers.
RemoveModifierModifierId: string-Removes Modifier.

Override points (6)

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

FunctionParametersReturnsDescription
Override_AddModifierModifierId: string, bSendEvent: boolean-Adds Modifier.
Override_CalculateModifierValueInModifierType: EB1ModifierType, InKey: string, InValue: number, InIgnoreWorldModifier: booleannumber
Override_CalculateModifierValueExInModifierType: EB1ModifierType, InKey: string, InValue: number, InIgnoreWorldModifier: booleannumberStat optimization-test variant.
Override_HasModifierInModifierType: EB1ModifierType, InKey: string, InIgnoreWorldModifier: booleanbooleanReturns whether it has Modifier.
Override_RemoveAllModifiers--Removes All Modifiers.
Override_RemoveModifierModifierId: string-Removes Modifier.