eris  1.4.0
A WorldForge client library.
Eris::Person Class Reference

#include <Person.h>

Collaboration diagram for Eris::Person:

Public Member Functions

 Person (Lobby &l, const Atlas::Objects::Entity::Account &acc)
 create a person from sight More...
 
void sight (const Atlas::Objects::Entity::Account &acc)
 update a person based on sight More...
 
void msg (const std::string &msg)
 
const std::string & getAccount () const
 access the Atlas account ID for this person More...
 
const std::string & getName () const
 access the human-readable name for this person More...
 

Protected Attributes

const std::string m_id
 the account ID More...
 
std::string m_fullName
 the name, i.e account.GetName() More...
 
Lobbym_lobby
 the lobby owning this Person More...
 

Detailed Description

An Out-of-Game Person (found in a Room / Lobby) As more person data becomes available, this class will be extended, for example to return nicknames, location, the choosen 'face' graphic.

Definition at line 15 of file Person.h.

Constructor & Destructor Documentation

Eris::Person::Person ( Lobby l,
const Atlas::Objects::Entity::Account &  acc 
)

create a person from sight

Definition at line 24 of file Person.cpp.

Member Function Documentation

const std::string& Eris::Person::getAccount ( ) const
inline

access the Atlas account ID for this person

Definition at line 28 of file Person.h.

References m_id.

Referenced by Eris::Room::getPeople().

const std::string& Eris::Person::getName ( ) const
inline

access the human-readable name for this person

Definition at line 31 of file Person.h.

References m_fullName.

void Eris::Person::msg ( const std::string &  msg)
void Eris::Person::sight ( const Atlas::Objects::Entity::Account &  acc)

update a person based on sight

Definition at line 32 of file Person.cpp.

References m_fullName, and m_id.

Member Data Documentation

std::string Eris::Person::m_fullName
protected

the name, i.e account.GetName()

Definition at line 35 of file Person.h.

Referenced by getName(), and sight().

const std::string Eris::Person::m_id
protected

the account ID

Definition at line 34 of file Person.h.

Referenced by getAccount(), msg(), and sight().

Lobby& Eris::Person::m_lobby
protected

the lobby owning this Person

Definition at line 37 of file Person.h.

Referenced by msg().


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