SCR_WidgetHighlightUIComponent Class Reference

Inheritance diagram for SCR_WidgetHighlightUIComponent:

Protected Member Functions
void	Update (Widget w)
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Static Protected Member Functions
static Widget	CreateHighlight (Widget widget, ResourceName layout, Widget parent=null)
static Widget	CreateHighlight (string widgetName, ResourceName layout, Widget parent=null)

Protected Attributes
Widget	m_HighlightWidget

Detailed Description

Definition at line 1 of file SCR_WidgetHighlightUIComponent.c.

Member Function Documentation

CreateHighlight() [1/2]

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

inlinestaticprotected

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.

Definition at line 40 of file SCR_WidgetHighlightUIComponent.c.

CreateHighlight() [2/2]

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

inlinestaticprotected

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.

Definition at line 12 of file SCR_WidgetHighlightUIComponent.c.

HandlerAttached()

override void SCR_WidgetHighlightUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 82 of file SCR_WidgetHighlightUIComponent.c.

HandlerDeattached()

override void SCR_WidgetHighlightUIComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 88 of file SCR_WidgetHighlightUIComponent.c.

Update()

void SCR_WidgetHighlightUIComponent::Update ( Widget w )

inlineprotected

Definition at line 51 of file SCR_WidgetHighlightUIComponent.c.

Member Data Documentation

m_HighlightWidget

Widget SCR_WidgetHighlightUIComponent::m_HighlightWidget

protected

Definition at line 3 of file SCR_WidgetHighlightUIComponent.c.

---

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

• scripts/Game/UI/Components/SCR_WidgetHighlightUIComponent.c