S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

EnvironmentActionResult

Contains the complete result of an environment mutation request.

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

Contains the complete result of an environment mutation request.

Members

SucceededGets whether the complete request succeeded.propertyStatusGets the stable machine-readable outcome.propertyMessageGets a player- and developer-readable explanation.property

Succeeded

property
public bool Succeeded => Status == EnvironmentActionStatus.Success

Gets whether the complete request succeeded.

Status

property
public EnvironmentActionStatus Status

Gets the stable machine-readable outcome.

Message

property
public string Message

Gets a player- and developer-readable explanation.