SCR_FactionAliasComponent Interface Reference

Inheritance diagram for SCR_FactionAliasComponent:

Public Member Functions
override void	OnPostInit (IEntity owner)
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)
	Resolves input alias for a faction key, returning original input if no alias found.
override void	_WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)
	Initializes the facton alias component instance for Workbench object previews.

Static Public Member Functions
static SCR_FactionAliasComponent	GetFactionAliasComponentForWB ()
	Only use for object previews at WorkBench time.

Public Attributes
ref array< ref SCR_ScenarioFrameworkFactionAliasConfig >	m_aFactionAliases
ref map< FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig >	m_mAliasToFactionKeyMap = new map<FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig>()

Static Public Attributes
static SCR_FactionAliasComponent	m_FactionAliasComponentInstanceForWB

Member Function Documentation

_WB_OnInit()

override void SCR_FactionAliasComponent._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.

GetFactionAliasComponentForWB()

static SCR_FactionAliasComponent SCR_FactionAliasComponent.GetFactionAliasComponentForWB ( )

static

Only use for object previews at WorkBench time.

In game time, use GetGame().GetFactionManager().FindComponent(SCR_FactionAliasComponent)

Returns

Faction alias component for Worldbench object previews.

GetFactionAliasMap()

map< FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig > SCR_FactionAliasComponent.GetFactionAliasMap

(

)

Returns

a copy of the Faction alias map configuration.

InitAliasMap()

void SCR_FactionAliasComponent.InitAliasMap

(

)

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

OnPostInit()

override void SCR_FactionAliasComponent.OnPostInit

(

IEntity

owner

)

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

ResolveFactionAlias()

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

Member Data Documentation

m_aFactionAliases

ref array<ref SCR_ScenarioFrameworkFactionAliasConfig> SCR_FactionAliasComponent.m_aFactionAliases

m_FactionAliasComponentInstanceForWB

SCR_FactionAliasComponent SCR_FactionAliasComponent.m_FactionAliasComponentInstanceForWB

static

m_mAliasToFactionKeyMap

ref map<FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig> SCR_FactionAliasComponent.m_mAliasToFactionKeyMap = new map<FactionKey, ref SCR_ScenarioFrameworkFactionAliasConfig>()

---

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

• Game/GameMode/FactionManager/SCR_FactionAliasComponent.c