S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IPlanetDefinition

Describes one installed Planet Crafter planet.

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

Describes one installed Planet Crafter planet.

Members

Id

property
string Id

Gets the planet's stable game ID.

SceneName

property
string SceneName

Gets the Unity scene name used by the game.

IsStartingPlanet

property
bool IsStartingPlanet

Gets whether this is the game's default starting planet.

IsCurrent

property
bool IsCurrent

Gets whether this planet is currently loaded.

RequiresPurification

property
bool RequiresPurification

Gets whether this planet uses purification progression.

WeatherEventCount

property
int WeatherEventCount

Gets the number of distinct natural weather events.