Game board definition class. More...

Public Member Functions
void	ClearOutEndgames (void)
	clear endgame settings away More...

bool	DetermineEndgameSpecs (csString endgameXMLstr, csString name)
	decipher endgame specs from XML More...

bool	DetermineGameRules (csString rulesXMLstr, csString name)
	decipher simple game rules from XML More...

uint8_t	GetCols () const
	Returns the number of columns. More...

uint16_t	GetGameboardOptions (void)
	returns gameboard layout options More...

int	GetLayoutSize () const
	returns layout size More...

uint8_t	GetRows () const
	Returns the number of rows. More...

void	PackLayoutString (const char layoutStr, uint8_t packedLayout)
	pack string layout into binary array More...

uint8_t	PackPiece (char pieceStr)
	pack a single piece into binary form More...

	psMiniGameBoardDef (const uint8_t defCols, const uint8_t defRows, const char defLayout, const char defPieces, const uint8_t defPlayers, const int16_t options)

	~psMiniGameBoardDef ()

Detailed Description

Game board definition class.

Class for defining a mini-game, including board dimensions & layout and game rules.

Definition at line 116 of file psminigameboard.h.

Constructor & Destructor Documentation

psMiniGameBoardDef::psMiniGameBoardDef	(	const uint8_t	defCols,
		const uint8_t	defRows,
		const char *	defLayout,
		const char *	defPieces,
		const uint8_t	defPlayers,
		const int16_t	options
	)

psMiniGameBoardDef::~psMiniGameBoardDef ( )

void psMiniGameBoardDef::ClearOutEndgames ( void )

inline

clear endgame settings away

Definition at line 165 of file psminigameboard.h.

bool psMiniGameBoardDef::DetermineEndgameSpecs	(	csString	endgameXMLstr,
		csString	name
	)

decipher endgame specs from XML

bool psMiniGameBoardDef::DetermineGameRules	(	csString	rulesXMLstr,
		csString	name
	)

decipher simple game rules from XML

uint8_t psMiniGameBoardDef::GetCols ( ) const

inline

Returns the number of columns.

Definition at line 129 of file psminigameboard.h.

uint16_t psMiniGameBoardDef::GetGameboardOptions ( void )

inline

returns gameboard layout options

Definition at line 153 of file psminigameboard.h.

int psMiniGameBoardDef::GetLayoutSize ( ) const

inline

returns layout size

Definition at line 141 of file psminigameboard.h.

uint8_t psMiniGameBoardDef::GetRows ( ) const

inline

Returns the number of rows.

Definition at line 135 of file psminigameboard.h.

void psMiniGameBoardDef::PackLayoutString	(	const char *	layoutStr,
		uint8_t *	packedLayout
	)

pack string layout into binary array

uint8_t psMiniGameBoardDef::PackPiece ( char pieceStr )

pack a single piece into binary form

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