cpp_client::stumped::Spawner Class Reference

A resource spawner that generates branches or food. More...

#include <spawner.hpp>

Inheritance diagram for cpp_client::stumped::Spawner:

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 bool &	has_been_harvested
	True if this Spawner has been harvested this turn, and it will not heal at the end of the turn, false otherwise. More...
const int &	health
	How much health this Spawner has, which is used to calculate how much of its resource can be harvested. More...
const Tile &	tile
	The Tile this Spawner is on. More...
const std::string &	type
	What type of resource this is ('food' or 'branches'). 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 resource spawner that generates branches or food.

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::stumped::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::stumped::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::stumped::Spawner::has_been_harvested

True if this Spawner has been harvested this turn, and it will not heal at the end of the turn, false otherwise.

const int& cpp_client::stumped::Spawner::health

How much health this Spawner has, which is used to calculate how much of its resource can be harvested.

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

inherited

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

const Tile& cpp_client::stumped::Spawner::tile

The Tile this Spawner is on.

const std::string& cpp_client::stumped::Spawner::type

What type of resource this is ('food' or 'branches').

---

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

• games/stumped/spawner.hpp