Skip to main content

FB2DustyComponent

Overview

  • Component that manages dust/dirt state.

Metadata

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

Properties (4)

NameTypeDescription
CurrentDustynumber
NextDustyUpdateTimeinteger
OnChangeDustValueEventany
bIsDisabledboolean

Functions (6)

FunctionParametersReturnsDescription
AddDustyValueInValue: number-Adds Dusty Value.
GetDefaultCityMoveDataPolicy-EB1CityMoveDataPolicyReturns Default City Move Data Policy.
GetDustyValue-numberReturns Dusty Value.
IsDisabled-booleanReturns whether Disabled.
SetDustyValueInValue: number, bForce: boolean-Sets Dusty Value.
ShouldUseScheduler-booleanReturns whether it should Use Scheduler.

Override points (1)

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

FunctionParametersReturnsDescription
Override_AddDustyValueInValue: number-Adds Dusty Value.