cpp_client::pirates::Port Class Reference

A port on a Tile. More...

#include <port.hpp>

Inheritance diagram for cpp_client::pirates::Port:

Public Member Functions
bool	spawn (const std::string &type)
	spawn a _unit on this port. 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 &	gold
	For players, how much more gold this Port can spend this turn. For merchants, how much gold this Port has accumulated (it will spawn a ship when the Port can afford one). More...
const int &	investment
	(Merchants only) How much gold was invested into this Port. Investment determines the strength and value of the next ship. More...
const Player &	owner
	The owner of this Port, or null if owned by merchants. More...
const Tile &	tile
	The Tile this Port is 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

A port on a Tile.

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::pirates::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.

bool cpp_client::pirates::Port::spawn

(

const std::string &

type

)

spawn a _unit on this port.

Parameters

type	What type of Unit to create ('crew' or 'ship').

Member Data Documentation

const std::string& cpp_client::pirates::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::pirates::Port::gold

For players, how much more gold this Port can spend this turn. For merchants, how much gold this Port has accumulated (it will spawn a ship when the Port can afford one).

const std::string& cpp_client::pirates::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 int& cpp_client::pirates::Port::investment

(Merchants only) How much gold was invested into this Port. Investment determines the strength and value of the next ship.

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

inherited

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

const Player& cpp_client::pirates::Port::owner

The owner of this Port, or null if owned by merchants.

const Tile& cpp_client::pirates::Port::tile

The Tile this Port is on.

---

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

• games/pirates/port.hpp