Handles the script gateway colection. More...

#include <FieldDataInstaller.h>

Inheritance diagram for FF7FieldScriptGatewayCollector:

[legend]

Collaboration diagram for FF7FieldScriptGatewayCollector:

[legend]

Public Member Functions
	FF7FieldScriptGatewayCollector (const std::string &field_name, const std::vector< std::string > &field_id_to_name_lookup, FieldSpawnPointsMap &spawn_points, size_t this_field_id)
	Cosntructor. More...

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

Public Member Functions inherited from BaseFF7FieldScriptFormatter
	BaseFF7FieldScriptFormatter (const std::string &field_name, const std::vector< std::string > &field_id_to_name_lookup, FieldSpawnPointsMap &spawn_points)
	Constructor. More...

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

virtual std::string	GetMapName (unsigned int map_id) override
	Retrieves a map name from it's ID. More...

virtual std::string	GetFriendlyVarName (unsigned int bank, unsigned int addr) override
	Retrieves a user friendly variable name. More...

virtual std::string	GetFriendlyEntityName (const std::string &entity) override
	Retrieves a user friendly entity name. More...

virtual std::string	GetFriendlyCharName (int char_id) override
	Retrieves a user friendly character name. More...

virtual std::string	GetFriendlyFunctionName (const std::string &entity, const std::string &function_name) override
	Retrieves a user friendly function name. More...

virtual std::string	GetFunctionComment (const std::string &entity, const std::string &function_name) override
	Retrieves the header comment for a function in an entity. More...

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...

Private Attributes
size_t	field_id_
	The field map ID. More...

Additional Inherited Members
Protected Attributes inherited from BaseFF7FieldScriptFormatter
std::string	field_name_
	The field name. More...

FieldSpawnPointsMap &	spawn_points_
	The list of spawn points. More...

const std::vector< std::string > &	field_id_to_name_lookup_
	Look up table relatingfield IDs and names. More...

Detailed Description

Handles the script gateway colection.

Constructor & Destructor Documentation

◆ FF7FieldScriptGatewayCollector()

FF7FieldScriptGatewayCollector::FF7FieldScriptGatewayCollector	(	const std::string &	field_name,
		const std::vector< std::string > &	field_id_to_name_lookup,
		FieldSpawnPointsMap &	spawn_points,
		size_t	this_field_id
	)

inline

Cosntructor.

Member Function Documentation

◆ AddSpawnPoint()

virtual void FF7FieldScriptGatewayCollector::AddSpawnPoint	(	unsigned int	map_id,
		const std::string &	entity,
		const std::string &	function_name,
		unsigned int	address,
		int	x,
		int	y,
		int	z,
		int	angle
	)

inlineoverridevirtual

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

Todo:: Understand and document.

Parameters

[in]	x	X coordinate of the field target at which to spawn.
[in]	y	Y coordinate of the field target at which to spawn.
[in]	z	Z coordinate of the field target at which to spawn.
[in]	angle	Orientation at which to spawn.

Reimplemented from FieldScriptFormatter.

Member Data Documentation

◆ field_id_

size_t FF7FieldScriptGatewayCollector::field_id_

private

The field map ID.

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

src/installer/FieldDataInstaller.h

Public Member Functions

Private Attributes