psMiniGameBoard Class Reference

Wrapper class for game board. More...

#include <psminigameboard.h>

List of all members.

Public Member Functions
bool	DetermineEndgame (Endgame_TileType &winningPiece)
	determine if the current layout matches an endgame pattern. Returns true or false appropriately.
uint8_t	Get (uint8_t col, uint8_t row) const
	Gets the tile state from the specified column and row.
uint8_t	GetCols () const
	Returns the number of columns.
uint8_t *	GetLayout () const
	Returns the packed game board layout.
Rule_MoveablePieces	GetMoveablePiecesRule (void)
Rule_MoveDirection	GetMoveDirectionRule (void)
int	GetMoveDistanceRule (void)
Rule_MovePiecesTo	GetMovePiecesToRule (void)
Rule_MovePieceType	GetMovePieceTypeRule (void)
uint8_t	GetNumPieces () const
	Returns the number of available pieces.
uint8_t	GetNumPlayers (void)
	returns number of players
uint8_t *	GetPieces () const
	Returns the package list of available pieces.
uint8_t	GetPiecesSize () const
	Returns the number of available pieces.
Rule_PlayerTurn	GetPlayerTurnRule (void)
	return Game rules
uint8_t	GetRows () const
	Returns the number of rows.
	psMiniGameBoard ()
void	Set (uint8_t col, uint8_t row, uint8_t state)
	Sets the tile state at the specified column and row.
void	Setup (psMiniGameBoardDef *newGameDef, uint8_t *preparedLayout)
	Sets up the game board layout.
	~psMiniGameBoard ()

---

Detailed Description

Wrapper class for game board.

Wrapper class for a mini-game in play, and exists singly with a unique mini-game session.

Definition at line 218 of file psminigameboard.h.

---

Constructor & Destructor Documentation

psMiniGameBoard::psMiniGameBoard

(

)

psMiniGameBoard::~psMiniGameBoard

(

)

---

Member Function Documentation

bool psMiniGameBoard::DetermineEndgame

(

Endgame_TileType &

winningPiece

)

determine if the current layout matches an endgame pattern. Returns true or false appropriately.

uint8_t psMiniGameBoard::Get	(	uint8_t	col,
		uint8_t	row
	)		const

Gets the tile state from the specified column and row.

uint8_t psMiniGameBoard::GetCols

(

)

const [inline]

Returns the number of columns.

Definition at line 230 of file psminigameboard.h.

uint8_t* psMiniGameBoard::GetLayout

(

)

const [inline]

Returns the packed game board layout.

Definition at line 242 of file psminigameboard.h.

Rule_MoveablePieces psMiniGameBoard::GetMoveablePiecesRule

(

void

)

[inline]

Definition at line 286 of file psminigameboard.h.

Rule_MoveDirection psMiniGameBoard::GetMoveDirectionRule

(

void

)

[inline]

Definition at line 294 of file psminigameboard.h.

int psMiniGameBoard::GetMoveDistanceRule

(

void

)

[inline]

Definition at line 298 of file psminigameboard.h.

Rule_MovePiecesTo psMiniGameBoard::GetMovePiecesToRule

(

void

)

[inline]

Definition at line 290 of file psminigameboard.h.

Rule_MovePieceType psMiniGameBoard::GetMovePieceTypeRule

(

void

)

[inline]

Definition at line 282 of file psminigameboard.h.

uint8_t psMiniGameBoard::GetNumPieces

(

)

const [inline]

Returns the number of available pieces.

Definition at line 248 of file psminigameboard.h.

uint8_t psMiniGameBoard::GetNumPlayers

(

void

)

[inline]

returns number of players

Definition at line 272 of file psminigameboard.h.

uint8_t* psMiniGameBoard::GetPieces

(

)

const [inline]

Returns the package list of available pieces.

Definition at line 260 of file psminigameboard.h.

uint8_t psMiniGameBoard::GetPiecesSize

(

)

const [inline]

Returns the number of available pieces.

Definition at line 254 of file psminigameboard.h.

Rule_PlayerTurn psMiniGameBoard::GetPlayerTurnRule

(

void

)

[inline]

return Game rules

Definition at line 278 of file psminigameboard.h.

uint8_t psMiniGameBoard::GetRows

(

)

const [inline]

Returns the number of rows.

Definition at line 236 of file psminigameboard.h.

void psMiniGameBoard::Set	(	uint8_t	col,
		uint8_t	row,
		uint8_t	state
	)

Sets the tile state at the specified column and row.

void psMiniGameBoard::Setup	(	psMiniGameBoardDef *	newGameDef,
		uint8_t *	preparedLayout
	)

Sets up the game board layout.

---

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

• server/bulkobjects/psminigameboard.h