cpp_client::saloon::Furnishing Class Reference

An furnishing in the Saloon that must be pathed around, or destroyed. More...

#include <furnishing.hpp>

Inheritance diagram for cpp_client::saloon::Furnishing:

Public Member Functions
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 &	health
	How much health this Furnishing currently has. More...
const bool &	is_destroyed
	If this Furnishing has been destroyed, and has been removed from the game. More...
const bool &	is_piano
	True if this Furnishing is a piano and can be played, False otherwise. More...
const bool &	is_playing
	If this is a piano and a Cowboy is playing it this turn. More...
const Tile &	tile
	The Tile that this Furnishing is located on. 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

An furnishing in the Saloon that must be pathed around, or destroyed.

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

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 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 int& cpp_client::saloon::Furnishing::health

How much health this Furnishing currently has.

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::Furnishing::is_destroyed

If this Furnishing has been destroyed, and has been removed from the game.

const bool& cpp_client::saloon::Furnishing::is_piano

True if this Furnishing is a piano and can be played, False otherwise.

const bool& cpp_client::saloon::Furnishing::is_playing

If this is a piano and a Cowboy is playing it this turn.

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::Furnishing::tile

The Tile that this Furnishing is located on.

---

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

• games/saloon/furnishing.hpp