Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Phx::Player Class Reference

An entity representing a player in control of an object. More...

#include <PhxPlayer.h>

Inheritance diagram for Phx::Player:

Phx::NamedInterface Phx::LockedPtrInterface< NamedInterface > Phx::LocalPlayer Phx::RemotePlayer Phx::SimulatedPlayer List of all members.

Public Member Functions

virtual String callsign ()=0
 Returns the callsign attached to this player.

Classes

class  Manager
 The Player::Manager class is responsible keeping track of players as they enter and leave the system. More...

Detailed Description

An entity representing a player in control of an object.

Controlled entities should provide an attribute taking a NamedInterface::Identifier referring to a Player. Note that they may have more than one such attribute, allowing a player to assume different roles (or multiple roles). e.g., there will typically be something like Aircraft::pilot(NamedInterface::Identifier), but there may also be Aircraft::copilot(NamedInterface::Identifier). In some aircraft, a single pilot may be capable of performing both roles, while in most these will be separate players.

Note:
This interface cannot be instantiated. You can check the type() attribute to determine whether it is a LocalPlayer or RemotePlayer.


Member Function Documentation

virtual String Phx::Player::callsign  )  [pure virtual]
 

Returns the callsign attached to this player.

Note:
This method is safely accessible by multiple concurrent clients.


The documentation for this class was generated from the following file:
Generated on Mon Jul 10 19:45:30 2006 for Phoenix OSFS by  doxygen 1.4.2