S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

WeatherSnapshot

Contains a point-in-time view of the current planet's weather.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public sealed class WeatherSnapshot

Contains a point-in-time view of the current planet's weather.

Members

IsAvailable

property
public bool IsAvailable

Gets whether the game's weather system is ready.

PlanetId

property
public string? PlanetId

Gets the current planet ID, or null.

IsActive

property
public bool IsActive

Gets whether a synchronized weather event is active.

ActiveEventId

property
public string? ActiveEventId

Gets the active event's stable asset ID, or null.

ActiveDisplayName

property
public string? ActiveDisplayName

Gets the active event's readable name, or null.

HasAsteroids

property
public bool HasAsteroids

Gets whether the active event includes asteroids or meteors.

ElapsedSeconds

property
public float ElapsedSeconds

Gets elapsed event time in seconds.

RemainingSeconds

property
public float RemainingSeconds

Gets estimated remaining event time in seconds.

Progress

property
public float Progress

Gets normalized event progress from zero through one.

UnavailableReason

property
public string UnavailableReason

Gets a short explanation when weather is unavailable, or an empty string when it is available.