S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IPlayer

Represents one player visible to the current Planet Crafter session.

View source ↗
CMAPI 1.0.0Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIInterfaceAssembly CMAPI.API.dll
public interface IPlayer

Represents one player visible to the current Planet Crafter session.

Members

ClientId

property
ulong ClientId

Gets the player's session-scoped multiplayer client ID.

This value identifies a connection during the current session. It is not promised to be a permanent Steam, account, or save-file identity.

Name

property
string Name

Gets the player's current display name.

IsLocal

property
bool IsLocal

Gets whether this is the player controlled by this game instance.

IsHost

property
bool IsHost

Gets whether this player owns the hosted session.

IsConnected

property
bool IsConnected

Gets whether the player is still present in the active session.

Position

property
WorldPosition Position

Gets the player's current or last known world position.

Vitals

property
PlayerVitals Vitals

Gets the player's current or last known survival gauges.