cpp_client::catastrophe::Tile Class Reference

A Tile in the game that makes up the 2D map grid. More...

#include <tile.hpp>

Inheritance diagram for cpp_client::catastrophe::Tile:

Public Member Functions
std::vector< Tile >	get_neighbors ()
	Gets the neighbors of this Tile More...
bool	is_pathable ()
	Checks if a Tile is pathable to units More...
bool	has_neighbor (const Tile &tile)
	Checks if this Tile has a specific neighboring Tile 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 int &	food
	The number of food dropped on this Tile. More...
const int &	harvest_rate
	The amount of food that can be harvested from this Tile per turn. More...
const int &	materials
	The number of materials dropped on this Tile. More...
const Structure &	structure
	The Structure on this Tile if present, otherwise null. More...
const Tile &	tile_east
	The Tile to the 'East' of this one (x+1, y). Null if out of bounds of the map. More...
const Tile &	tile_north
	The Tile to the 'North' of this one (x, y-1). Null if out of bounds of the map. More...
const Tile &	tile_south
	The Tile to the 'South' of this one (x, y+1). Null if out of bounds of the map. More...
const Tile &	tile_west
	The Tile to the 'West' of this one (x-1, y). Null if out of bounds of the map. More...
const int &	turns_to_harvest
	The amount of turns before this resource can be harvested. More...
const Unit &	unit
	The Unit on this Tile if present, otherwise null. More...
const int &	x
	The x (horizontal) position of this Tile. More...
const int &	y
	The y (vertical) position of this Tile. 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...

Static Public Attributes
static const std::vector < std::string >	directions
	The list of all valid directions Tiles can be in More...

Detailed Description

A Tile in the game that makes up the 2D map grid.

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

std::vector<Tile> cpp_client::catastrophe::Tile::get_neighbors

(

)

Gets the neighbors of this Tile

Returns

The neighboring (adjacent) Tiles to this tile

bool cpp_client::catastrophe::Tile::has_neighbor

(

const Tile &

tile

)

Checks if this Tile has a specific neighboring Tile

Parameters

tile	Tile to check against

Returns

if the tile is a neighbor of this Tile, false otherwise

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::catastrophe::Tile::is_pathable

(

)

Checks if a Tile is pathable to units

Returns

true if pathable, false otherwise

void cpp_client::catastrophe::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.

Member Data Documentation

const std::vector<std::string> cpp_client::catastrophe::Tile::directions

static

The list of all valid directions Tiles can be in

const int& cpp_client::catastrophe::Tile::food

The number of food dropped on this Tile.

const std::string& cpp_client::catastrophe::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 int& cpp_client::catastrophe::Tile::harvest_rate

The amount of food that can be harvested from this Tile per turn.

const std::string& cpp_client::catastrophe::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 std::vector<std::string>& cpp_client::catastrophe::Game_object::logs

inherited

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

const int& cpp_client::catastrophe::Tile::materials

The number of materials dropped on this Tile.

const Structure& cpp_client::catastrophe::Tile::structure

The Structure on this Tile if present, otherwise null.

const Tile& cpp_client::catastrophe::Tile::tile_east

The Tile to the 'East' of this one (x+1, y). Null if out of bounds of the map.

const Tile& cpp_client::catastrophe::Tile::tile_north

The Tile to the 'North' of this one (x, y-1). Null if out of bounds of the map.

const Tile& cpp_client::catastrophe::Tile::tile_south

The Tile to the 'South' of this one (x, y+1). Null if out of bounds of the map.

const Tile& cpp_client::catastrophe::Tile::tile_west

The Tile to the 'West' of this one (x-1, y). Null if out of bounds of the map.

const int& cpp_client::catastrophe::Tile::turns_to_harvest

The amount of turns before this resource can be harvested.

const Unit& cpp_client::catastrophe::Tile::unit

The Unit on this Tile if present, otherwise null.

const int& cpp_client::catastrophe::Tile::x

The x (horizontal) position of this Tile.

const int& cpp_client::catastrophe::Tile::y

The y (vertical) position of this Tile.

---

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

• games/catastrophe/tile.hpp