S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IPlanetManager

Provides safe, read-only information about installed planets.

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

Provides safe, read-only information about installed planets.

Members

IsWorldLoadedGets whether a planet has finished loading.propertyCurrentPlanetGets the current planet definition, or null.propertyAvailablePlanetsGets an immutable snapshot of planets available in the installed game and purchased DLC set.propertyTryGetPlanetFinds an available planet by exact stable ID.method

IsWorldLoaded

property
bool IsWorldLoaded

Gets whether a planet has finished loading.

CurrentPlanet

property
IPlanetDefinition? CurrentPlanet

Gets the current planet definition, or null.

AvailablePlanets

property
IReadOnlyList<IPlanetDefinition> AvailablePlanets

Gets an immutable snapshot of planets available in the installed game and purchased DLC set.

TryGetPlanet

method
bool TryGetPlanet(string id, out IPlanetDefinition? planet)

Finds an available planet by exact stable ID.