V-Gears 0
Free Final Fantasy VII engine.
XmlBattleCharactersFile Class Reference

Handles battle character model list xml files. More...

#include <XmlBattleCharactersFile.h>

Inheritance diagram for XmlBattleCharactersFile:
Collaboration diagram for XmlBattleCharactersFile:

Classes

struct  BattleCharacter
 Relation of character and it's models. More...
 
struct  BattleCharacterModel
 Information about each character model. More...
 

Public Member Functions

 XmlBattleCharactersFile (const Ogre::String &file)
 Constructor. More...
 
virtual ~XmlBattleCharactersFile ()
 Destructor. More...
 
std::vector< BattleCharacterGetCharacters ()
 Retrieves the battle character list. More...
 
- Public Member Functions inherited from XmlFile
 XmlFile (const Ogre::String &file)
 Constructor. More...
 
virtual ~XmlFile ()
 Destructor. More...
 
bool GetBool (TiXmlNode *node, const Ogre::String &tag, bool def=false) const
 Retrieves a boolean from an XMl tag. More...
 
int GetInt (TiXmlNode *node, const Ogre::String &tag, int def=0) const
 Retrieves an integer from an XMl tag. More...
 
float GetFloat (TiXmlNode *node, const Ogre::String &tag, float def=0.0f) const
 Retrieves a defcimal from an XMl tag. More...
 
const Ogre::String GetString (TiXmlNode *node, const Ogre::String &tag, const Ogre::String &def="") const
 Retrieves a string from an XMl tag. More...
 
const Ogre::UTFString GetUTFString (TiXmlNode *node, const Ogre::String &tag, const Ogre::UTFString &def="") const
 Retrieves a string from an XMl tag. More...
 
const Ogre::Vector2 GetVector2 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector2 &def=Ogre::Vector2::ZERO) const
 Retrieves a 2-dimensional vector from an XMl tag. More...
 
const Ogre::Vector3 GetVector3 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector3 &def=Ogre::Vector3::ZERO) const
 Retrieves a 3-dimensional vector from an XMl tag. More...
 
const Ogre::Vector4 GetVector4 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Vector4 &def=Ogre::Vector4::ZERO) const
 Retrieves a 4-dimensional vector from an XMl tag. More...
 
const Ogre::Matrix4 GetMatrix4 (TiXmlNode *node, const Ogre::String &tag, const Ogre::Matrix4 &def=Ogre::Matrix4::IDENTITY) const
 Retrieves a 4-dimensional matrix from an XMl tag. More...
 
const Ogre::Quaternion GetQuaternion (TiXmlNode *node, const Ogre::String &tag, const Ogre::Quaternion &def=Ogre::Quaternion::IDENTITY) const
 Retrieves a quaternion from an XMl tag. More...
 
const Ogre::ColourValue GetColourValue (TiXmlNode *node, const Ogre::String &tag, const Ogre::ColourValue &def=Ogre::ColourValue::ZERO) const
 Retrieves a colour from an XMl tag. More...
 

Private Attributes

std::vector< BattleCharacterlist_
 

Additional Inherited Members

- Protected Attributes inherited from XmlFile
bool normal_file_
 Indicates if the file is a normal file. More...
 
TiXmlDocument file_
 The XML file. More...
 

Detailed Description

Handles battle character model list xml files.

Those files contain a correlation between playable characters and their models.

Constructor & Destructor Documentation

◆ XmlBattleCharactersFile()

XmlBattleCharactersFile::XmlBattleCharactersFile ( const Ogre::String &  file)
explicit

Constructor.

Parses the information from the file.

Parameters
[in]filePath to the scenes XML file.

◆ ~XmlBattleCharactersFile()

XmlBattleCharactersFile::~XmlBattleCharactersFile ( )
virtual

Destructor.

Member Function Documentation

◆ GetCharacters()

std::vector< XmlBattleCharactersFile::BattleCharacter > XmlBattleCharactersFile::GetCharacters ( )

Retrieves the battle character list.

Returns
The map of battle character models.

Member Data Documentation

◆ list_

std::vector<BattleCharacter> XmlBattleCharactersFile::list_
private

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