SCR_HUDLayout Interface Reference

Public Member Functions
void	SetIdentifier (string id)
int	GetHUDElements (notnull out array< SCR_HUDElement > hudElements)
string	GetIdentifier ()
ResourceName	GetLayout ()
Widget	GetRootWidget ()
void	SetRootWidget (notnull Widget widget)
void	ResizeLayout ()
void	AddHudElement (notnull SCR_HUDElement element, bool replaceParent=false)
void	RemoveHudElement (notnull SCR_HUDElement element, bool replaceParent=false)
Widget	GetGroupWidgetByName (string groupName)
	Searches for and returns a Group Widget with the given name.
SCR_HUDGroupUIComponent	GetGroupComponent (string groupName)
	Searches for and returns the Component responsible for managing and controlling a Group with the given name.
int	GetAllGroupComponents (notnull out array< SCR_HUDGroupUIComponent > groupComponents)
	Fills the provided array with all the GroupComponents this HUD Layout owns.
int	GetAllSlotComponents (notnull out array< SCR_HUDSlotUIComponent > slotComponents)
	Fills the provided array with all the Slots that exist within this HUD Layout.
SCR_HUDSlotUIComponent	FindSlotComponent (string slotName)
Widget	FindWidgetByName (string widgetName)

Protected Attributes
ref array< ref Widget >	m_aAllGroups = {}
ref array< ref SCR_HUDElement >	m_aElements = {}
string	m_sIdentifier
ResourceName	m_sLayout
Widget	m_wRoot

Member Function Documentation

AddHudElement()

void SCR_HUDLayout.AddHudElement	(	notnull SCR_HUDElement	element,
		bool	replaceParent = false
	)

FindSlotComponent()

SCR_HUDSlotUIComponent SCR_HUDLayout.FindSlotComponent

(

string

slotName

)

FindWidgetByName()

Widget SCR_HUDLayout.FindWidgetByName

(

string

widgetName

)

GetAllGroupComponents()

int SCR_HUDLayout.GetAllGroupComponents

(

notnull out array< SCR_HUDGroupUIComponent >

groupComponents

)

Fills the provided array with all the GroupComponents this HUD Layout owns.

Parameters

groupComponents

the array to be filled.

GetAllSlotComponents()

int SCR_HUDLayout.GetAllSlotComponents

(

notnull out array< SCR_HUDSlotUIComponent >

slotComponents

)

Fills the provided array with all the Slots that exist within this HUD Layout.

Parameters

slotComponents

the array to be filled.

GetGroupComponent()

SCR_HUDGroupUIComponent SCR_HUDLayout.GetGroupComponent

(

string

groupName

)

Searches for and returns the Component responsible for managing and controlling a Group with the given name.

Parameters

groupName

Name of the group to look for.

GetGroupWidgetByName()

Widget SCR_HUDLayout.GetGroupWidgetByName

(

string

groupName

)

Searches for and returns a Group Widget with the given name.

Parameters

groupName

Name of the group to look for.

GetHUDElements()

int SCR_HUDLayout.GetHUDElements

(

notnull out array< SCR_HUDElement >

hudElements

)

GetIdentifier()

string SCR_HUDLayout.GetIdentifier

(

)

GetLayout()

ResourceName SCR_HUDLayout.GetLayout

(

)

GetRootWidget()

Widget SCR_HUDLayout.GetRootWidget

(

)

RemoveHudElement()

void SCR_HUDLayout.RemoveHudElement	(	notnull SCR_HUDElement	element,
		bool	replaceParent = false
	)

ResizeLayout()

void SCR_HUDLayout.ResizeLayout

(

)

SetIdentifier()

void SCR_HUDLayout.SetIdentifier

(

string

id

)

SetRootWidget()

void SCR_HUDLayout.SetRootWidget

(

notnull Widget

widget

)

Member Data Documentation

m_aAllGroups

ref array<ref Widget> SCR_HUDLayout.m_aAllGroups = {}

protected

m_aElements

ref array<ref SCR_HUDElement> SCR_HUDLayout.m_aElements = {}

protected

m_sIdentifier

string SCR_HUDLayout.m_sIdentifier

protected

m_sLayout

ResourceName SCR_HUDLayout.m_sLayout

protected

m_wRoot

Widget SCR_HUDLayout.m_wRoot

protected

---

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

• Game/UI/HUD/SCR_HUDLayout.c