S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

GameplayActionResult

Contains the complete result of a gameplay mutation request.

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

Contains the complete result of a gameplay mutation request.

Members

SucceededGets whether the complete request succeeded.propertyStatusGets the stable machine-readable outcome.propertyMessageGets a player- and developer-readable explanation.propertyRequestedAmountGets the amount originally requested.propertyAppliedAmountGets the amount applied before completion. This may be nonzero when the game accepted only part of an item request. For Terra Tokens, this is the amount accepted for server-RPC submission.property

Succeeded

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

Gets whether the complete request succeeded.

Status

property
public GameplayActionStatus Status

Gets the stable machine-readable outcome.

Message

property
public string Message

Gets a player- and developer-readable explanation.

RequestedAmount

property
public int RequestedAmount

Gets the amount originally requested.

AppliedAmount

property
public int AppliedAmount

Gets the amount applied before completion. This may be nonzero when the game accepted only part of an item request. For Terra Tokens, this is the amount accepted for server-RPC submission.