Classes | Enumerator | Functions | Variables

Players and Player Management
[AESOP Server Library]

Collaboration diagram for Players and Player Management:


struct  aesop::player_rec_t
 single struct that contains all (exposed) player state More...
class  aesop::PlayerManager
 Object that helps the server manage players. More...


void aesop::player_rec_t::clear (void) throw ()
bool aesop::player_rec_t::isAuthenticated (void) const throw ()
bool aesop::player_rec_t::isInMap (void) const throw ()
bool aesop::player_rec_t::isTargetingMap (void) const throw ()
void aesop::player_rec_t::targetMap (const char *inMap, const char *inStart)
ePlayerMode aesop::player_rec_t::getMode (void) const throw ()
virtual aesop::PlayerManager::~PlayerManager (void) throw ()
virtual void aesop::PlayerManager::updatePlayer (player_rec_t &pr)=0
virtual bool aesop::PlayerManager::getPlayerByHostAndPlayerId (conn_id_t udpConnId, int playerId, player_rec_t &pr)=0
virtual void aesop::PlayerManager::getIterator (conn_id_t udpConnId, iterator_t &iterator)=0
 requests a new iterator. if hostId is null, iterates over all hosts
virtual bool aesop::PlayerManager::getNextPlayer (iterator_t &iterator, player_rec_t &pr)=0
 returns the player for this iteration, and increments iterator
static smart_ptr< PlayerManager > aesop::PlayerManager::create (smart_ptr< UserManager > &userMgr)


conn_id_t aesop::player_rec_t::udpConnId
 ID of remote host.
int aesop::player_rec_t::playerId
 this ID is relative to client
int aesop::player_rec_t::flags
 ePrivilege flags OR'd together
AESOPTagBuffer aesop::player_rec_t::username
AESOPTagBuffer aesop::player_rec_t::playerTag
AESOPIdBuffer aesop::player_rec_t::mapId
AESOPIdBuffer aesop::player_rec_t::startId
smart_ptr< PhysicsObject > aesop::player_rec_t::obj
 physics object in map

enum  aesop::ePrivilege {
  aesop::ePrivilege_Admin = 0x0001,
  aesop::ePrivilege_Invalid = 0x8000

Enumeration Type Documentation


player has admin rights


Definition at line 55 of file srv-players.h.

Function Documentation

void aesop::player_rec_t::clear ( void   )  throw () [inline, inherited]

Definition at line 67 of file srv-players.h.

bool aesop::player_rec_t::isAuthenticated ( void   )  const throw () [inline, inherited]

Definition at line 77 of file srv-players.h.

bool aesop::player_rec_t::isInMap ( void   )  const throw () [inline, inherited]

Definition at line 79 of file srv-players.h.

bool aesop::player_rec_t::isTargetingMap ( void   )  const throw () [inline, inherited]

Definition at line 81 of file srv-players.h.

void aesop::player_rec_t::targetMap ( const char *  inMap,
const char *  inStart 
) [inline, inherited]

Definition at line 83 of file srv-players.h.

ePlayerMode aesop::player_rec_t::getMode ( void   )  const throw () [inline, inherited]

Definition at line 90 of file srv-players.h.

aesop::PlayerManager::~PlayerManager ( void   )  throw () [virtual, inherited]

Definition at line 44 of file srv-players.cpp.

virtual void aesop::PlayerManager::updatePlayer ( player_rec_t pr  )  [pure virtual, inherited]
virtual bool aesop::PlayerManager::getPlayerByHostAndPlayerId ( conn_id_t  udpConnId,
int  playerId,
player_rec_t pr 
) [pure virtual, inherited]
virtual void aesop::PlayerManager::getIterator ( conn_id_t  udpConnId,
iterator_t iterator 
) [pure virtual, inherited]

requests a new iterator. if hostId is null, iterates over all hosts

virtual bool aesop::PlayerManager::getNextPlayer ( iterator_t iterator,
player_rec_t pr 
) [pure virtual, inherited]

returns the player for this iteration, and increments iterator

smart_ptr< PlayerManager > aesop::PlayerManager::create ( smart_ptr< UserManager > &  userMgr  )  [static, inherited]

Definition at line 377 of file srv-players.cpp.

Variable Documentation

conn_id_t aesop::player_rec_t::udpConnId [inherited]

ID of remote host.

Definition at line 99 of file srv-players.h.

this ID is relative to client

Definition at line 100 of file srv-players.h.

int aesop::player_rec_t::flags [inherited]

ePrivilege flags OR'd together

Definition at line 101 of file srv-players.h.

AESOPTagBuffer aesop::player_rec_t::username [inherited]

Definition at line 102 of file srv-players.h.

AESOPTagBuffer aesop::player_rec_t::playerTag [inherited]

Definition at line 103 of file srv-players.h.

AESOPIdBuffer aesop::player_rec_t::mapId [inherited]

Definition at line 104 of file srv-players.h.

AESOPIdBuffer aesop::player_rec_t::startId [inherited]

Definition at line 105 of file srv-players.h.

smart_ptr<PhysicsObject> aesop::player_rec_t::obj [inherited]

physics object in map

Definition at line 106 of file srv-players.h.