SCR_HUDManagerLayoutHandler Interface Reference

Inheritance diagram for SCR_HUDManagerLayoutHandler:

Public 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)
	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.
SCR_HUDSlotUIComponent	GetSlotComponentByName (string slotName)
	Searches for and returns the Component responsible for managing and controlling a Slot with the given name.
SCR_HUDSlotUIComponent	FindSlotComponentFromAnyLayout (string slotName, out SCR_HUDLayout foundLayout=null)
Widget	FindWidgetByName (string widgetName)
	Searches for and returns a widget with the specified name from the Active Layout.
Widget	FindWidgetByNameFromAnyLayout (string widgetName, out SCR_HUDLayout foundLayout=null)
SCR_HUDLayout	FindHUDLayout (string layoutIdentifier)
void	ChangeActiveHUDLayout (string layoutIdentifier=string.Empty)
void	SetLayoutEnabled (string layoutIdentifier, bool isEnabled)
override void	OnInit (notnull SCR_HUDManagerComponent owner)
override void	OnUpdate (notnull SCR_HUDManagerComponent owner)
ScriptInvokerVoid	GetOnMainLayoutInitialize ()
Public Member Functions inherited from SCR_HUDManagerHandler
bool	CanUpdate ()
void	SetCanUpdate (bool canUpdate)
void	OnStart (notnull SCR_HUDManagerComponent owner)
void	OnStop (notnull SCR_HUDManagerComponent owner)

Protected Member Functions
void	InitializeHUDLayouts ()
void	StartMainLayout ()
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
Protected Attributes inherited from SCR_HUDManagerHandler
SCR_HUDManagerComponent	m_HUDManager
bool	m_bCanUpdate

Member Function Documentation

AddHUDLayout()

void SCR_HUDManagerLayoutHandler.AddHUDLayout

(

notnull SCR_HUDLayout

layout

)

ChangeActiveHUDLayout()

void SCR_HUDManagerLayoutHandler.ChangeActiveHUDLayout

(

string

layoutIdentifier = string::Empty

)

FindHUDLayout()

SCR_HUDLayout SCR_HUDManagerLayoutHandler.FindHUDLayout

(

string

layoutIdentifier

)

FindSlotComponentFromAnyLayout()

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

FindWidgetByName()

Widget SCR_HUDManagerLayoutHandler.FindWidgetByName

(

string

widgetName

)

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

Parameters

widgetName

Name of the slot to look for.

FindWidgetByNameFromAnyLayout()

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

GetActiveLayout()

SCR_HUDLayout SCR_HUDManagerLayoutHandler.GetActiveLayout

(

)

GetAllHudElements()

int SCR_HUDManagerLayoutHandler.GetAllHudElements

(

notnull out array< SCR_HUDElement >

hudElements

)

GetAllHUDLayouts()

array< ref SCR_HUDLayout > SCR_HUDManagerLayoutHandler.GetAllHUDLayouts

(

)

GetAllIdentifiers()

array< string > SCR_HUDManagerLayoutHandler.GetAllIdentifiers

(

)

GetGroupByName()

Widget SCR_HUDManagerLayoutHandler.GetGroupByName

(

string

groupName

)

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

Parameters

groupName

Name of the group to look for.

GetGroupComponent()

SCR_HUDGroupUIComponent SCR_HUDManagerLayoutHandler.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.

GetOnLayoutChange()

OnLayoutChange SCR_HUDManagerLayoutHandler.GetOnLayoutChange

(

)

GetOnMainLayoutInitialize()

ScriptInvokerVoid SCR_HUDManagerLayoutHandler.GetOnMainLayoutInitialize

(

)

GetSlotComponentByName()

SCR_HUDSlotUIComponent SCR_HUDManagerLayoutHandler.GetSlotComponentByName

(

string

slotName

)

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.

InitializeHUDLayouts()

void SCR_HUDManagerLayoutHandler.InitializeHUDLayouts ( )

protected

OnEditorChange()

void SCR_HUDManagerLayoutHandler.OnEditorChange ( )

protected

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

OnEditorClose()

void SCR_HUDManagerLayoutHandler.OnEditorClose ( )

protected

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

OnEditorOpen()

void SCR_HUDManagerLayoutHandler.OnEditorOpen ( )

protected

When editor gets opened save the editor HudLayout.

OnInit()

override void SCR_HUDManagerLayoutHandler.OnInit

(

notnull SCR_HUDManagerComponent

owner

)

Implements SCR_HUDManagerHandler.

OnUpdate()

override void SCR_HUDManagerLayoutHandler.OnUpdate

(

notnull SCR_HUDManagerComponent

owner

)

Implements SCR_HUDManagerHandler.

RemoveHUDLayout()

void SCR_HUDManagerLayoutHandler.RemoveHUDLayout

(

notnull SCR_HUDLayout

layout

)

SetLayoutEnabled()

void SCR_HUDManagerLayoutHandler.SetLayoutEnabled	(	string	layoutIdentifier,
		bool	isEnabled )

StartMainLayout()

void SCR_HUDManagerLayoutHandler.StartMainLayout ( )

protected

Member Data Documentation

m_ActiveLayout

SCR_HUDLayout SCR_HUDManagerLayoutHandler.m_ActiveLayout

protected

m_aHUDLayouts

ref array<ref SCR_HUDLayout> SCR_HUDManagerLayoutHandler.m_aHUDLayouts

protected

m_bIsEditorOpen

bool SCR_HUDManagerLayoutHandler.m_bIsEditorOpen

protected

m_OnLayoutChange

ref OnLayoutChange SCR_HUDManagerLayoutHandler.m_OnLayoutChange

protected

m_OnMainLayoutInitialize

ref ScriptInvokerVoid SCR_HUDManagerLayoutHandler.m_OnMainLayoutInitialize

protected

m_SavedEditorLayout

SCR_HUDLayout SCR_HUDManagerLayoutHandler.m_SavedEditorLayout

protected

m_sMainLayout

string SCR_HUDManagerLayoutHandler.m_sMainLayout

protected

---

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

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