Game Class Reference

#include <Game.h>

Inheritance diagram for Game:

Public Member Functions
	Game (const std::string &map_file)
	Game Constructor. More...
	Game (const std::string &map_file, Config config)
	~Game ()
Unit &	getUnit (int idx)
	Get a Unit via index. More...
uint32_t	getMaxFPS () const
uint32_t	getFPS () const
uint64_t	getGameDuration () const
uint64_t	getTicks () const
uint32_t	getWidth () const
uint32_t	getHeight () const
uint32_t	getEpisode () const
uint32_t	getId () const
long	getTicksModifier () const
Unit *	getUnitByNameID (const std::string &nameID)
void	setMaxFPS (int fps_)
	Set the Game FPS. More...
void	setSelectedPlayer (Player &player)
	Set selected player. More...
Player &	addPlayer ()
void	insertPlayer (Player &player)
void	tick ()
	Game Tick Function. More...
virtual void	update ()
	Game Update Function. More...
virtual void	_update ()
const cv::Mat &	render ()
	Game Render Function. More...
virtual const cv::Mat &	_render () const
	Game Render implementation. More...
void	caption ()
	Print the Game Statistics. More...
virtual void	_caption () const
void	start ()
void	stop ()
void	reset ()
virtual void	_reset ()
bool	isTerminal ()
virtual void	_onUnitCreate (const Unit &unit) const
virtual void	_onUnitDestroy (const Unit &unit) const
virtual void	_onResourceGather (const Tile &tile, const Unit &unit) const
virtual void	_onResourceDepleted (const Tile &tile, const Unit &unit) const
virtual void	_onEpisodeStart () const
virtual void	_onEpisodeEnd () const
virtual void	_onTileChange (const Tile &) const
virtual void	_onUnitAttack (const Unit &unit) const

Public Attributes
std::unique_ptr< BaseGUI >	gui
	GUI Pointer. More...
const Config	config
Map	map
	Const Map (Order 1) More...
xt::xarray< double, xt::layout_type::row_major >	state
	Game state (Order 2) More...
Tilemap	tilemap
	Game Tilemap (Order 3) More...
StateManager	stateManager
	Game State Manager. More...
std::vector< Player >	players
	List of Players inside the game session. More...
std::vector< Unit >	units
	List of Units inside the game session. More...
std::unordered_map< std::string, Unit * >	unitsNameMap
uint32_t	id {}
	Game Identification. More...
uint64_t	ticks = 0
	Game Episode Ticks. More...
uint32_t	episode = 1
	Game Episode. More...
uint32_t	max_fps {}
	Game Max FPS. More...
uint32_t	currentFPS = 0
	Game Current FPS. More...
bool	terminal = false
	Game terminal flag. More...
Player *	selectedPlayer {}
	Selected player. More...
const cv::Mat	renderPlaceholder
	empty opencv container in case of no GUI More...

Constructor & Destructor Documentation

Game() [1/2]

Game::Game ( const std::string &  map_file )

explicit

Game Constructor.

Game() [2/2]

Game::Game	(	const std::string &	map_file,
		Config	config
	)

~Game()

Game::~Game ( )

default

Member Function Documentation

_caption()

void Game::_caption ( ) const

virtual

_onEpisodeEnd()

void Game::_onEpisodeEnd ( ) const

virtual

_onEpisodeStart()

void Game::_onEpisodeStart ( ) const

virtual

_onResourceDepleted()

void Game::_onResourceDepleted ( const Tile &  tile, const Unit &  unit  ) const

virtual

_onResourceGather()

void Game::_onResourceGather ( const Tile &  tile, const Unit &  unit  ) const

virtual

_onTileChange()

void Game::_onTileChange ( const Tile &  tile ) const

virtual

_onUnitAttack()

void Game::_onUnitAttack ( const Unit &  unit ) const

virtual

_onUnitCreate()

void Game::_onUnitCreate ( const Unit &  unit ) const

virtual

Callback Functions

_onUnitDestroy()

void Game::_onUnitDestroy ( const Unit &  unit ) const

virtual

_render()

const cv::Mat & Game::_render ( ) const

virtual

Game Render implementation.

_reset()

void Game::_reset ( )

virtual

_update()

void Game::_update ( )

virtual

addPlayer()

Player & Game::addPlayer

(

)

Engine Functions

caption()

void Game::caption

(

)

Print the Game Statistics.

getEpisode()

uint32_t Game::getEpisode

(

)

const

getFPS()

uint32_t Game::getFPS

(

)

const

getGameDuration()

uint64_t Game::getGameDuration

(

)

const

getHeight()

uint32_t Game::getHeight

(

)

const

getId()

uint32_t Game::getId

(

)

const

getMaxFPS()

uint32_t Game::getMaxFPS

(

)

const

getTicks()

uint64_t Game::getTicks

(

)

const

getTicksModifier()

long Game::getTicksModifier

(

)

const

getUnit()

Unit & Game::getUnit

(

int

idx

)

Get a Unit via index.

Getters

getUnitByNameID()

Unit * Game::getUnitByNameID

(

const std::string &

nameID

)

getWidth()

uint32_t Game::getWidth

(

)

const

insertPlayer()

void Game::insertPlayer

(

Player &

player

)

isTerminal()

bool Game::isTerminal

(

)

render()

const cv::Mat & Game::render

(

)

Game Render Function.

reset()

void Game::reset

(

)

setMaxFPS()

void Game::setMaxFPS

(

int

fps_

)

Set the Game FPS.

Setters

setSelectedPlayer()

void Game::setSelectedPlayer

(

Player &

player

)

Set selected player.

start()

void Game::start

(

)

stop()

void Game::stop

(

)

tick()

void Game::tick

(

)

Game Tick Function.

update()

void Game::update ( )

virtual

Game Update Function.

Reimplemented in DeepRTS::Scenario::Scenario.

Member Data Documentation

config

const Config Game::config

Properties

Const Config (Order 0)

currentFPS

uint32_t Game::currentFPS = 0

Game Current FPS.

episode

uint32_t Game::episode = 1

Game Episode.

gui

std::unique_ptr<BaseGUI> Game::gui

GUI Pointer.

id

uint32_t Game::id {}

Game Identification.

map

Map Game::map

Const Map (Order 1)

max_fps

uint32_t Game::max_fps {}

Game Max FPS.

players

std::vector<Player> Game::players

List of Players inside the game session.

renderPlaceholder

const cv::Mat Game::renderPlaceholder

empty opencv container in case of no GUI

selectedPlayer

Player* Game::selectedPlayer {}

Selected player.

state

xt::xarray<double, xt::layout_type::row_major> Game::state

Game state (Order 2)

stateManager

StateManager Game::stateManager

Game State Manager.

terminal

bool Game::terminal = false

Game terminal flag.

ticks

uint64_t Game::ticks = 0

Game Episode Ticks.

tilemap

Tilemap Game::tilemap

Game Tilemap (Order 3)

units

std::vector<Unit> Game::units

List of Units inside the game session.

unitsNameMap

std::unordered_map<std::string, Unit*> Game::unitsNameMap

---

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

• /home/per/git/code/deep-rts/include/DeepRTS/Game.h
• /home/per/git/code/deep-rts/src/Game.cpp