S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IEnvironmentManager

Provides safe current-planet environment information and actions.

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

Provides safe current-planet environment information and actions.

Members

GetSnapshotCreates a fresh day/night and local-water snapshot.methodIsUnderwaterChecks whether a same-planet position lies inside an active water volume. Returns false when water is unavailable or has not begun rising. Coordinates must be finite.methodResetToDayAsyncResets the synchronized day/night cycle to full daylight.method

GetSnapshot

method
EnvironmentSnapshot GetSnapshot()

Creates a fresh day/night and local-water snapshot.

IsUnderwater

method
bool IsUnderwater(WorldPosition position)

Checks whether a same-planet position lies inside an active water volume. Returns false when water is unavailable or has not begun rising. Coordinates must be finite.

ResetToDayAsync

method
Task<EnvironmentActionResult> ResetToDayAsync()

Resets the synchronized day/night cycle to full daylight.

This is always host-only and runs on the game thread. It changes only the live day/night cycle; it does not edit terraformation progress.