NetworkClientInfo Struct Reference

Container for all information known about a client. More...

#include <network_base.h>

Inheritance diagram for NetworkClientInfo:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_networkclientinfo_pool >

Public Member Functions

 NetworkClientInfo (ClientID client_id=INVALID_CLIENT_ID)
 Create a new client.
 ~NetworkClientInfo ()
 Basically a client is leaving us right now.

Static Public Member Functions

static NetworkClientInfoGetByClientID (ClientID client_id)
 Return the CI given it's client-identifier.

Data Fields

ClientID client_id
 Client identifier (same as ClientState->client_id).
char client_name [NETWORK_CLIENT_NAME_LENGTH]
 Name of the client.
byte client_lang
 The language of the client.
CompanyID client_playas
 As which company is this client playing (CompanyID).
Date join_date
 Gamedate the client has joined.

Detailed Description

Container for all information known about a client.

Definition at line 27 of file network_base.h.


Constructor & Destructor Documentation

NetworkClientInfo::NetworkClientInfo ( ClientID  client_id = INVALID_CLIENT_ID  )  [inline]

Create a new client.

Parameters:
client_id The unique identifier of the client.

Definition at line 38 of file network_base.h.


Member Function Documentation

NetworkClientInfo * NetworkClientInfo::GetByClientID ( ClientID  client_id  )  [static]

The documentation for this struct was generated from the following files:

Generated on Sun May 8 07:31:16 2011 for OpenTTD by  doxygen 1.6.1