CHumanPlayer Class Reference

CHumanPlayer. More...

#include <HumanPlayer.h>

Inheritance diagram for CHumanPlayer:

List of all members.

Public Member Functions
	CHumanPlayer (CBSock *pHumanGUI)
	CHumanPlayer.
Protected Member Functions
bool	OnInit ()
	OnInit.
void	OnMessageReceived (CMessage *pMsg)
	OnMessageReceived.
bool	OnSpectatorMsg (CMessage *pMsg, uint32 iSpectatorNumber)
	OnSpectatorMsg.
bool	OnBackgroundProc ()
	OnBackgroundProc.

---

Detailed Description

CHumanPlayer.

Description: The Player class provides an interface for all player objects that communicate through the primary message loop.

Limitations:

---

Constructor & Destructor Documentation

CHumanPlayer::CHumanPlayer (  CBSock *  pHumanGUI  )

CHumanPlayer. Description: Parameters: Returns: void Limitations:

---

Member Function Documentation

bool CHumanPlayer::OnBackgroundProc (   )  [protected, virtual]

OnBackgroundProc. Description: Parameters: Returns: void Limitations: Reimplemented from CLocalPlayer.

bool CHumanPlayer::OnInit (   )  [protected, virtual]

OnInit. Description: This function verifies that a human player GUI listener has been attached to the player object prior to starting the thread. If no GUI is attached, this function fails. Returns: false on failure or true on success. Limitations: None Reimplemented from CLocalPlayer.

void CHumanPlayer::OnMessageReceived (  CMessage *  pMsg  )  [protected, virtual]

OnMessageReceived. Description: Parameters: Returns: void Limitations: Reimplemented from CLocalPlayer.

bool CHumanPlayer::OnSpectatorMsg (  CMessage *  pMsg, uint32  iSpectatorNumber )  [protected, virtual]

OnSpectatorMsg. Description: This function handler is called before message sent by a spectator is actually sent. This handler should be used to filter outgoing messages. Parameters: pMsg  - The message to be filtered. iSpectatorNumber  - The index of the spectator that sent the message. Returns: None Limitations: None Reimplemented from CLocalPlayer.

---

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

• Player/HumanPlayer.h
• Player/HumanPlayer.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver