SCR_HUDManagerLayoutHandler Class Reference

Inheritance diagram for SCR_HUDManagerLayoutHandler:

Protected Member Functions
void	AddHUDLayout (notnull SCR_HUDLayout layout)
void	RemoveHUDLayout (notnull SCR_HUDLayout layout)
array< ref SCR_HUDLayout >	GetAllHUDLayouts ()
OnLayoutChange	GetOnLayoutChange ()
SCR_HUDLayout	GetActiveLayout ()
int	GetAllHudElements (notnull out array< SCR_HUDElement > hudElements)
array< string >	GetAllIdentifiers ()
Widget	GetGroupByName (string groupName)
SCR_HUDGroupUIComponent	GetGroupComponent (string groupName)
SCR_HUDSlotUIComponent	GetSlotComponentByName (string slotName)
SCR_HUDSlotUIComponent	FindSlotComponentFromAnyLayout (string slotName, out SCR_HUDLayout foundLayout=null)
Widget	FindWidgetByName (string widgetName)
Widget	FindWidgetByNameFromAnyLayout (string widgetName, out SCR_HUDLayout foundLayout=null)
SCR_HUDLayout	FindHUDLayout (string layoutIdentifier)
void	InitializeHUDLayouts ()
void	ChangeActiveHUDLayout (string layoutIdentifier=string.Empty)
void	SetLayoutEnabled (string layoutIdentifier, bool isEnabled)
void	StartMainLayout ()
override void	OnInit (notnull SCR_HUDManagerComponent owner)
override void	OnUpdate (notnull SCR_HUDManagerComponent owner)
ScriptInvokerVoid	GetOnMainLayoutInitialize ()
void	OnEditorOpen ()
	When editor gets opened save the editor HudLayout.
void	OnEditorClose ()
	When editor gets closed allow the change back to the main layout again.
void	OnEditorChange ()
	when chaning Editor modes store the HudLayout of the newly opened mode

Protected Attributes
ref array< ref SCR_HUDLayout >	m_aHUDLayouts
string	m_sMainLayout
bool	m_bIsEditorOpen
SCR_HUDLayout	m_ActiveLayout
SCR_HUDLayout	m_SavedEditorLayout
ref OnLayoutChange	m_OnLayoutChange
ref ScriptInvokerVoid	m_OnMainLayoutInitialize

Detailed Description

Definition at line 7 of file SCR_HUDManagerLayoutHandler.c.

Member Function Documentation

AddHUDLayout()

void SCR_HUDManagerLayoutHandler::AddHUDLayout ( notnull SCR_HUDLayout layout )

inlineprotected

Definition at line 24 of file SCR_HUDManagerLayoutHandler.c.

ChangeActiveHUDLayout()

void SCR_HUDManagerLayoutHandler::ChangeActiveHUDLayout ( string layoutIdentifier = string.Empty )

inlineprotected

Definition at line 222 of file SCR_HUDManagerLayoutHandler.c.

FindHUDLayout()

SCR_HUDLayout SCR_HUDManagerLayoutHandler::FindHUDLayout ( string layoutIdentifier )

inlineprotected

Definition at line 186 of file SCR_HUDManagerLayoutHandler.c.

FindSlotComponentFromAnyLayout()

SCR_HUDSlotUIComponent SCR_HUDManagerLayoutHandler::FindSlotComponentFromAnyLayout ( string slotName, out SCR_HUDLayout foundLayout = null )

inlineprotected

Definition at line 129 of file SCR_HUDManagerLayoutHandler.c.

FindWidgetByName()

Widget SCR_HUDManagerLayoutHandler::FindWidgetByName ( string widgetName )

inlineprotected

Searches for and returns a widget with the specified name from the Active Layout.

Parameters

widgetName

Name of the slot to look for.

Definition at line 154 of file SCR_HUDManagerLayoutHandler.c.

FindWidgetByNameFromAnyLayout()

Widget SCR_HUDManagerLayoutHandler::FindWidgetByNameFromAnyLayout ( string widgetName, out SCR_HUDLayout foundLayout = null )

inlineprotected

Definition at line 163 of file SCR_HUDManagerLayoutHandler.c.

GetActiveLayout()

SCR_HUDLayout SCR_HUDManagerLayoutHandler::GetActiveLayout ( )

inlineprotected

Definition at line 59 of file SCR_HUDManagerLayoutHandler.c.

GetAllHudElements()

int SCR_HUDManagerLayoutHandler::GetAllHudElements ( notnull out array< SCR_HUDElement > hudElements )

inlineprotected

Definition at line 65 of file SCR_HUDManagerLayoutHandler.c.

GetAllHUDLayouts()

array< ref SCR_HUDLayout > SCR_HUDManagerLayoutHandler::GetAllHUDLayouts ( )

inlineprotected

Definition at line 37 of file SCR_HUDManagerLayoutHandler.c.

GetAllIdentifiers()

array< string > SCR_HUDManagerLayoutHandler::GetAllIdentifiers ( )

inlineprotected

Definition at line 78 of file SCR_HUDManagerLayoutHandler.c.

GetGroupByName()

Widget SCR_HUDManagerLayoutHandler::GetGroupByName ( 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 94 of file SCR_HUDManagerLayoutHandler.c.

GetGroupComponent()

SCR_HUDGroupUIComponent SCR_HUDManagerLayoutHandler::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 107 of file SCR_HUDManagerLayoutHandler.c.

GetOnLayoutChange()

OnLayoutChange SCR_HUDManagerLayoutHandler::GetOnLayoutChange ( )

inlineprotected

Definition at line 50 of file SCR_HUDManagerLayoutHandler.c.

GetOnMainLayoutInitialize()

ScriptInvokerVoid SCR_HUDManagerLayoutHandler::GetOnMainLayoutInitialize ( )

inlineprotected

Definition at line 348 of file SCR_HUDManagerLayoutHandler.c.

GetSlotComponentByName()

SCR_HUDSlotUIComponent SCR_HUDManagerLayoutHandler::GetSlotComponentByName ( string slotName )

inlineprotected

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

Parameters

slotName

Name of the slot to look for.

Definition at line 120 of file SCR_HUDManagerLayoutHandler.c.

InitializeHUDLayouts()

void SCR_HUDManagerLayoutHandler::InitializeHUDLayouts ( )

inlineprotected

Definition at line 198 of file SCR_HUDManagerLayoutHandler.c.

OnEditorChange()

void SCR_HUDManagerLayoutHandler::OnEditorChange ( )

inlineprotected

when chaning Editor modes store the HudLayout of the newly opened mode

Definition at line 374 of file SCR_HUDManagerLayoutHandler.c.

OnEditorClose()

void SCR_HUDManagerLayoutHandler::OnEditorClose ( )

inlineprotected

When editor gets closed allow the change back to the main layout again.

Definition at line 366 of file SCR_HUDManagerLayoutHandler.c.

OnEditorOpen()

void SCR_HUDManagerLayoutHandler::OnEditorOpen ( )

inlineprotected

When editor gets opened save the editor HudLayout.

Definition at line 358 of file SCR_HUDManagerLayoutHandler.c.

OnInit()

override void SCR_HUDManagerLayoutHandler::OnInit ( notnull SCR_HUDManagerComponent owner )

inlineprotected

Definition at line 334 of file SCR_HUDManagerLayoutHandler.c.

OnUpdate()

override void SCR_HUDManagerLayoutHandler::OnUpdate ( notnull SCR_HUDManagerComponent owner )

inlineprotected

Definition at line 342 of file SCR_HUDManagerLayoutHandler.c.

RemoveHUDLayout()

void SCR_HUDManagerLayoutHandler::RemoveHUDLayout ( notnull SCR_HUDLayout layout )

inlineprotected

Definition at line 30 of file SCR_HUDManagerLayoutHandler.c.

SetLayoutEnabled()

void SCR_HUDManagerLayoutHandler::SetLayoutEnabled ( string layoutIdentifier, bool isEnabled )

inlineprotected

Definition at line 297 of file SCR_HUDManagerLayoutHandler.c.

StartMainLayout()

void SCR_HUDManagerLayoutHandler::StartMainLayout ( )

inlineprotected

Definition at line 312 of file SCR_HUDManagerLayoutHandler.c.

Member Data Documentation

m_ActiveLayout

SCR_HUDLayout SCR_HUDManagerLayoutHandler::m_ActiveLayout

protected

Definition at line 17 of file SCR_HUDManagerLayoutHandler.c.

m_aHUDLayouts

ref array<ref SCR_HUDLayout> SCR_HUDManagerLayoutHandler::m_aHUDLayouts

protected

Definition at line 10 of file SCR_HUDManagerLayoutHandler.c.

m_bIsEditorOpen

bool SCR_HUDManagerLayoutHandler::m_bIsEditorOpen

protected

Definition at line 15 of file SCR_HUDManagerLayoutHandler.c.

m_OnLayoutChange

ref OnLayoutChange SCR_HUDManagerLayoutHandler::m_OnLayoutChange

protected

Definition at line 19 of file SCR_HUDManagerLayoutHandler.c.

m_OnMainLayoutInitialize

ref ScriptInvokerVoid SCR_HUDManagerLayoutHandler::m_OnMainLayoutInitialize

protected

Definition at line 21 of file SCR_HUDManagerLayoutHandler.c.

m_SavedEditorLayout

SCR_HUDLayout SCR_HUDManagerLayoutHandler::m_SavedEditorLayout

protected

Definition at line 18 of file SCR_HUDManagerLayoutHandler.c.

m_sMainLayout

string SCR_HUDManagerLayoutHandler::m_sMainLayout

protected

Definition at line 13 of file SCR_HUDManagerLayoutHandler.c.

---

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

• scripts/Game/UI/HUD/Handlers/HudManager/SCR_HUDManagerLayoutHandler.c