S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

EnvironmentActionStatus

Describes the outcome of a requested environment mutation.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIEnumAssembly CMAPI.API.dll
public enum EnvironmentActionStatus

Describes the outcome of a requested environment mutation.

Members

Success

field
Success

The requested action completed successfully.

InvalidArgument

field
InvalidArgument

The supplied event ID or position was empty or invalid.

UnsupportedGameBuild

field
UnsupportedGameBuild

The current Planet Crafter build is missing one or more game hooks required by this CMAPI environment action.

WorldNotReady

field
WorldNotReady

The required world, player, or environment manager is not ready.

HostRequired

field
HostRequired

The action can only be performed by the current world host.

NotFound

field
NotFound

No current-planet definition matched the supplied stable ID.

AlreadyActive

field
AlreadyActive

An environment event is already active and was left untouched.

RequirementsNotMet

field
RequirementsNotMet

The current world state does not meet the event's requirements.

GameRejected

field
GameRejected

The game rejected the otherwise valid request.

OwnerInactive

field
OwnerInactive

The mod which submitted the request is no longer active.

Failed

field
Failed

An unexpected game or compatibility error prevented the request.