SCR_WidgetHighlightUIComponent Interface Reference

Inheritance diagram for SCR_WidgetHighlightUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Static Public Member Functions
static Widget	CreateHighlight (Widget widget, ResourceName layout, Widget parent=null)
	Highlight a widget.
static Widget	CreateHighlight (string widgetName, ResourceName layout, Widget parent=null)
	Highlight a widget.

Protected Member Functions
void	Update (Widget w)

Protected Attributes
Widget	m_HighlightWidget

Member Function Documentation

CreateHighlight() [1/2]

static Widget SCR_WidgetHighlightUIComponent.CreateHighlight ( string  widgetName, ResourceName  layout, Widget  parent = null  )

static

Highlight a widget.

Parameters

widgetName	Name of the widget to be highlighted
layout	Layout prefab of the highlight
parent	Parent widget of the highlight. Must be a FrameSlot covering the whole screen!

Returns

Highlight widget. Delete it when highlight is no longer needed.

CreateHighlight() [2/2]

static Widget SCR_WidgetHighlightUIComponent.CreateHighlight ( Widget  widget, ResourceName  layout, Widget  parent = null  )

static

Highlight a widget.

Parameters

widget	Widget to be highlighted
layout	Layout prefab of the highlight
parent	Parent widget of the highlight. Must be a FrameSlot covering the whole screen!

Returns

Highlight widget. Delete it when highlight is no longer needed.

HandlerAttached()

override void SCR_WidgetHighlightUIComponent.HandlerAttached

(

Widget

w

)

HandlerDeattached()

override void SCR_WidgetHighlightUIComponent.HandlerDeattached

(

Widget

w

)

Update()

void SCR_WidgetHighlightUIComponent.Update ( Widget  w )

protected

Member Data Documentation

m_HighlightWidget

Widget SCR_WidgetHighlightUIComponent.m_HighlightWidget

protected

---

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

• Game/UI/Components/SCR_WidgetHighlightUIComponent.c