S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IWeatherEventDefinition

Describes one weather or meteor event available on a planet.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIInterfaceAssembly CMAPI.API.dll
public interface IWeatherEventDefinition

Describes one weather or meteor event available on a planet.

Members

IdGets the stable game asset ID accepted by CMAPI.propertyDisplayNameGets a human-readable name derived from the game asset ID.propertyDurationSecondsGets the event's configured total duration in seconds.propertyHasAsteroidsGets whether the event includes an asteroid or meteor payload.propertyRainEmissionGets the configured rain-particle emission count.propertyWetnessGets the configured terrain wetness from zero through one.propertyMinimumTerraformStageIdGets the terraformation stage after which this event may naturally occur, or null when it has no lower bound.propertyMaximumTerraformStageIdGets the terraformation stage at which this event stops naturally occurring, or null when it has no upper bound.property

Id

property
string Id

Gets the stable game asset ID accepted by CMAPI.

DisplayName

property
string DisplayName

Gets a human-readable name derived from the game asset ID.

DurationSeconds

property
float DurationSeconds

Gets the event's configured total duration in seconds.

HasAsteroids

property
bool HasAsteroids

Gets whether the event includes an asteroid or meteor payload.

RainEmission

property
int RainEmission

Gets the configured rain-particle emission count.

Wetness

property
float Wetness

Gets the configured terrain wetness from zero through one.

MinimumTerraformStageId

property
string? MinimumTerraformStageId

Gets the terraformation stage after which this event may naturally occur, or null when it has no lower bound.

MaximumTerraformStageId

property
string? MaximumTerraformStageId

Gets the terraformation stage at which this event stops naturally occurring, or null when it has no upper bound.