Skip to main content

FB2ObjectWeatheringComponent

Overview

Component that manages object weathering (aging/dirt).

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2ObjectWeatheringComponent')`

Properties (7)

Name	Type	Description
`BaseDay`	`integer`
`CurrentGrade`	`integer`
`CurrentWeatheringIntensity`	`number`
`RemainNextGradeDay`	`integer`
`WeatheringGroupName`	`string`
`bIsEnableWeathering`	`boolean`
`bIsWeatheringEnabled`	`boolean`

Functions (16)

Function	Parameters	Returns	Description
`GetBaseDay`	`-`	`integer`	Returns Base Day.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetGrade`	`-`	`integer`	Returns Grade.
`GetWeatheringGroupName`	`-`	`string`	Returns Weathering Group Name.
`GetWeatheringIntensity`	`-`	`number`	Returns Weathering Intensity.
`GetWeatheringModifier`	InModifierKey: `string`, OutModifierData: `FB1ModifierSettingData`	`boolean`	Returns Weathering Modifier.
`GetWeatheringNextGradeDay`	`-`	`integer`	Returns Weathering Next Grade Day.
`OnDayOfWeekChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Of Week Changed.
`RefreshWeathering`	`-`	`-`
`ResetStartTime`	`-`	`-`	Resets Start Time.
`SetCanWeathering`	bEnable: `boolean`	`-`	Sets Can Weathering.
`SetWeatheringEnabledWithSiteId`	InParentSiteId: `string`	`-`	Sets Weathering Enabled With Site Id.
`SetWeatheringGrade`	InGrade: `integer`, InRefreshing: `boolean`	`-`	Sets Weathering Grade.
`TryNextGrade`	`-`	`-`
`UpdateWeatheringValue`	`-`	`-`	Updates Weathering Value.

Override points (5)

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

Function	Parameters	Returns	Description
`Override_OnDayOfWeekChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Of Week Changed.
`Override_RefreshWeathering`	`-`	`-`
`Override_ResetStartTime`	`-`	`-`	Resets Start Time.
`Override_TryNextGrade`	`-`	`-`
`Override_UpdateWeatheringValue`	`-`	`-`	Updates Weathering Value.