ScriptFormatter Class Reference

#include <ScriptFormatter.h>

Inheritance diagram for ScriptFormatter:

Public Member Functions
virtual	~ScriptFormatter ()=default
virtual std::string	GetFriendlyVarName (unsigned int bank, unsigned int addr)
	Retrieves a friendly name for a variable. More...
virtual std::string	GetFriendlyEntityName (const std::string &entity_name)
	Retrieves a friendly name for an entity. More...
virtual std::string	GetFriendlyAnimationName (int animation_id, int id)
	Retrieves a friendly name for an animation. More...
virtual std::string	GetFriendlyCharName (int char_id)
	Retrieves a friendly name for a character. More...
virtual std::string	GetFriendlyFunctionName (const std::string &entity_name, const std::string &function_name)
	Retrieves a friendly name for a function. More...
virtual std::string	GetFunctionComment (const std::string &entity_name, const std::string &function_name)
	Retrieves the header comment for a function in an entity. More...

Constructor & Destructor Documentation

~ScriptFormatter()

virtual ScriptFormatter::~ScriptFormatter ( )

virtualdefault

Member Function Documentation

GetFriendlyAnimationName()

std::string ScriptFormatter::GetFriendlyAnimationName ( int  animation_id, int  id  )

virtual

Retrieves a friendly name for an animation.

Parameters

[in]	animation_id	ID of the animation.
[in]	id	Unused.

Returns

Friendly name assigned to the animation. If there is no one, the ID in string format.

Reimplemented in FF7FieldScriptFormatter.

GetFriendlyCharName()

std::string ScriptFormatter::GetFriendlyCharName ( int  char_id )

virtual

Retrieves a friendly name for a character.

Parameters

[in]

char_id

ID of the character.

Returns

Friendly name assigned to the character. If there is no one, the ID in string format.

Reimplemented in BaseFF7FieldScriptFormatter.

GetFriendlyEntityName()

std::string ScriptFormatter::GetFriendlyEntityName ( const std::string &  entity_name )

virtual

Retrieves a friendly name for an entity.

Parameters

[in]

entity_name

Name of the entity.

Returns

Friendly name assigned to the entity, or entity_name if there is none.

Reimplemented in BaseFF7FieldScriptFormatter.

GetFriendlyFunctionName()

std::string ScriptFormatter::GetFriendlyFunctionName ( const std::string &  entity_name, const std::string &  function_name  )

virtual

Retrieves a friendly name for a function.

Parameters

[in]	entity_name	Name of the entity.
[in]	function_name	Name of the function.

Returns

Friendly name assigned to the entity, or function_name if there is none.

Reimplemented in BaseFF7FieldScriptFormatter.

GetFriendlyVarName()

std::string ScriptFormatter::GetFriendlyVarName ( unsigned int  bank, unsigned int  addr  )

virtual

Retrieves a friendly name for a variable.

Parameters

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

Returns

Friendly name assigned to the variable, or an empty string if there is none.

Reimplemented in BaseFF7FieldScriptFormatter.

GetFunctionComment()

std::string ScriptFormatter::GetFunctionComment ( const std::string &  entity_name, const std::string &  function_name  )

virtual

Retrieves the header comment for a function in an entity.

Parameters

[in]	entity_name	Name of the entity.
[in]	function_name	Name of the function.

Returns

The function comment. An empty string if the entity or the function don't exist.

Reimplemented in BaseFF7FieldScriptFormatter.

---

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

• src/installer/decompiler/ScriptFormatter.h
• src/installer/decompiler/ScriptFormatter.cpp