S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

PlayerPlacementStatus

Describes the outcome of a local-player placement request.

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

Describes the outcome of a local-player placement request.

Members

Success

field
Success

The local player was moved successfully.

InvalidCoordinates

field
InvalidCoordinates

A coordinate was NaN, infinite, or outside CMAPI's bounds.

WorldNotReady

field
WorldNotReady

The required world, planet, or local player is not ready.

HostRequired

field
HostRequired

Only the current world host may move the local player.

NoReturnPoint

field
NoReturnPoint

This mod has no recorded return point.

PlayerChanged

field
PlayerChanged

The recorded point belongs to a previous local-player session.

PlanetChanged

field
PlanetChanged

The recorded point belongs to another planet.

OwnerInactive

field
OwnerInactive

The mod which submitted the request is no longer active.

GameRejected

field
GameRejected

Planet Crafter rejected the otherwise valid placement.

TimedOut

field
TimedOut

CMAPI could not reach the game main thread within its safety timeout.

Failed

field
Failed

An unexpected game or compatibility error prevented placement.