VGears::NameLookup Class Reference

Name lookup convenience class. More...

#include <FF7NameLookup.h>

Public Member Functions
	NameLookup ()=delete
	Constructor, not to use. More...

Static Public Member Functions
static String	CharName (int char_id)
	Retrieves a character name from an ID. More...
static const String &	Animation (const String &key)
	Matches animation names. More...
static const String &	model (const String &key)
	Matches model names. More...
static String	FieldScriptVarName (int bank, int addr)
	Retrieves a variable name. More...
static String	FieldScriptEntityName (const String &old_entity_name)
	Matches entity names. More...
static String	FieldScriptFunctionComment (const String &field_name, const String &entity_name, const String &old_function_name)
	Matches function comments. More...
static String	FieldScriptFunctionName (const String &field_name, const String &entity_name, const String &old_function_name)
	Matches function names. More...
static FF7Metadata &	Data ()
	Retrieves game metadata. More...

Detailed Description

Name lookup convenience class.

Constructor & Destructor Documentation

NameLookup()

VGears::NameLookup::NameLookup ( )

delete

Constructor, not to use.

Member Function Documentation

Animation()

static const String & VGears::NameLookup::Animation ( const String &  key )

inlinestatic

Matches animation names.

Looks for defined names associated to the original game animation names. Defined names are more user friendly, more readable and more descriptive.

Parameters

[in]

key

Original game animation name.

Returns

Friendly name associated to the animation, or the original name if there is no name associated.

CharName()

static String VGears::NameLookup::CharName ( int  char_id )

inlinestatic

Retrieves a character name from an ID.

Data()

static FF7Metadata & VGears::NameLookup::Data ( )

inlinestatic

Retrieves game metadata.

Returns

The game metadata.

FieldScriptEntityName()

static String VGears::NameLookup::FieldScriptEntityName ( const String &  old_entity_name )

inlinestatic

Matches entity names.

Looks for defined names associated to the original game entity name. Defined names are more user friendly, more readable and more descriptive.

Parameters

[in]

old_entity_name

Original game entity name.

Returns

Friendly name associated to the entity, or the original name if there is no name associated.

FieldScriptFunctionComment()

static String VGears::NameLookup::FieldScriptFunctionComment ( const String &  field_name, const String &  entity_name, const String &  old_function_name  )

inlinestatic

Matches function comments.

Parameters

[in]	field_name	The name of the field from witch to get the data.
[in]	entity_name	Name of the entity rom witch to get the data.
[in]	old_function_name	The original function name.

Returns

Associated function name pair. An empty pair if the field, entity or function don't exist.

Todo:

Does this maps comments, or functions with comments?

FieldScriptFunctionName()

static String VGears::NameLookup::FieldScriptFunctionName ( const String &  field_name, const String &  entity_name, const String &  old_function_name  )

inlinestatic

Matches function names.

Looks for defined names associated to the original game function name. Defined names are more user friendly, more readable and more descriptive.

Parameters

[in]	field_name	The name of the field from witch to get the data.
[in]	entity_name	Name of the entity rom witch to get the data.
[in]	old_function_name	The original function name.

Returns

Associated function name, or the original name if there is no name associated.

FieldScriptVarName()

static String VGears::NameLookup::FieldScriptVarName ( int  bank, int  addr  )

inlinestatic

Retrieves a variable name.

Variables that are frequently used across the game may have an associated name, more fiendly and descriptive.

Parameters

[in]	bank	Variable bank.
[in]	addr	Variable address.

Returns

Friendly name associated to the variable, or an empty string if it has no associated friendly name.

model()

static const String & VGears::NameLookup::model ( const String &  key )

inlinestatic

Matches model names.

Looks for defined names associated to the original game model names. Defined names are more user friendly, more readable and more descriptive.

Parameters

[in]

key

Original game model name.

Returns

Friendly name associated to the model, or the original name if there is no name associated.

---

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

• src/common/FinalFantasy7/FF7NameLookup.h