S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

GameplayActionStatus

Describes the outcome of a CMAPI gameplay mutation request.

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

Describes the outcome of a CMAPI gameplay mutation request.

Members

Success

field
Success

The item callbacks completed successfully or the Terra Token RPC was validated and submitted successfully.

InvalidArgument

field
InvalidArgument

The request used an unsupported amount or empty value.

WorldNotReady

field
WorldNotReady

The required world, player, HUD, or game system is not ready.

HostRequired

field
HostRequired

The request was rejected because only the world host may mutate it.

ItemNotFound

field
ItemNotFound

No item exists with the supplied stable item ID.

InventoryFull

field
InventoryFull

The local backpack cannot fit the complete requested amount.

Overflow

field
Overflow

The request would exceed the game's numeric limit.

GameRejected

field
GameRejected

The game rejected all or part of the submitted request.

TimedOut

field
TimedOut

The game did not complete its callbacks within CMAPI's safety timeout.

Failed

field
Failed

An unexpected game or compatibility error prevented the request.