Home Previous Up Next Index

Player

Overview

struct Player

A connected player.

Used By

PlayerList
PlayerMap
Server::getState
Server::setState
ServerCallback::playerConnected
ServerCallback::playerDisconnected
ServerCallback::playerStateChanged
ServerContextCallback::contextAction

Data Member Index

session
Session ID.
playerid
Player ID.
mute
Is player muted by the server?
deaf
Is player deafened by the server? If true, this implies mute.
suppressed
Is the player suppressed by the server? This means the user is not muted, but does not have speech privileges in the current channel.
selfMute
Is the player self-muted?
selfDeaf
Is the player self-deafened? If true, this implies mute.
channel
Channel ID the player is in.
name
The name of the player.
onlinesecs
Seconds player has been online.
bytespersec
Average transmission rate in bytes per second over the last few seconds.

Data Members

int session;

Session ID. This identifies the connection to the server.

int playerid;

Player ID. Matches RegisteredPlayer::playerid or -1 if the player is anonymous.

bool mute;

Is player muted by the server?

bool deaf;

Is player deafened by the server? If true, this implies mute.

bool suppressed;

Is the player suppressed by the server? This means the user is not muted, but does not have speech privileges in the current channel.

bool selfMute;

Is the player self-muted?

bool selfDeaf;

Is the player self-deafened? If true, this implies mute.

int channel;

Channel ID the player is in. Matches Channel::id.

string name;

The name of the player.

int onlinesecs;

Seconds player has been online.

int bytespersec;

Average transmission rate in bytes per second over the last few seconds.


Home Previous Up Next Index