SCR_NearbyContextWidgetComponentBase Class Reference

Inheritance diagram for SCR_NearbyContextWidgetComponentBase:

Protected Member Functions
override void	HandlerAttached (Widget w)
void	OnAssigned (SCR_ActionContextUIInfo info, UserActionContext context)
void	ChangeBackgroundColor (Color newColor)
void	ChangeVisibility (bool isInLineOfSight)
UserActionContext	GetAssignedContext ()
	Get the context that currently uses this Widget.
ScriptInvokerVoid	GetOnContextAssigned ()

Protected Attributes
ref Color	m_VisibleWidgetColor
ref Color	m_NotVisibleWidgetColor
string	m_sBackgroundWidgetName
string	m_sGlowWidgetName
Widget	m_wRoot
ImageWidget	m_wBackground
ImageWidget	m_wGlow
UserActionContext	m_AssignedContext
BaseUserAction	m_FirstAction
ref ScriptInvokerVoid	m_OnContextAssigned

Detailed Description

Definition at line 1 of file SCR_NearbyContextWidgetComponentBase.c.

Member Function Documentation

ChangeBackgroundColor()

void SCR_NearbyContextWidgetComponentBase::ChangeBackgroundColor ( Color newColor )

inlineprotected

Change the color of the Background Widget

Parameters

[in]

Color

The color, the backgroung should have

Definition at line 69 of file SCR_NearbyContextWidgetComponentBase.c.

ChangeVisibility()

void SCR_NearbyContextWidgetComponentBase::ChangeVisibility ( bool isInLineOfSight )

inlineprotected

Changes the color of the root to make the whole widget darker / lighter to indicate if it's on line of sight or not

Parameters

[in]

bool

Is in line of sight

Definition at line 78 of file SCR_NearbyContextWidgetComponentBase.c.

GetAssignedContext()

UserActionContext SCR_NearbyContextWidgetComponentBase::GetAssignedContext ( )

inlineprotected

Get the context that currently uses this Widget.

Definition at line 88 of file SCR_NearbyContextWidgetComponentBase.c.

GetOnContextAssigned()

ScriptInvokerVoid SCR_NearbyContextWidgetComponentBase::GetOnContextAssigned ( )

inlineprotected

Definition at line 94 of file SCR_NearbyContextWidgetComponentBase.c.

HandlerAttached()

override void SCR_NearbyContextWidgetComponentBase::HandlerAttached ( Widget w )

inlineprotected

Definition at line 28 of file SCR_NearbyContextWidgetComponentBase.c.

OnAssigned()

void SCR_NearbyContextWidgetComponentBase::OnAssigned ( SCR_ActionContextUIInfo info, UserActionContext context )

inlineprotected

Will be called everytime the Widget gets assigned to a new context This happens everytime the context is in line of sight again

Parameters

[in]	UIInfo	containing all the information for the widget Icon, etc. Can be null
[in]	UserActionContext	Context the Widget gets assigned to

Definition at line 40 of file SCR_NearbyContextWidgetComponentBase.c.

Member Data Documentation

m_AssignedContext

UserActionContext SCR_NearbyContextWidgetComponentBase::m_AssignedContext

protected

Definition at line 20 of file SCR_NearbyContextWidgetComponentBase.c.

m_FirstAction

BaseUserAction SCR_NearbyContextWidgetComponentBase::m_FirstAction

protected

Definition at line 21 of file SCR_NearbyContextWidgetComponentBase.c.

m_NotVisibleWidgetColor

ref Color SCR_NearbyContextWidgetComponentBase::m_NotVisibleWidgetColor

protected

Definition at line 7 of file SCR_NearbyContextWidgetComponentBase.c.

m_OnContextAssigned

ref ScriptInvokerVoid SCR_NearbyContextWidgetComponentBase::m_OnContextAssigned

protected

Definition at line 25 of file SCR_NearbyContextWidgetComponentBase.c.

m_sBackgroundWidgetName

string SCR_NearbyContextWidgetComponentBase::m_sBackgroundWidgetName

protected

Definition at line 10 of file SCR_NearbyContextWidgetComponentBase.c.

m_sGlowWidgetName

string SCR_NearbyContextWidgetComponentBase::m_sGlowWidgetName

protected

Definition at line 13 of file SCR_NearbyContextWidgetComponentBase.c.

m_VisibleWidgetColor

ref Color SCR_NearbyContextWidgetComponentBase::m_VisibleWidgetColor

protected

Definition at line 4 of file SCR_NearbyContextWidgetComponentBase.c.

m_wBackground

ImageWidget SCR_NearbyContextWidgetComponentBase::m_wBackground

protected

Definition at line 17 of file SCR_NearbyContextWidgetComponentBase.c.

m_wGlow

ImageWidget SCR_NearbyContextWidgetComponentBase::m_wGlow

protected

Definition at line 18 of file SCR_NearbyContextWidgetComponentBase.c.

m_wRoot

Widget SCR_NearbyContextWidgetComponentBase::m_wRoot

protected

Definition at line 15 of file SCR_NearbyContextWidgetComponentBase.c.

---

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

• scripts/Game/UI/HUD/SCR_NearbyContextWidgetComponentBase.c