CAIPlayer Class Reference

CAIPlayer. More...

#include <AIPlayer.h>

Inheritance diagram for CAIPlayer:

List of all members.


Public Member Functions
	CAIPlayer ()
	CAIPlayer.
virtual	~CAIPlayer (void)
	~CAIPlayer
CEID	GetCEID () const
	GetCEID.
void	SetMbxNum (uint32 mbxNum)
	SetMbxNum.
uint32	GetMbxNum ()
	GetMbxNum.
Protected Member Functions
void	OnMessageReceived (CMessage *pMsg)
	OnMessageReceived Processes all messages received by this player.
void	OnQueueFull ()
	OnQueueFull.
void	OnMessage ()
	OnMessage.
void	OnGameMessage (const CGameMessage *pMsg)
	OnGameMessage.
void	OnPlayMessage (const PLAYERPIECE *pPiece)
	OnPlayMessage.
void	OnMoveMessage (const MOVE *pMove)
	OnMoveMessage.
void	OnSetPieceMessage (const PLAYERPIECE *pPiece)
	OnSetPieceMessage.
void	OnWinMessage (const PLAYERPIECE *pPiece)
	OnWinMessage.
void	OnMessageReceived (CMessage *pMsg)
void	OnPlayMessage (const CPlayMessage *pMsg)
	OnPlayMessage.
void	OnMoveMessage (const CMoveMessage *pMsg)
	OnMoveMessage.
void	OnSetPieceMessage (const CSetPieceMessage *pMsg)
	OnSetPieceMessage.
void	OnWinMessage (const CWinMessage *pMsg)
	OnWinMessage.
CEID	GetCEID ()
	GetCEID.

Detailed Description

CAIPlayer.

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

Limitations:

Constructor & Destructor Documentation

CAIPlayer::CAIPlayer ( )

CAIPlayer.
Description: : This function initalizes the class's internal data members

Parameters:

NONE

Returns:
void
Limitations: NONE

CAIPlayer::~CAIPlayer ( void ) [virtual]

~CAIPlayer
Description: Destructor

Parameters:

NONE

Returns:
void
Limitations: NONE

Member Function Documentation

CEID CAIPlayer::GetCEID ( ) [protected]

GetCEID.
Description:: Returns the CEID of this player

Parameters:

none

Returns:
CEID
Limitations: none

CEID CAIPlayer::GetCEID ( ) const

GetCEID.
Description:: Returns the CEID of this player

Parameters:

none

Returns:
CEID
Limitations: none

uint32 CAIPlayer::GetMbxNum ( ) [inline]

GetMbxNum.
Description: Gets this AI Player's mailbox number.

Returns:
The mailbox number of this game module.
Limitations: NONE

void CAIPlayer::OnGameMessage ( const CGameMessage * pMsg ) [protected]

OnGameMessage.
Description: Calls the appropriate function based upon the type of game message

Parameters:

pMsg a game message

Returns:
void
Limitations: NONE

void CAIPlayer::OnMessage ( ) [protected]

OnMessage.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

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

Returns:
void
Limitations: None
Reimplemented from CLocalPlayer.

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

OnMessageReceived Processes all messages received by this player.
Description: Call the appropriate function based upon the type of message3

Parameters:

pMsg a message

Returns:
void
Limitations: NONE
Reimplemented from CLocalPlayer.

void CAIPlayer::OnMoveMessage ( const CMoveMessage * pMsg ) [protected]

OnMoveMessage.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

void CAIPlayer::OnMoveMessage ( const MOVE * pMove ) [protected]

OnMoveMessage.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

void CAIPlayer::OnPlayMessage ( const CPlayMessage * pMsg ) [protected]

OnPlayMessage.
Description: Calls the play function if it is this players turn

Parameters:

pMsg play message

Returns:
void
Limitations: NONE

void CAIPlayer::OnPlayMessage ( const PLAYERPIECE * pPiece ) [protected]

OnPlayMessage.
Description: Calls the play function if it is this players turn

Parameters:

pMsg play message

Returns:
void
Limitations: NONE

void CAIPlayer::OnQueueFull ( ) [protected]

OnQueueFull.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

void CAIPlayer::OnSetPieceMessage ( const CSetPieceMessage * pMsg ) [protected]

OnSetPieceMessage.
Description:: Sets the piece this AI player will be using

Parameters:

CSetPieceMessage

Returns:
void
Limitations: This players piece should not already have been set

void CAIPlayer::OnSetPieceMessage ( const PLAYERPIECE * pPiece ) [protected]

OnSetPieceMessage.
Description:: Sets the piece this AI player will be using

Parameters:

CSetPieceMessage

Returns:
void
Limitations: This players piece should not already have been set

void CAIPlayer::OnWinMessage ( const CWinMessage * pMsg ) [protected]

OnWinMessage.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

void CAIPlayer::OnWinMessage ( const PLAYERPIECE * pPiece ) [protected]

OnWinMessage.
Description: : This destruction should never be called.

Parameters:

Returns:
void
Limitations:

void CAIPlayer::SetMbxNum ( uint32 mbxNum ) [inline]

SetMbxNum.
Description: Sets the AI Player's mailbox number.

Parameters:

mbxNum is the mailbox number to set.

Returns:
void
Limitations: NONE
Reimplemented from CLocalPlayer.

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

CAIPlayer Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation