SCR_DelegateFactionManagerComponent Interface Reference

Manager of faction delegates - entities representing available factions. More...

Inheritance diagram for SCR_DelegateFactionManagerComponent:

Public Member Functions
int	GetFactionDelegates (notnull out map< Faction, SCR_EditableFactionComponent > outDelegates)
	Get all faction delegates.
int	GetSortedFactionDelegates (notnull out SCR_SortedArray< SCR_EditableFactionComponent > outDelegates)
	Get all faction delegates, in the same order as factions are defined in factions manager.
int	GetFactionDelegateCount ()
	Get number of faction delegates.
int	GetPlayableFactionDelegates (notnull out map< Faction, SCR_EditableFactionComponent > outDelegates)
	Get number of enabled faction delegates.
int	GetPlayableFactionDelegateCount ()
	Get number of enabled faction delegates.
SCR_EditableFactionComponent	GetFactionDelegate (Faction faction)
	Get delegate of the given faction.
void	SetFactionDelegate (Faction faction, SCR_EditableFactionComponent delegate)
	Get delegate of the given faction.
override void	OnFactionsInit (array< Faction > factions)
	Method called on every machine when factions are initialised.
Public Member Functions inherited from SCR_BaseFactionManagerComponent
void	OnFactionsInit (array< Faction > factions)
	Method called on every machine when factions are initialised.
void	SCR_BaseFactionManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_DelegateFactionManagerComponent	GetInstance ()
	Get local instance of the component.

Protected Attributes
ResourceName	m_FactionDelegatePrefab
ref map< Faction, SCR_EditableFactionComponent >	m_FactionDelegates = new map<Faction, SCR_EditableFactionComponent>

Detailed Description

Manager of faction delegates - entities representing available factions.

Used so we can interact with them in the editor.

Member Function Documentation

GetFactionDelegate()

SCR_EditableFactionComponent SCR_DelegateFactionManagerComponent.GetFactionDelegate

(

Faction

faction

)

Get delegate of the given faction.

Parameters

faction

Requested faction

Returns

Delegate entity

GetFactionDelegateCount()

int SCR_DelegateFactionManagerComponent.GetFactionDelegateCount

(

)

Get number of faction delegates.

Returns

Number of faction delegates

GetFactionDelegates()

int SCR_DelegateFactionManagerComponent.GetFactionDelegates

(

notnull out map< Faction, SCR_EditableFactionComponent >

outDelegates

)

Get all faction delegates.

Parameters

outDelegates

map to be filled with factions and their delegate entities

Returns

Number of delegates

GetInstance()

static SCR_DelegateFactionManagerComponent SCR_DelegateFactionManagerComponent.GetInstance ( )

static

Get local instance of the component.

Returns

Component

GetPlayableFactionDelegateCount()

int SCR_DelegateFactionManagerComponent.GetPlayableFactionDelegateCount

(

)

Get number of enabled faction delegates.

Returns

Number of enabled faction delegates

GetPlayableFactionDelegates()

int SCR_DelegateFactionManagerComponent.GetPlayableFactionDelegates

(

notnull out map< Faction, SCR_EditableFactionComponent >

outDelegates

)

Get number of enabled faction delegates.

Returns

Number of enabled faction delegates

GetSortedFactionDelegates()

int SCR_DelegateFactionManagerComponent.GetSortedFactionDelegates

(

notnull out SCR_SortedArray< SCR_EditableFactionComponent >

outDelegates

)

Get all faction delegates, in the same order as factions are defined in factions manager.

Parameters

outDelegates

Sorted array to be filled with delegate entities

Returns

Number of delegates

OnFactionsInit()

override void SCR_DelegateFactionManagerComponent.OnFactionsInit

(

array< Faction >

factions

)

Method called on every machine when factions are initialised.

To be overloaded by inherited components.

Parameters

[in]

factions

Available factions

Implements SCR_BaseFactionManagerComponent.

SetFactionDelegate()

void SCR_DelegateFactionManagerComponent.SetFactionDelegate	(	Faction	faction,
		SCR_EditableFactionComponent	delegate
	)

Get delegate of the given faction.

Parameters

faction	Requested faction
delegate	Delegate entity

Member Data Documentation

m_FactionDelegatePrefab

ResourceName SCR_DelegateFactionManagerComponent.m_FactionDelegatePrefab

protected

m_FactionDelegates

ref map<Faction, SCR_EditableFactionComponent> SCR_DelegateFactionManagerComponent.m_FactionDelegates = new map<Faction, SCR_EditableFactionComponent>

protected

---

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

• Game/Editor/Components/SCR_DelegateFactionManagerComponent.c