Character Class Reference

A playable character. More...

#include <FF7Character.h>

Public Types
enum	CharacterId {   CLOUD = 0 , BARRET = 1 , TIFA = 2 , AERIS = 3 ,   RED = 4 , CID = 5 , VINCENT = 6 , YUVI = 7 ,   KETCY = 8 , UNKNOWN = 9 }
	List of character IDs. More...

Public Member Functions
	Character ()
	Constructor. More...
virtual	~Character ()
	Destructor. More...

Static Public Member Functions
static CharacterId	GetIdByName (const VGears::String &name)
	Retrieves a character ID from it's name. More...

Private Types
typedef std::map< VGears::String, CharacterId >	CharacterIdLookupMap

Static Private Member Functions
static CharacterIdLookupMap	CreateLookupMap ()
	Creates a lookup map for character names. More...

Static Private Attributes
static const CharacterIdLookupMap	character_id_lookup_

Detailed Description

A playable character.

Member Typedef Documentation

CharacterIdLookupMap

typedef std::map<VGears::String, CharacterId> Character::CharacterIdLookupMap

private

Member Enumeration Documentation

CharacterId

enum Character::CharacterId

List of character IDs.

Enumerator
CLOUD	Cloud's ID.
BARRET	Barret's ID.
TIFA	Tifa's ID.
AERIS	Aerith's ID.
RED	Red XIII's ID.
CID	Cid's ID.
VINCENT	Vincent's ID.
YUVI	Yuffie's ID.
KETCY	Cait Sith's ID.
UNKNOWN	Unknown character ID.

Constructor & Destructor Documentation

Character()

Character::Character

(

)

Constructor.

~Character()

Character::~Character ( )

virtual

Destructor.

Member Function Documentation

CreateLookupMap()

Character::CharacterIdLookupMap Character::CreateLookupMap ( )

staticprivate

Creates a lookup map for character names.

Names frequently used in the field scripts for the playable characters are included in the lookup map.

Returns

The character name lookup map.

GetIdByName()

Character::CharacterId Character::GetIdByName ( const VGears::String &  name )

static

Retrieves a character ID from it's name.

Parameters

[in]

name

Chaarcter name.

Returns

ID of the character with the specified name, or {

See also

UNKNOWN} if the character doesn't exist.

Member Data Documentation

character_id_lookup_

const Character::CharacterIdLookupMap Character::character_id_lookup_

staticprivate

---

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

• src/FF7Character.h
• src/FF7Character.cpp