Nymph Game Engine
Chaiscript based Game Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Game::Map Class Reference

Class wrapper for Tmx::Map. More...

#include <map.h>

Public Member Functions

 Map ()=delete
 
virtual ~Map ()
 
Tmx::Map * getImpl () const noexcept
 Gets the implementation (the actual TMX map) More...
 
 Map (const std::string &path)
 Map Constructor. More...
 
 Map (const Map &map)=default
 Copy constructor. More...
 
std::string getPath () const noexcept
 Gets the path. More...
 
Mapoperator= (const Map &map)=default
 equals operator for map More...
 

Detailed Description

Class wrapper for Tmx::Map.

Constructor & Destructor Documentation

Game::Map::Map ( )
delete
virtual Game::Map::~Map ( )
inlinevirtual
Game::Map::Map ( const std::string &  path)

Map Constructor.

Parameters
[in]nameThe map path
Game::Map::Map ( const Map map)
default

Copy constructor.

Parameters
[in]mapOther map wrapper class

Member Function Documentation

Tmx::Map * Game::Map::getImpl ( ) const
noexcept

Gets the implementation (the actual TMX map)

Returns
Returns the actual Tmx::Map contained in this wrapper.

Referenced by Game::SceneGenerator::createSceneFromMap().

std::string Game::Map::getPath ( ) const
noexcept

Gets the path.

Returns
The path.

Referenced by Game::SceneGenerator::createSceneFromMap(), and generated::getMapModule().

Map& Game::Map::operator= ( const Map map)
default

equals operator for map

Parameters
[in]mapThe other map
Returns
returns *this

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