FF7Data Class Reference

Class that provides fixed data related to Final Fantasy VII. More...

#include <FF7Data.h>

Classes
struct	BattleModelInfo
	Information about a model. More...
class	CHAR_ID
	Contains playable character IDs. More...

Static Public Member Functions
static std::string	GetEnemyModelId (const unsigned int enemy_id)
	Retrieves an enemy model ID from an enemy ID. More...
static BattleModelInfo	GetBattleModelInfo (std::string model_id)
	Retrieves information about a battle model from it's name. More...
static std::string	GetEnemyModelFromEnemyId (const unsigned int id)
	Retrieves a battle model code from an enemy ID. More...

Detailed Description

Class that provides fixed data related to Final Fantasy VII.

Member Function Documentation

GetBattleModelInfo()

static BattleModelInfo FF7Data::GetBattleModelInfo ( std::string  model_id )

inlinestatic

Retrieves information about a battle model from it's name.

The return structure has the following properties ({

See also

BattleModelInfo}):

• numeric_id: A numeric ID assigned to the model. For enemies, it's a unique enemy ID. For scenes, it's a unique numeric id. For playable characters, it is the id of the character the model references, but since a character may have many models, it's not guaranteed to be unique. There is a special case where it is -1: for the playable frog, which is related to all characters.
• alphanumeric_id: A unique id assigned to the model. Two lowercase letters.
• name: A descriptive name for the model. For debugging purposes only, it's not intended to ever be displayed, and it's not suitable to use in filenames.
• name_normal: Simplified name, suitable to be used on filenames. Not garanteed to be unique.
• is_enemy: Indicates if the models is a battle enemy.
• is_enemy: Indicates if the models is a battle playable character.
• is_scene: Indicates if the models is a battle scenario.

Parameters

[in]

model_id

ID of the model. It can be two letters, or two letters preceded by "btl_". Case insensitive. If the id contains more than four letters (not counting the optional "btl_" prefix), only the first two sill be considered.

Returns

A battle model info structure. If an invvalid model ID is provided, or if the model doesn't exist, an empty structure will be returned.

GetEnemyModelFromEnemyId()

static std::string FF7Data::GetEnemyModelFromEnemyId ( const unsigned int  id )

inlinestatic

Retrieves a battle model code from an enemy ID.

Parameters

[in]

id

Enemy ID.

Returns

The code for the model for the enemy, as in the filename in the .mesh file.

GetEnemyModelId()

static std::string FF7Data::GetEnemyModelId ( const unsigned int  enemy_id )

inlinestatic

Retrieves an enemy model ID from an enemy ID.

Parameters

[in]

enemy_id

Numeric enemy ID.

Returns

Enemy alphanumeric ID. Two-lowercase letters. If an invalid ID is provided, an empty string will be returned.

---

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

• src/installer/data/FF7Data.h