Formatter for field scripts. More...

Inheritance diagram for FieldScriptFormatter:

[legend]

Collaboration diagram for FieldScriptFormatter:

Public Member Functions
virtual void	AddSpawnPoint (unsigned int map_id, const std::string &entity, const std::string &function_name, unsigned int address, int x, int y, int triangle_id, int angle)
	Adds an spawn point. More...

virtual std::string	GetSpawnPointName (unsigned int map_id, const std::string &entity, const std::string &function_name, unsigned int address)
	Retrieves the name of a spawn point. More...

virtual std::string	GetMapName (unsigned int map_id)
	Retrieves the name of a map. More...

Public Member Functions inherited from ScriptFormatter
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...

Detailed Description

Formatter for field scripts.

Member Function Documentation

void FieldScriptFormatter::AddSpawnPoint	(	unsigned int	map_id,
		const std::string &	entity,
		const std::string &	function_name,
		unsigned int	address,
		int	x,
		int	y,
		int	triangle_id,
		int	angle
	)

virtual

Adds an spawn point.

If the spawn is new, a new record will be added to the spawn point database. If it was already there, update the record to add the origin.

Parameters

[in]	map_id	The target map ID.
[in]	entity	The entity that acts as the spawn point.
[in]	function_name	The spawn function name.
[in]	address

Parameters

[in]	x	X coordinate of the field at which to spawn.
[in]	y	Y coordinate of the field at which to spawn.
[in]	triangle_id	Triangle at which to spawn.
[in]	angle	Orientation at which to spawn.

std::string FieldScriptFormatter::GetMapName ( unsigned int map_id )

virtual

Retrieves the name of a map.

The name of a map is usually it's ID.

Parameters

[in] map_id The map ID.

std::string FieldScriptFormatter::GetSpawnPointName	(	unsigned int	map_id,
		const std::string &	entity,
		const std::string &	function_name,
		unsigned int	address
	)

virtual

Retrieves the name of a spawn point.

Parameters

[in]	map_id	The target map ID.
[in]	entity	The entity that acts as the spawn point.
[in]	function_name	The spawn function name.
[in]	address

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