BattleSceneFile Class Reference

#include <BattleSceneFile.h>

Collaboration diagram for BattleSceneFile:

Classes
struct	Scene
	A battle scene structure. More...

Public Member Functions
	BattleSceneFile (const unsigned int id, File file)
	Constructor. More...
	~BattleSceneFile ()
	Destructor. More...
std::vector< Attack >	GetAttacks ()
	Retrieves the attacks found in the scene. More...
std::vector< Enemy >	GetEnemies ()
	Retrieves the enemies found in the scene. More...
std::vector< Formation >	GetFormations ()
	Retrieves the formations found in the scene. More...

Private Member Functions
void	Read (File file)
	Reads data from a file. More...

Static Private Member Functions
static std::string	LocationToString (const int id)
	Retrieves a location name from it's ID. More...

Private Attributes
unsigned int	id_
	The file ID. More...
Scene	scene_
	The scene data. More...
std::vector< Attack >	attacks_
	Attacks found in the scene. More...
std::vector< Enemy >	enemies_
	Enemies found in the scene. More...
std::vector< Formation >	formations_
	Formations found in the scene. More...

Constructor & Destructor Documentation

BattleSceneFile()

BattleSceneFile::BattleSceneFile	(	const unsigned int	id,
		File	file
	)

Constructor.

Reads data from a file.

Parameters

[in]	id	ID of the file, the position at which it is found.
[in]	file	File to read from.

~BattleSceneFile()

BattleSceneFile::~BattleSceneFile

(

)

Destructor.

Member Function Documentation

GetAttacks()

std::vector< Attack > BattleSceneFile::GetAttacks

(

)

Retrieves the attacks found in the scene.

Returns

The list of attacks.

GetEnemies()

std::vector< Enemy > BattleSceneFile::GetEnemies

(

)

Retrieves the enemies found in the scene.

Returns

The list of enemies.

GetFormations()

std::vector< Formation > BattleSceneFile::GetFormations

(

)

Retrieves the formations found in the scene.

Returns

The list of formations.

LocationToString()

std::string BattleSceneFile::LocationToString ( const int  id )

staticprivate

Retrieves a location name from it's ID.

Parameters

[in]

id

Location ID.

Returns

The location name, or "UNKNOWN Location" if the ID is invalid.

Read()

void BattleSceneFile::Read ( File  file )

private

Reads data from a file.

Parameters

[in]

file

File to read from.

Member Data Documentation

attacks_

std::vector<Attack> BattleSceneFile::attacks_

private

Attacks found in the scene.

enemies_

std::vector<Enemy> BattleSceneFile::enemies_

private

Enemies found in the scene.

formations_

std::vector<Formation> BattleSceneFile::formations_

private

Formations found in the scene.

id_

unsigned int BattleSceneFile::id_

private

The file ID.

scene_

Scene BattleSceneFile::scene_

private

The scene data.

---

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

• src/installer/data/BattleSceneFile.h
• src/installer/data/BattleSceneFile.cpp