FB2WeatherManager

Overview

Simulation manager for weather/season/disasters: query current weather and season, detect weather changes. (lua_manifest Manager binding key="Weather")

Metadata

Field	Value
Kind	`system`
Environment	B2 - Simulation
Category	`systems`
Extends	`FB2ManagerBase`
Require	`require('Systems.B2WeatherManager')`

Properties (20)

Name	Type	Description
`CachedAutonomyPenaltyByTemplate`	`table<string, boolean>`
`CachedAutonomyPenaltyWeather`	`string`
`CurrentSeason`	`EB1SeasonType`
`DefaultStartDayForCheat`	`integer`
`DisasterByProb`	`table<string, number>`
`DisasterCoolTime`	`table<string, integer>`
`DisasterCooldownTimeTask`	`table<string, FB1TimeTaskId>`
`DisasterOccurTimeTask`	`FB1TimeTaskId`
`DisasterSchedule`	`FB1WeatherInfo`
`OverriddenWeatherSchedule`	`FB1WeatherInfo`
`PrevSeason`	`EB1SeasonType`
`PrevSeasonTemperature`	`integer`
`PrevWeatherSchedule`	`FB1WeatherInfo`
`RecoveryDisasterTimeTask`	`FB1TimeTaskId`
`SeasonWeatherSchedule`	`FB1WeatherInfo`
`StoredWeatherSchedule`	`FB1WeatherInfo`
`WeatherForecast`	`FB1WeatherInfo[]`
`bEnableDisaster`	`boolean`
`bEnabled`	`boolean`
`bHasValidSeasonWeatherData`	`boolean`

Functions (51)

Function	Parameters	Returns	Description
`ApplyFarmingObjectScripts`	InCropEntityId: `FB1EntityId`	`-`	Applies Farming Object Scripts.
`CancelDisasterScheduleForHoliday`	`-`	`-`
`ClearOverridenWeather`	`-`	`-`	Clears Overriden Weather.
`DisasterStart`	InDisasterType: `string`	`-`
`FindTriggerIds`	InTriggerType: `EB1WeatherTriggerType`, InStage: `EB1WeatherTriggerStage`, OutTriggerIds: `string[]`	`-`	Finds and returns Trigger Ids.
`GetAllObjectEntityId`	OutAllObjectEntityIds: `FB1EntityId[]`	`-`	Returns All Object Entity Id.
`GetDayPerSeason`	`-`	`integer`	Returns Day Per Season.
`GetDisasterConfig`	InDisasterId: `string`	`FB1DisasterConfig`	Returns Disaster Config.
`GetEnabled`	`-`	`boolean`	Returns Enabled.
`GetMaterialParameterTime`	`-`	`number`	Returns Material Parameter Time.
`GetRandomWeatherConfig`	InWeathers: `FB1WeatherConfig[]`	`FB1WeatherConfig`	Returns Random Weather Config.
`GetRandomWeatherStep`	InWeatherConfig: `FB1WeatherConfig`	`integer`	Returns Random Weather Step.
`GetScheduleTime`	`-`	`integer`	Returns Schedule Time.
`GetSeason`	`-`	`EB1SeasonType`	Returns Season.
`GetSeasonAt`	InTotalDays: `integer`	`EB1SeasonType`	Returns Season At.
`GetShipwreckConfig`	InDisasterId: `string`	`FB1ShipwreckConfig`	Returns Shipwreck Config.
`GetTemperature`	`-`	`integer`	Returns Temperature.
`GetTemperatureRange`	InTemperature: `integer`	`EB1TemperatureRange`	Returns Temperature Range.
`GetWeather`	`-`	`string`	Returns Weather.
`GetWeatherCategory`	InWeather: `string`	`EB1WeatherCategory`	Returns Weather Category.
`GetWeatherExposedAutonomyRewardMultiplier`	`-`	`number`	Returns Weather Exposed Autonomy Reward Multiplier.
`GetWeatherForecast`	`-`	`FB1WeatherInfo[]`	Returns Weather Forecast.
`GetWeatherInfo`	`-`	`FB1WeatherInfo`	Returns Weather Info.
`GetWeatherRemaingTime`	`-`	`number`	Returns Weather Remaing Time.
`HandleDisasterCooldown`	InDisasterType: `string`	`-`
`HasAnyDisasterObjectState`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it has Any Disaster Object State.
`IsDisasterNow`	`-`	`boolean`	Returns whether Disaster Now.
`IsExistOverriddenWeather`	`-`	`boolean`	Returns whether Exist Overridden Weather.
`IsObjectAutonomyWeatherExposed`	InObjectEntityId: `FB1EntityId`	`boolean`	Returns whether Object Autonomy Weather Exposed.
`IsRecoveringDisaster`	`-`	`boolean`	Returns whether Recovering Disaster.
`OnDayChanged`	InBeforeTime: `FDateTime`, InAfterTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`OnDisasterRecoveryFinished`	InDisasterId: `string`	`-`	Callback invoked on Disaster Recovery Finished.
`OverrideWeather`	InWeather: `string`, InStep: `integer`	`-`
`OverrideWeatherWithTransition`	InWeather: `string`, InStep: `integer`, bTransitionImmediately: `boolean`	`-`
`Pause`	`-`	`-`
`ReapplyTemperatureBuffs`	`-`	`-`	Removes all characters' temperature buffs, then runs AddBuff_If_Bad_TPO_Winter/Summer in a spread-out manner (called on temperature change or option change).
`RefreshWeatherObjectEffectAppliedToSingle`	InEntityId: `FB1EntityId`	`-`
`RegisterDisasterSchedule`	bOnlyStartOnHour: `boolean`	`-`	Registers Disaster Schedule.
`Resume`	`-`	`-`
`SetEnableDisaster`	bInEnable: `boolean`	`-`	Sets Enable Disaster.
`SetSeasonWeather`	InWeatherInfo: `FB1WeatherInfo`, bTransitionImmediately: `boolean`, bInit: `boolean`	`-`	Sets Season Weather.
`SetWeather`	InWeatherInfo: `FB1WeatherInfo`, bTransitionImmediately: `boolean`, bInit: `boolean`	`-`	Sets Weather.
`ShouldApplyAutonomyWeatherPenalty`	InObjectTemplateId: `string`	`boolean`	Returns whether it should Apply Autonomy Weather Penalty.
`StartDisasterCooldownTimer`	InDisasterType: `string`	`-`	Starts Disaster Cooldown Timer.
`TryOccurDisasterEvent`	`-`	`-`
`TryScheduleShipwreck`	InShipId: `FB1EntityId`	`-`
`UpdateCurrentWeatherForCheat`	InSeasonWeather: `EB1WeatherType`, InSeasonWeatherStep: `integer`	`-`	Updates Current Weather For Cheat.
`UpdateDisasterOccurForCheat`	InDisaster: `string`	`-`	Updates Disaster Occur For Cheat.
`UpdateSeasonCycle`	InTotalDays: `integer`, bInit: `boolean`	`-`	Updates Season Cycle.
`UpdateSeasonCycleForCheat`	InSeasonType: `EB1SeasonType`	`-`	Updates Season Cycle For Cheat.
`UpdateTemperatureForCheat`	InTemperature: `integer`	`-`	Updates Temperature For Cheat.

Override points (22)

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

Function	Parameters	Returns	Description
`Override_ApplyFarmingObjectScripts`	InCropEntityId: `FB1EntityId`	`-`	Applies Farming Object Scripts.
`Override_CancelDisasterScheduleForHoliday`	`-`	`-`
`Override_ClearOverridenWeather`	`-`	`-`	Clears Overriden Weather.
`Override_DisasterStart`	InDisasterType: `string`	`-`
`Override_HandleDisasterCooldown`	InDisasterType: `string`	`-`
`Override_HasAnyDisasterObjectState`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it has Any Disaster Object State.
`Override_OnDayChanged`	InBeforeTime: `FDateTime`, InAfterTime: `FDateTime`	`-`	Callback invoked on Day Changed.
`Override_OnDisasterRecoveryFinished`	InDisasterId: `string`	`-`	Callback invoked on Disaster Recovery Finished.
`Override_Pause`	`-`	`-`
`Override_ReapplyTemperatureBuffs`	`-`	`-`	Removes all characters' temperature buffs, then runs AddBuff_If_Bad_TPO_Winter/Summer in a spread-out manner (called on temperature change or option change).
`Override_RefreshWeatherObjectEffectAppliedToSingle`	InEntityId: `FB1EntityId`	`-`
`Override_RegisterDisasterSchedule`	bOnlyStartOnHour: `boolean`	`-`	Registers Disaster Schedule.
`Override_Resume`	`-`	`-`
`Override_ShouldApplyAutonomyWeatherPenalty`	InObjectTemplateId: `string`	`boolean`	Returns whether it should Apply Autonomy Weather Penalty.
`Override_StartDisasterCooldownTimer`	InDisasterType: `string`	`-`	Starts Disaster Cooldown Timer.
`Override_TryOccurDisasterEvent`	`-`	`-`
`Override_TryScheduleShipwreck`	InShipId: `FB1EntityId`	`-`
`Override_UpdateCurrentWeatherForCheat`	InSeasonWeather: `EB1WeatherType`, InSeasonWeatherStep: `integer`	`-`	Updates Current Weather For Cheat.
`Override_UpdateDisasterOccurForCheat`	InDisaster: `string`	`-`	Updates Disaster Occur For Cheat.
`Override_UpdateSeasonCycle`	InTotalDays: `integer`, bInit: `boolean`	`-`	Updates Season Cycle.
`Override_UpdateSeasonCycleForCheat`	InSeasonType: `EB1SeasonType`	`-`	Updates Season Cycle For Cheat.
`Override_UpdateTemperatureForCheat`	InTemperature: `integer`	`-`	Updates Temperature For Cheat.