SCR_DeployRequestUIBaseComponent Interface Reference

Inheritance diagram for SCR_DeployRequestUIBaseComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
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 ()

Static Public Member Functions
static ScriptInvoker	GetOnListCollapse ()

Protected Member Functions
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_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()

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

Member Function Documentation

GetFirstValidButton()

SCR_DeployButtonBase SCR_DeployRequestUIBaseComponent.GetFirstValidButton

(

)

Gets first available button from the m_aButtons list.

Returns

button instance.

GetListWidget()

Widget SCR_DeployRequestUIBaseComponent.GetListWidget

(

)

Gets current list widget.

Returns

current list

GetOnButtonFocused()

ScriptInvoker SCR_DeployRequestUIBaseComponent.GetOnButtonFocused

(

)

GetOnListCollapse()

static ScriptInvoker SCR_DeployRequestUIBaseComponent.GetOnListCollapse ( )

static

GetOnMouseLeft()

ScriptInvoker SCR_DeployRequestUIBaseComponent.GetOnMouseLeft

(

)

HandlerAttached()

override void SCR_DeployRequestUIBaseComponent.HandlerAttached

(

Widget

w

)

Implemented in SCR_FactionRequestUIComponent, SCR_GroupRequestUIComponent, SCR_LoadoutRequestUIComponent, and SCR_SpawnPointRequestUIComponent.

IsEnabled()

bool SCR_DeployRequestUIBaseComponent.IsEnabled

(

)

IsExpanded()

bool SCR_DeployRequestUIBaseComponent.IsExpanded

(

)

Implemented in SCR_GroupRequestUIComponent, and SCR_LoadoutRequestUIComponent.

Lock()

void SCR_DeployRequestUIBaseComponent.Lock ( SCR_DeployButtonBase btn )

protected

Lock this component's buttons from processing any further requests. Unlock() should be called once you receive a response.

OnListExpand()

void SCR_DeployRequestUIBaseComponent.OnListExpand ( SCR_DeployRequestUIBaseComponent component, bool expanded )

protected

OnMouseLeft()

void SCR_DeployRequestUIBaseComponent.OnMouseLeft ( )

protected

SetExpanded()

void SCR_DeployRequestUIBaseComponent.SetExpanded

(

bool

expanded

)

Implemented in SCR_GroupRequestUIComponent, and SCR_LoadoutRequestUIComponent.

SetListWidget()

void SCR_DeployRequestUIBaseComponent.SetListWidget

(

Widget

list

)

Marks which widget should be used as a root for creating buttons.

Implemented in SCR_GroupRequestUIComponent, and SCR_LoadoutRequestUIComponent.

ToggleCollapsed()

void SCR_DeployRequestUIBaseComponent.ToggleCollapsed ( )

protected

Implemented in SCR_GroupRequestUIComponent, and SCR_LoadoutRequestUIComponent.

Unlock()

void SCR_DeployRequestUIBaseComponent.Unlock

(

)

Unlock this component's buttons.

Update()

void SCR_DeployRequestUIBaseComponent.Update

(

float

dt

)

Member Data Documentation

m_aButtons

ref array<SCR_DeployButtonBase> SCR_DeployRequestUIBaseComponent.m_aButtons = {}

protected

m_bEnabled

bool SCR_DeployRequestUIBaseComponent.m_bEnabled = true

protected

m_bLocked

bool SCR_DeployRequestUIBaseComponent.m_bLocked = false

protected

m_bUseListFromButton

bool SCR_DeployRequestUIBaseComponent.m_bUseListFromButton

protected

m_OnButtonFocused

ref ScriptInvoker SCR_DeployRequestUIBaseComponent.m_OnButtonFocused = new ScriptInvoker()

protected

m_OnMouseLeft

ref ScriptInvoker SCR_DeployRequestUIBaseComponent.m_OnMouseLeft = new ScriptInvoker()

protected

m_sExpandButton

string SCR_DeployRequestUIBaseComponent.m_sExpandButton

protected

m_sExpandButtonIcon

string SCR_DeployRequestUIBaseComponent.m_sExpandButtonIcon

protected

m_sExpandButtonName

string SCR_DeployRequestUIBaseComponent.m_sExpandButtonName

protected

m_sExpandButtonNameFreq

string SCR_DeployRequestUIBaseComponent.m_sExpandButtonNameFreq

protected

m_wExpandButton

Widget SCR_DeployRequestUIBaseComponent.m_wExpandButton

protected

m_wExpandButtonIcon

ImageWidget SCR_DeployRequestUIBaseComponent.m_wExpandButtonIcon

protected

m_wExpandButtonName

TextWidget SCR_DeployRequestUIBaseComponent.m_wExpandButtonName

protected

m_wExpandButtonNameFreq

TextWidget SCR_DeployRequestUIBaseComponent.m_wExpandButtonNameFreq

protected

m_wRoot

Widget SCR_DeployRequestUIBaseComponent.m_wRoot

protected

s_OnListExpand

ref ScriptInvoker<SCR_DeployRequestUIBaseComponent, bool> SCR_DeployRequestUIBaseComponent.s_OnListExpand

staticprotected

---

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

• Game/UI/Menu/DeployMenu/SCR_DeployRequestUIBaseComponent.c