SCR_HUDSlotUIComponent Interface Reference

Inheritance diagram for SCR_HUDSlotUIComponent:

Public Member Functions
int	GetHeight ()
	/return the height of the Slot.
int	GetWidth ()
	/return the Width of the Slot.
int	GetPriority ()
	/return the Priority of the Slot.
void	SetPriority (int newPriority)
	Sets the Priority of the Slot.
SCR_HUDSlotResizeInvoker	GetOnResize ()
	/return the ScriptInvoker which gets invoked when the Slot is resized.
void	SetHeight (int height, bool notifyResizing=true)
	Sets the Height of the Slot.
void	SetWidth (int width, bool notifyResizing=true)
	A method that sets the Width of the Slot.
Widget	GetContentWidget ()
	Gets the Content Widget of the Slot.
Widget	GetRootWidget ()
	Gets the Root Widget of the Slot.
void	Initialize ()
	Intializes the Slot.
override void	HandlerAttached (Widget w)
void	DebugHeightInfo ()
	Displays debugging information for the height of the slot.
void	DebugWidthInfo ()
	Displays debugging information for the width of the slot.

Public Attributes
OverlayWidget	m_wDebugOverlay
ImageWidget	m_wDebugImg
Widget m_wDebugVertical TextWidget	m_wDebugNameText
RichTextWidget	m_wDebugHeightText
RichTextWidget	m_wDebugWidthText
TextWidget	m_wDebugPriorityText
ref array< int >	m_aHeightSteps
ref array< int >	m_aWidthSteps
bool	m_bSizeToContent

Protected Member Functions
SCR_HUDGroupUIComponent	GetGroupComponent ()
	Gets the group component of the Slot.

Protected Attributes
bool	m_bInitialized
	A boolean value indicating whether the Slot has been initialized.
WorkspaceWidget	m_wWorkspace
Widget	m_wRoot
	The root widget of the Slot.
int	m_iHeight
	The height of the Slot.
int	m_iWidth
	The width of the Slot.
SCR_HUDGroupUIComponent	m_GroupComponent
ref SCR_HUDSlotResizeInvoker	m_OnResize = new SCR_HUDSlotResizeInvoker()
int	m_iPriority

Member Function Documentation

DebugHeightInfo()

void SCR_HUDSlotUIComponent.DebugHeightInfo

(

)

Displays debugging information for the height of the slot.

Only available within Workbench.

DebugWidthInfo()

void SCR_HUDSlotUIComponent.DebugWidthInfo

(

)

Displays debugging information for the width of the slot.

Only available within Workbench.

GetContentWidget()

Widget SCR_HUDSlotUIComponent.GetContentWidget

(

)

Gets the Content Widget of the Slot.

GetGroupComponent()

SCR_HUDGroupUIComponent SCR_HUDSlotUIComponent.GetGroupComponent ( )

protected

Gets the group component of the Slot.

GetHeight()

int SCR_HUDSlotUIComponent.GetHeight

(

)

/return the height of the Slot.

GetOnResize()

SCR_HUDSlotResizeInvoker SCR_HUDSlotUIComponent.GetOnResize

(

)

/return the ScriptInvoker which gets invoked when the Slot is resized.

GetPriority()

int SCR_HUDSlotUIComponent.GetPriority

(

)

/return the Priority of the Slot.

GetRootWidget()

Widget SCR_HUDSlotUIComponent.GetRootWidget

(

)

Gets the Root Widget of the Slot.

GetWidth()

int SCR_HUDSlotUIComponent.GetWidth

(

)

/return the Width of the Slot.

HandlerAttached()

override void SCR_HUDSlotUIComponent.HandlerAttached

(

Widget

w

)

Initialize()

void SCR_HUDSlotUIComponent.Initialize

(

)

Intializes the Slot.

SetHeight()

void SCR_HUDSlotUIComponent.SetHeight	(	int	height,
		bool	notifyResizing = true )

Sets the Height of the Slot.

SetPriority()

void SCR_HUDSlotUIComponent.SetPriority

(

int

newPriority

)

Sets the Priority of the Slot.

SetWidth()

void SCR_HUDSlotUIComponent.SetWidth	(	int	width,
		bool	notifyResizing = true )

A method that sets the Width of the Slot.

Member Data Documentation

m_aHeightSteps

ref array<int> SCR_HUDSlotUIComponent.m_aHeightSteps

m_aWidthSteps

ref array<int> SCR_HUDSlotUIComponent.m_aWidthSteps

m_bInitialized

bool SCR_HUDSlotUIComponent.m_bInitialized

protected

A boolean value indicating whether the Slot has been initialized.

m_bSizeToContent

bool SCR_HUDSlotUIComponent.m_bSizeToContent

m_GroupComponent

SCR_HUDGroupUIComponent SCR_HUDSlotUIComponent.m_GroupComponent

protected

m_iHeight

int SCR_HUDSlotUIComponent.m_iHeight

protected

The height of the Slot.

m_iPriority

int SCR_HUDSlotUIComponent.m_iPriority

protected

m_iWidth

int SCR_HUDSlotUIComponent.m_iWidth

protected

The width of the Slot.

m_OnResize

ref SCR_HUDSlotResizeInvoker SCR_HUDSlotUIComponent.m_OnResize = new SCR_HUDSlotResizeInvoker()

protected

m_wDebugHeightText

RichTextWidget SCR_HUDSlotUIComponent.m_wDebugHeightText

m_wDebugImg

ImageWidget SCR_HUDSlotUIComponent.m_wDebugImg

m_wDebugNameText

Widget m_wDebugVertical TextWidget SCR_HUDSlotUIComponent.m_wDebugNameText

m_wDebugOverlay

OverlayWidget SCR_HUDSlotUIComponent.m_wDebugOverlay

m_wDebugPriorityText

TextWidget SCR_HUDSlotUIComponent.m_wDebugPriorityText

m_wDebugWidthText

RichTextWidget SCR_HUDSlotUIComponent.m_wDebugWidthText

m_wRoot

Widget SCR_HUDSlotUIComponent.m_wRoot

protected

The root widget of the Slot.

m_wWorkspace

WorkspaceWidget SCR_HUDSlotUIComponent.m_wWorkspace

protected

---

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

• Game/UI/HUD/SCR_HUDSlotUIComponent.c