Component responsible for displaying list of available factions and handling faction assign requests Fills m_wFactionList with m_sFactionButton widgets. More...

Inheritance diagram for SCR_FactionRequestUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

void	ShowAvailableFactions ()
	Display available playable factions in the list.

void	OnPlayerFactionAssigned (Faction assignedFaction)
	Callback when local player's faction is assigned.

void	RequestRandomFaction ()

SCR_FactionButton	GetFactionButton (int factionId)
	Get the faction button associated with a faction index.

ScriptInvoker	GetOnFactionRequested ()

Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
void	Update (float dt)

void	Unlock ()
	Unlock this component's buttons.

bool	IsEnabled ()

SCR_DeployButtonBase	GetFirstValidButton ()
	Gets first available button from the m_aButtons list.

void	SetExpanded (bool expanded)

bool	IsExpanded ()

void	SetListWidget (Widget list)
	Marks which widget should be used as a root for creating buttons.

Widget	GetListWidget ()
	Gets current list widget.

ScriptInvoker	GetOnButtonFocused ()

ScriptInvoker	GetOnMouseLeft ()

Protected Member Functions
void	OnPlayableFactionChanged (SCR_Faction faction, bool playable)
	Callback when playable factions are changed.

void	UpdateFactionButtons (Faction faction, int newCount)
	Update all available faction buttons.

void	OnButtonFocused (Widget w)
	Callback when button is focused.

void	RequestPlayerFaction (SCR_FactionButton factionBtn)
	Sends a request to assign a faction.

void	OnButtonClicked (SCR_FactionButton factionBtn)
	Callback when player clicks the faction button.

void	OnFactionDialogConfirm (SCR_PersistentFactionDialog dialog)
	Callback when player closes the persistent faction dialog.

Protected Member Functions inherited from SCR_DeployRequestUIBaseComponent
void	Lock (SCR_DeployButtonBase btn)
	Lock this component's buttons from processing any further requests. Unlock() should be called once you receive a response.

void	ToggleCollapsed ()

void	OnListExpand (SCR_DeployRequestUIBaseComponent component, bool expanded)

void	OnMouseLeft ()

Protected Attributes
string	m_sFactionList

Widget	m_wFactionList

string	m_sNoFactions

Widget	m_wNoFactions

ResourceName	m_sFactionButton

SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp

SCR_FactionManager	m_FactionManager

ref ScriptInvoker< SCR_PlayerFactionAffiliationComponent, int, bool >	m_OnFactionRequested

Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
string	m_sExpandButton

Widget	m_wExpandButton

string	m_sExpandButtonName

TextWidget	m_wExpandButtonName

string	m_sExpandButtonNameFreq

TextWidget	m_wExpandButtonNameFreq

string	m_sExpandButtonIcon

ImageWidget	m_wExpandButtonIcon

bool	m_bUseListFromButton

bool	m_bEnabled = true

bool	m_bLocked = false

ref array< SCR_DeployButtonBase >	m_aButtons = {}

Widget	m_wRoot

ref ScriptInvoker	m_OnButtonFocused = new ScriptInvoker()

ref ScriptInvoker	m_OnMouseLeft = new ScriptInvoker()

Additional Inherited Members
Static Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
static ScriptInvoker	GetOnListCollapse ()

Static Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
static ref ScriptInvoker< SCR_DeployRequestUIBaseComponent, bool >	s_OnListExpand

Detailed Description

Component responsible for displaying list of available factions and handling faction assign requests Fills m_wFactionList with m_sFactionButton widgets.

Member Function Documentation

◆ GetFactionButton()

SCR_FactionButton SCR_FactionRequestUIComponent.GetFactionButton ( int factionId )

Get the faction button associated with a faction index.

Returns: faction button

◆ GetOnFactionRequested()

ScriptInvoker SCR_FactionRequestUIComponent.GetOnFactionRequested ( )

◆ HandlerAttached()

override void SCR_FactionRequestUIComponent.HandlerAttached ( Widget w )

Implements SCR_DeployRequestUIBaseComponent.

◆ OnButtonClicked()

void SCR_FactionRequestUIComponent.OnButtonClicked ( SCR_FactionButton factionBtn )

protected

Callback when player clicks the faction button.

◆ OnButtonFocused()

void SCR_FactionRequestUIComponent.OnButtonFocused ( Widget w )

protected

Callback when button is focused.

◆ OnFactionDialogConfirm()

void SCR_FactionRequestUIComponent.OnFactionDialogConfirm ( SCR_PersistentFactionDialog dialog )

protected

Callback when player closes the persistent faction dialog.

◆ OnPlayableFactionChanged()

void SCR_FactionRequestUIComponent.OnPlayableFactionChanged	(	SCR_Faction	faction,
		bool	playable )

protected

Callback when playable factions are changed.

◆ OnPlayerFactionAssigned()

void SCR_FactionRequestUIComponent.OnPlayerFactionAssigned ( Faction assignedFaction )

Callback when local player's faction is assigned.

◆ RequestPlayerFaction()

void SCR_FactionRequestUIComponent.RequestPlayerFaction ( SCR_FactionButton factionBtn )

protected

Sends a request to assign a faction.

◆ RequestRandomFaction()

void SCR_FactionRequestUIComponent.RequestRandomFaction ( )

◆ ShowAvailableFactions()

void SCR_FactionRequestUIComponent.ShowAvailableFactions ( )

Display available playable factions in the list.

◆ UpdateFactionButtons()

void SCR_FactionRequestUIComponent.UpdateFactionButtons	(	Faction	faction,
		int	newCount )

protected

Update all available faction buttons.

Member Data Documentation

◆ m_FactionManager

SCR_FactionManager SCR_FactionRequestUIComponent.m_FactionManager

protected

◆ m_OnFactionRequested

ref ScriptInvoker<SCR_PlayerFactionAffiliationComponent, int, bool> SCR_FactionRequestUIComponent.m_OnFactionRequested

protected

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_FactionRequestUIComponent.m_PlyFactionAffilComp

protected

◆ m_sFactionButton

ResourceName SCR_FactionRequestUIComponent.m_sFactionButton

protected

◆ m_sFactionList

string SCR_FactionRequestUIComponent.m_sFactionList

protected

◆ m_sNoFactions

string SCR_FactionRequestUIComponent.m_sNoFactions

protected

◆ m_wFactionList

Widget SCR_FactionRequestUIComponent.m_wFactionList

protected

◆ m_wNoFactions

Widget SCR_FactionRequestUIComponent.m_wNoFactions

protected

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

Game/UI/Menu/DeployMenu/SCR_FactionRequestUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetFactionButton()

◆ GetOnFactionRequested()

◆ HandlerAttached()

◆ OnButtonClicked()

◆ OnButtonFocused()

◆ OnFactionDialogConfirm()

◆ OnPlayableFactionChanged()

◆ OnPlayerFactionAssigned()

◆ RequestPlayerFaction()

◆ RequestRandomFaction()

◆ ShowAvailableFactions()

◆ UpdateFactionButtons()

Member Data Documentation

◆ m_FactionManager

◆ m_OnFactionRequested

◆ m_PlyFactionAffilComp

◆ m_sFactionButton

◆ m_sFactionList

◆ m_sNoFactions

◆ m_wFactionList

◆ m_wNoFactions