cpp_client::checkers::Checker Class Reference

A checker on the game board. More...

#include <checker.hpp>

Inheritance diagram for cpp_client::checkers::Checker:

Public Member Functions
bool	is_mine ()
	returns if the checker is owned by your player or not. More...
Checker	move (int x, int y)
	moves the checker from its current location to the given (x, y). More...
void	log (const std::string &message)
	adds a message to this _game_object's logs. _intended for your own debugging purposes, as strings stored here are saved in the gamelog. More...
template<typename T >
std::shared_ptr< typename T::element_type >	as ()
	Dynamically casts this object to another type. Returns nullptr if it cannot be converted to the type. More...
template<typename T >
bool	is ()
	Determines if this object is of the specified object type More...

Public Attributes
const bool &	kinged
	If the checker has been kinged and can move backwards. More...
const Player &	owner
	The player that controls this Checker. More...
const int &	x
	The x coordinate of the checker. More...
const int &	y
	The y coordinate of the checker. More...
const std::string &	game_object_name
	String representing the top level Class that this game object is an instance of. Used for reflection to create new instances on clients, but exposed for convenience should AIs want this data. More...
const std::string &	id
	A unique id for each instance of a GameObject or a sub class. Used for client and server communication. Should never change value after being set. More...
const std::vector< std::string > &	logs
	Any strings logged will be stored here. Intended for debugging. More...

Detailed Description

A checker on the game board.

Member Function Documentation

template<typename T >

std::shared_ptr<typename T::element_type> cpp_client::Base_object::as ( )

inlineinherited

Dynamically casts this object to another type. Returns nullptr if it cannot be converted to the type.

Returns

A pointer to the desired type, or nullptr if it could not be converted

template<typename T >

bool cpp_client::Base_object::is ( )

inlineinherited

Determines if this object is of the specified object type

Returns

true if the object is the object type, false otherwise

bool cpp_client::checkers::Checker::is_mine

(

)

returns if the checker is owned by your player or not.

void cpp_client::checkers::Game_object::log ( const std::string &  message )

inherited

adds a message to this _game_object's logs. _intended for your own debugging purposes, as strings stored here are saved in the gamelog.

Parameters

message

A string to add to this GameObject's log. Intended for debugging.

Checker cpp_client::checkers::Checker::move	(	int	x,
		int	y
	)

moves the checker from its current location to the given (x, y).

Parameters

x	The x coordinate to move to.
y	The y coordinate to move to.

Member Data Documentation

const std::string& cpp_client::checkers::Game_object::game_object_name

inherited

String representing the top level Class that this game object is an instance of. Used for reflection to create new instances on clients, but exposed for convenience should AIs want this data.

const std::string& cpp_client::checkers::Game_object::id

inherited

A unique id for each instance of a GameObject or a sub class. Used for client and server communication. Should never change value after being set.

const bool& cpp_client::checkers::Checker::kinged

If the checker has been kinged and can move backwards.

const std::vector<std::string>& cpp_client::checkers::Game_object::logs

inherited

Any strings logged will be stored here. Intended for debugging.

const Player& cpp_client::checkers::Checker::owner

The player that controls this Checker.

const int& cpp_client::checkers::Checker::x

The x coordinate of the checker.

const int& cpp_client::checkers::Checker::y

The y coordinate of the checker.

---

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

• games/checkers/checker.hpp