Phx::LocalPlayer Class Reference

A more specific Player representing a player that is controlling objects via the local machine. More...

#include <PhxPlayer.h>

Inheritance diagram for Phx::LocalPlayer:

List of all members.

Public Member Functions
Ptr< Client >	newClient (const String &clientName)=0
	Retrieves a new client interface.
Static Public Attributes
static const NamedInterface::Type	INTERFACE_TYPE
static const String	INTERFACE_TYPE_NAME
Classes
class	Client
	An interface providing individual access to a LocalPlayer. More...

---

Detailed Description

A more specific Player representing a player that is controlling objects via the local machine.

Note that while there will typically be only a single local Player in use, this is not fundamentally necessary. Also note that while the axis/button names in the single-player case may correspond directly to the names used in the logical input engine, in general, the Player implementation may choose to remap names to accomodate multiple players, etc. e.g., two sticks/yokes may be remapped from /Aircraft/StickX to /Aircraft/StickX and /Player2/Aircraft/StickX (hence allowing multiple players on a single CPU -- one using the standard binding, and a second using an alternate binding).

---

Member Function Documentation

Ptr<Client> Phx::LocalPlayer::newClient (  const String &  clientName  )  [pure virtual]

Retrieves a new client interface. Parameters: clientName  A name attached to the interface, typically identifying the role that the client is being used for (e.g., "C130 Copilot" or "Falcon22 F16 Pilot"), but it does not have to be unique. Note: This method is safely accessible by multiple concurrent clients.

---

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

• PhxPlayer.h

---