S9SourceNine Labs / CMAPI Docs 1.0
CMAPI / API reference

IPlayerEvents

Provides normalized player lifecycle events.

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

Provides normalized player lifecycle events.

Members

LocalPlayerStartedRaised after the local player is fully available in a world.eventLocalPlayerStoppedRaised when the local player leaves the active world or session.eventPlayerStartedRaised after any local or remote player becomes available.eventPlayerStoppedRaised after any local or remote player leaves the session.event

LocalPlayerStarted

event
event Action<IPlayer> LocalPlayerStarted

Raised after the local player is fully available in a world.

LocalPlayerStopped

event
event Action<IPlayer> LocalPlayerStopped

Raised when the local player leaves the active world or session.

The supplied player has IsConnected set to false and retains its last valid state snapshot.

PlayerStarted

event
event Action<IPlayer> PlayerStarted

Raised after any local or remote player becomes available.

For the local player, this general event is raised before LocalPlayerStarted.

PlayerStopped

event
event Action<IPlayer> PlayerStopped

Raised after any local or remote player leaves the session.