Class WeatherManager

Namespace

S1API.Weather

Assembly

S1API.dll

Provides read-only access to the game's current weather and known weather sequences.

public static class WeatherManager

Inheritance

object

WeatherManager

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Weather state is populated after the current Main-scene weather manager and its active conditions are available. It is null outside gameplay or while those native services are still initializing. This API does not select weather sequences or trigger weather effects.

Properties

Current

Gets the most recently observed weather state, or null while the current scene does not have an initialized weather manager.

public static WeatherState? Current { get; }

Property Value

WeatherState?

KnownSequenceIds

Gets a fresh, read-only snapshot of the identifiers configured on the current native weather manager. Identifier order, casing, and duplicates are preserved.

public static IReadOnlyList<string> KnownSequenceIds { get; }

Property Value

IReadOnlyList<string>

Remarks

An empty list is returned when the weather manager is not available or its sequence collection cannot be read. The returned list contains strings only and is independent of the native collection.

Events

OnWeatherChanged

Raised when weather first becomes available or changes to a distinct snapshot.

public static event Action<WeatherState>? OnWeatherChanged

Event Type

Action<WeatherState>