SCR_DelegateFactionManagerComponent Class Reference

Inheritance diagram for SCR_DelegateFactionManagerComponent:

Protected Member Functions
int	GetFactionDelegates (notnull out map< Faction, SCR_EditableFactionComponent > outDelegates)
int	GetSortedFactionDelegates (notnull out SCR_SortedArray< SCR_EditableFactionComponent > outDelegates)
int	GetFactionDelegateCount ()
int	GetPlayableFactionDelegates (notnull out map< Faction, SCR_EditableFactionComponent > outDelegates)
int	GetPlayableFactionDelegateCount ()
SCR_EditableFactionComponent	GetFactionDelegate (Faction faction)
void	SetFactionDelegate (Faction faction, SCR_EditableFactionComponent delegate)
override void	OnFactionsInit (array< Faction > factions)

Static Protected Member Functions
static SCR_DelegateFactionManagerComponent	GetInstance ()

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.

Definition at line 15 of file SCR_DelegateFactionManagerComponent.c.

Member Function Documentation

GetFactionDelegate()

SCR_EditableFactionComponent SCR_DelegateFactionManagerComponent::GetFactionDelegate ( Faction faction )

inlineprotected

Get delegate of the given faction.

Parameters

faction

Requested faction

Returns

Delegate entity

Definition at line 118 of file SCR_DelegateFactionManagerComponent.c.

GetFactionDelegateCount()

int SCR_DelegateFactionManagerComponent::GetFactionDelegateCount ( )

inlineprotected

Get number of faction delegates.

Returns

Number of faction delegates

Definition at line 75 of file SCR_DelegateFactionManagerComponent.c.

GetFactionDelegates()

int SCR_DelegateFactionManagerComponent::GetFactionDelegates ( notnull out map< Faction, SCR_EditableFactionComponent > outDelegates )

inlineprotected

Get all faction delegates.

Parameters

outDelegates

map to be filled with factions and their delegate entities

Returns

Number of delegates

Definition at line 40 of file SCR_DelegateFactionManagerComponent.c.

GetInstance()

SCR_DelegateFactionManagerComponent SCR_DelegateFactionManagerComponent::GetInstance ( )

inlinestaticprotected

Get local instance of the component.

Returns

Component

Definition at line 27 of file SCR_DelegateFactionManagerComponent.c.

GetPlayableFactionDelegateCount()

int SCR_DelegateFactionManagerComponent::GetPlayableFactionDelegateCount ( )

inlineprotected

Get number of enabled faction delegates.

Returns

Number of enabled faction delegates

Definition at line 100 of file SCR_DelegateFactionManagerComponent.c.

GetPlayableFactionDelegates()

int SCR_DelegateFactionManagerComponent::GetPlayableFactionDelegates ( notnull out map< Faction, SCR_EditableFactionComponent > outDelegates )

inlineprotected

Get number of enabled faction delegates.

Returns

Number of enabled faction delegates

Definition at line 83 of file SCR_DelegateFactionManagerComponent.c.

GetSortedFactionDelegates()

int SCR_DelegateFactionManagerComponent::GetSortedFactionDelegates ( notnull out SCR_SortedArray< SCR_EditableFactionComponent > outDelegates )

inlineprotected

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

Definition at line 54 of file SCR_DelegateFactionManagerComponent.c.

OnFactionsInit()

override void SCR_DelegateFactionManagerComponent::OnFactionsInit ( array< Faction > factions )

inlineprotected

Definition at line 132 of file SCR_DelegateFactionManagerComponent.c.

SetFactionDelegate()

void SCR_DelegateFactionManagerComponent::SetFactionDelegate ( Faction faction, SCR_EditableFactionComponent delegate )

inlineprotected

Get delegate of the given faction.

Parameters

faction	Requested faction
delegate	Delegate entity

Definition at line 127 of file SCR_DelegateFactionManagerComponent.c.

Member Data Documentation

m_FactionDelegatePrefab

ResourceName SCR_DelegateFactionManagerComponent::m_FactionDelegatePrefab

protected

Definition at line 18 of file SCR_DelegateFactionManagerComponent.c.

m_FactionDelegates

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

protected

Definition at line 20 of file SCR_DelegateFactionManagerComponent.c.

---

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

• scripts/Game/Editor/Components/SCR_DelegateFactionManagerComponent.c