cpp_client::stumped::Job Class Reference

Information about a beaver's job. More...

#include <job.hpp>

Inheritance diagram for cpp_client::stumped::Job:

Public Member Functions
Beaver	recruit (const Tile &tile)
	recruits a _beaver of this _job to a lodge. 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 &	actions
	The number of actions this Job can make per turn. More...
const int &	carry_limit
	How many combined resources a beaver with this Job can hold at once. More...
const int &	chopping
	Scalar for how many branches this Job harvests at once. More...
const int &	cost
	How much food this Job costs to recruit. More...
const int &	damage
	The amount of damage this Job does per attack. More...
const int &	distraction_power
	How many turns a beaver attacked by this Job is distracted by. More...
const int &	health
	The amount of starting health this Job has. More...
const int &	moves
	The number of moves this Job can make per turn. More...
const int &	munching
	Scalar for how much food this Job harvests at once. More...
const std::string &	title
	The Job title. 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

Information about a beaver's job.

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.

Beaver cpp_client::stumped::Job::recruit

(

const Tile &

tile

)

recruits a _beaver of this _job to a lodge.

Parameters

tile	The Tile that is a lodge owned by you that you wish to spawn the Beaver of this Job on.

Member Data Documentation

const int& cpp_client::stumped::Job::actions

The number of actions this Job can make per turn.

const int& cpp_client::stumped::Job::carry_limit

How many combined resources a beaver with this Job can hold at once.

const int& cpp_client::stumped::Job::chopping

Scalar for how many branches this Job harvests at once.

const int& cpp_client::stumped::Job::cost

How much food this Job costs to recruit.

const int& cpp_client::stumped::Job::damage

The amount of damage this Job does per attack.

const int& cpp_client::stumped::Job::distraction_power

How many turns a beaver attacked by this Job is distracted by.

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 int& cpp_client::stumped::Job::health

The amount of starting health this Job has.

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 int& cpp_client::stumped::Job::moves

The number of moves this Job can make per turn.

const int& cpp_client::stumped::Job::munching

Scalar for how much food this Job harvests at once.

const std::string& cpp_client::stumped::Job::title

The Job title.

---

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

• games/stumped/job.hpp