C++ Joueur Client
 All Classes Namespaces Functions Variables
cpp_client::coreminer::Player Class Reference

A player in this game. Every AI controls one player. More...

#include <player.hpp>

Inheritance diagram for cpp_client::coreminer::Player:
cpp_client::coreminer::Game_object cpp_client::Base_object

Public Member Functions

bool spawn_miner ()
 spawns a _miner on this _player's base _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 Tilebase_tile
 The Tile this Player's base is on. More...
 
const std::vector< Bomb > & bombs
 Every Bomb owned by this Player. More...
 
const std::string & client_type
 What type of client this is, e.g. 'Python', 'JavaScript', or some other language. For potential data mining purposes. More...
 
const std::vector< Tile > & hopper_tiles
 The Tiles this Player's hoppers are on. More...
 
const bool & lost
 If the player lost the game or not. More...
 
const std::vector< Miner > & miners
 Every Miner owned by this Player. More...
 
const int & money
 The amount of money this Player currently has. More...
 
const std::string & name
 The name of the player. More...
 
const Playeropponent
 This player's opponent in the game. More...
 
const std::string & reason_lost
 The reason why the player lost the game. More...
 
const std::string & reason_won
 The reason why the player won the game. More...
 
const double & time_remaining
 The amount of time (in ns) remaining for this AI to send commands. More...
 
const int & value
 The amount of value (victory points) this Player has gained. More...
 
const bool & won
 If the player won the game or not. 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 player in this game. Every AI controls one player.

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::coreminer::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
messageA string to add to this GameObject's log. Intended for debugging.
bool cpp_client::coreminer::Player::spawn_miner ( )

spawns a _miner on this _player's base _tile.

Member Data Documentation

const Tile& cpp_client::coreminer::Player::base_tile

The Tile this Player's base is on.

const std::vector<Bomb>& cpp_client::coreminer::Player::bombs

Every Bomb owned by this Player.

const std::string& cpp_client::coreminer::Player::client_type

What type of client this is, e.g. 'Python', 'JavaScript', or some other language. For potential data mining purposes.

const std::string& cpp_client::coreminer::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 std::vector<Tile>& cpp_client::coreminer::Player::hopper_tiles

The Tiles this Player's hoppers are on.

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

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

const bool& cpp_client::coreminer::Player::lost

If the player lost the game or not.

const std::vector<Miner>& cpp_client::coreminer::Player::miners

Every Miner owned by this Player.

const int& cpp_client::coreminer::Player::money

The amount of money this Player currently has.

const std::string& cpp_client::coreminer::Player::name

The name of the player.

const Player& cpp_client::coreminer::Player::opponent

This player's opponent in the game.

const std::string& cpp_client::coreminer::Player::reason_lost

The reason why the player lost the game.

const std::string& cpp_client::coreminer::Player::reason_won

The reason why the player won the game.

const double& cpp_client::coreminer::Player::time_remaining

The amount of time (in ns) remaining for this AI to send commands.

const int& cpp_client::coreminer::Player::value

The amount of value (victory points) this Player has gained.

const bool& cpp_client::coreminer::Player::won

If the player won the game or not.


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