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

#include <tile.hpp>

Inheritance diagram for cpp_client::saloon::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 Bottle &	bottle
	The beer Bottle currently flying over this Tile, null otherwise. More...

const Cowboy &	cowboy
	The Cowboy that is on this Tile, null otherwise. More...

const Furnishing &	furnishing
	The furnishing that is on this Tile, null otherwise. More...

const bool &	has_hazard
	If this Tile is pathable, but has a hazard that damages Cowboys that path through it. More...

const bool &	is_balcony
	If this Tile is a balcony of the Saloon that YoungGuns walk around on, and can never be pathed through by Cowboys. 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 &	x
	The x (horizontal) position of this Tile. More...

const int &	y
	The y (vertical) position of this Tile. More...

const Young_gun &	young_gun
	The YoungGun on this tile, null otherwise. 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::saloon::Tile::get_neighbors ( )

Gets the neighbors of this Tile

Returns: The neighboring (adjacent) Tiles to this tile

bool cpp_client::saloon::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::saloon::Tile::is_pathable ( )

Checks if a Tile is pathable to units

Returns: true if pathable, false otherwise

void cpp_client::saloon::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 Bottle& cpp_client::saloon::Tile::bottle

The beer Bottle currently flying over this Tile, null otherwise.

const Cowboy& cpp_client::saloon::Tile::cowboy

The Cowboy that is on this Tile, null otherwise.

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

static

The list of all valid directions Tiles can be in

const Furnishing& cpp_client::saloon::Tile::furnishing

The furnishing that is on this Tile, null otherwise.

const std::string& cpp_client::saloon::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 bool& cpp_client::saloon::Tile::has_hazard

If this Tile is pathable, but has a hazard that damages Cowboys that path through it.

const std::string& cpp_client::saloon::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::saloon::Tile::is_balcony

If this Tile is a balcony of the Saloon that YoungGuns walk around on, and can never be pathed through by Cowboys.

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

inherited

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

const Tile& cpp_client::saloon::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::saloon::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::saloon::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::saloon::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::saloon::Tile::x

The x (horizontal) position of this Tile.

const int& cpp_client::saloon::Tile::y

The y (vertical) position of this Tile.

const Young_gun& cpp_client::saloon::Tile::young_gun

The YoungGun on this tile, null otherwise.

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

games/saloon/tile.hpp

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation