Interface IPlayers

Namespace: ReadyM.Relay.Server.Sdk.Players
Assembly: ReadyM.Relay.Server.Sdk.dll

What the server can do with a connected player, beyond their entities.

public interface IPlayers

Methods

GetReadyMId(PlayerId)

Get the id ReadyM assigned to this player's account, or null if this server has not seen them since it started. Global to the platform: the same player carries the same id every time, it survives reconnects and server restarts. PlayerId does none of that, so key anything you persist on this instead.

Guid? GetReadyMId(PlayerId player)

Parameters

player PlayerId

Returns

Guid?

Kick(PlayerId)

Kicks the player from the server. This is a hard disconnect, and the player will not be able to reconnect until they restart the game.

void Kick(PlayerId player)

Parameters

player PlayerId

The player to kick.