SCR_FactionAliasComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_FactionAliasComponentClass

Functions
SCR_FactionAliasComponentClass ScriptComponentClass	Attribute (desc:"Global faction aliases to allow quick switching of factions for slots.")
void	InitAliasMap ()
	Initializes alias map from both component instance and overriden by the mission header.
map< FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig >	GetFactionAliasMap ()
FactionKey	ResolveFactionAlias (FactionKey inputFactionKey)
array< string >	GetAllFactionKeyAliases (FactionKey inputFactionKey)
override void	_WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)

Function Documentation

_WB_OnInit()

override void _WB_OnInit	(	IEntity	owner,
		inout vector	mat[4],
		IEntitySource	src )

Initializes the facton alias component instance for Workbench object previews.

Parameters

[in]	owner	The owner represents the entity that initializes the script.
[in,out]	mat	Mat is a 4x4 matrix representing the world space transformation for the entity.
[in]	src	Source entity providing initialization data for the component.

Definition at line 93 of file SCR_FactionAliasComponent.c.

Attribute()

SCR_FactionAliasComponentClass ScriptComponentClass Attribute

(

desc:"Global faction aliases to allow quick switching of factions for slots."

)

Parameters

[in]

owner

The owner represents the entity that initiated the OnPostInit event, which is being passed as an argument for this method to perform

Definition at line 1 of file SCR_FactionAliasComponent.c.

GetAllFactionKeyAliases()

array< string > GetAllFactionKeyAliases

(

FactionKey

inputFactionKey

)

Definition at line 74 of file SCR_FactionAliasComponent.c.

GetFactionAliasMap()

map< FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig > GetFactionAliasMap

(

)

Returns

a copy of the Faction alias map configuration.

Definition at line 55 of file SCR_FactionAliasComponent.c.

InitAliasMap()

void InitAliasMap

(

)

Initializes alias map from both component instance and overriden by the mission header.

Definition at line 31 of file SCR_FactionAliasComponent.c.

ResolveFactionAlias()

FactionKey ResolveFactionAlias

(

FactionKey

inputFactionKey

)

Resolves input alias for a faction key, returning original input if no alias found.

Parameters

[in]

inputFactionKey

Resolves alias for input faction key.

Returns

the alias for the input facton key if it exists, otherwise returns the input facton key itself.

Definition at line 64 of file SCR_FactionAliasComponent.c.