SCR_HUDLayout Class Reference

Protected 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)
SCR_HUDGroupUIComponent	GetGroupComponent (string groupName)
int	GetAllGroupComponents (notnull out array< SCR_HUDGroupUIComponent > groupComponents)
int	GetAllSlotComponents (notnull out array< SCR_HUDSlotUIComponent > slotComponents)
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

Detailed Description

Definition at line 2 of file SCR_HUDLayout.c.

Member Function Documentation

AddHudElement()

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

inlineprotected

Definition at line 112 of file SCR_HUDLayout.c.

FindSlotComponent()

SCR_HUDSlotUIComponent SCR_HUDLayout::FindSlotComponent ( string slotName )

inlineprotected

Definition at line 220 of file SCR_HUDLayout.c.

FindWidgetByName()

Widget SCR_HUDLayout::FindWidgetByName ( string widgetName )

inlineprotected

Definition at line 230 of file SCR_HUDLayout.c.

GetAllGroupComponents()

int SCR_HUDLayout::GetAllGroupComponents ( notnull out array< SCR_HUDGroupUIComponent > groupComponents )

inlineprotected

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

Parameters

groupComponents

the array to be filled.

Definition at line 177 of file SCR_HUDLayout.c.

GetAllSlotComponents()

int SCR_HUDLayout::GetAllSlotComponents ( notnull out array< SCR_HUDSlotUIComponent > slotComponents )

inlineprotected

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

Parameters

slotComponents

the array to be filled.

Definition at line 195 of file SCR_HUDLayout.c.

GetGroupComponent()

SCR_HUDGroupUIComponent SCR_HUDLayout::GetGroupComponent ( string groupName )

inlineprotected

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.

Definition at line 164 of file SCR_HUDLayout.c.

GetGroupWidgetByName()

Widget SCR_HUDLayout::GetGroupWidgetByName ( string groupName )

inlineprotected

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

Parameters

groupName

Name of the group to look for.

Definition at line 151 of file SCR_HUDLayout.c.

GetHUDElements()

int SCR_HUDLayout::GetHUDElements ( notnull out array< SCR_HUDElement > hudElements )

inlineprotected

Definition at line 45 of file SCR_HUDLayout.c.

GetIdentifier()

string SCR_HUDLayout::GetIdentifier ( )

inlineprotected

Definition at line 56 of file SCR_HUDLayout.c.

GetLayout()

ResourceName SCR_HUDLayout::GetLayout ( )

inlineprotected

Definition at line 62 of file SCR_HUDLayout.c.

GetRootWidget()

Widget SCR_HUDLayout::GetRootWidget ( )

inlineprotected

Definition at line 68 of file SCR_HUDLayout.c.

RemoveHudElement()

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

inlineprotected

Definition at line 133 of file SCR_HUDLayout.c.

ResizeLayout()

void SCR_HUDLayout::ResizeLayout ( )

inlineprotected

Definition at line 100 of file SCR_HUDLayout.c.

SetIdentifier()

void SCR_HUDLayout::SetIdentifier ( string id )

inlineprotected

Definition at line 16 of file SCR_HUDLayout.c.

SetRootWidget()

void SCR_HUDLayout::SetRootWidget ( notnull Widget widget )

inlineprotected

Definition at line 74 of file SCR_HUDLayout.c.

Member Data Documentation

m_aAllGroups

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

protected

Definition at line 4 of file SCR_HUDLayout.c.

m_aElements

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

protected

Definition at line 5 of file SCR_HUDLayout.c.

m_sIdentifier

string SCR_HUDLayout::m_sIdentifier

protected

Definition at line 8 of file SCR_HUDLayout.c.

m_sLayout

ResourceName SCR_HUDLayout::m_sLayout

protected

Definition at line 11 of file SCR_HUDLayout.c.

m_wRoot

Widget SCR_HUDLayout::m_wRoot

protected

Definition at line 13 of file SCR_HUDLayout.c.

---

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

• scripts/Game/UI/HUD/SCR_HUDLayout.c