S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

PlayerPlacementResult

Contains the complete result of a player-placement request.

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

Contains the complete result of a player-placement request.

Members

SucceededGets whether placement completed successfully.propertyStatusGets the stable machine-readable outcome.propertyMessageGets a player- and developer-readable explanation.propertyOriginGets the position occupied before the request, when it was available.propertyDestinationGets the requested/applied destination, when it was available.property

Succeeded

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

Gets whether placement completed successfully.

Status

property
public PlayerPlacementStatus Status

Gets the stable machine-readable outcome.

Message

property
public string Message

Gets a player- and developer-readable explanation.

Origin

property
public WorldPosition? Origin

Gets the position occupied before the request, when it was available.

Destination

property
public WorldPosition? Destination

Gets the requested/applied destination, when it was available.