S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

EnvironmentSnapshot

Contains current-planet day/night and local water information.

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

Contains current-planet day/night and local water information.

Members

IsAvailable

property
public bool IsAvailable

Gets whether a loaded planet and environment are available.

PlanetId

property
public string? PlanetId

Gets the current planet ID, or null.

DayNightValue

property
public float DayNightValue

Gets Planet Crafter's synchronized day/night blend from zero for day through 100 for night.

DayNightPhase

property
public DayNightPhase DayNightPhase

Gets a coarse interpretation of DayNightValue.

HasLocalPlayer

property
public bool HasLocalPlayer

Gets whether a local player was available for water detection.

IsLocalPlayerUnderwater

property
public bool IsLocalPlayerUnderwater

Gets whether the local player's current position is underwater.