S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

WorldStateSnapshot

Contains current terraformation measurements for one planet.

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

Contains current terraformation measurements for one planet.

Members

IsAvailableGets whether the world-unit system is initialized.propertyPlanetIdGets the current planet ID, or null.propertyUnitsGets all available unit snapshots.propertyCurrentStageGets the current global terraformation stage, if known.propertyNextStageGets the next global terraformation stage, if one remains.propertyNextStageCompletionPercentGets completion toward the next stage from zero through 100.property

IsAvailable

property
public bool IsAvailable

Gets whether the world-unit system is initialized.

PlanetId

property
public string? PlanetId

Gets the current planet ID, or null.

Units

property
public IReadOnlyList<WorldUnitSnapshot> Units

Gets all available unit snapshots.

CurrentStage

property
public TerraformStageSnapshot? CurrentStage

Gets the current global terraformation stage, if known.

NextStage

property
public TerraformStageSnapshot? NextStage

Gets the next global terraformation stage, if one remains.

NextStageCompletionPercent

property
public double NextStageCompletionPercent

Gets completion toward the next stage from zero through 100.