SCR_NearbyContextWidgetComponentInteract Class Reference

Inheritance diagram for SCR_NearbyContextWidgetComponentInteract:

Protected Member Functions
override void	HandlerAttached (Widget w)
void	OnAssigned (SCR_ActionContextUIInfo info, UserActionContext context)
void	OnAssigned (SCR_ActionUIInfo info, BaseUserAction context)
bool	HasColorData ()
void	SetColorsData (map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract > cachedActionColors)
void	UpdateColors (UserActionContext ctx, SCR_ENearbyInteractionContextColors nearbyColorState=UIConstants.NEARBY_INTERACTION_DEFAULT_STATE)
void	UpdateColors (BaseUserAction userAct, SCR_ENearbyInteractionContextColors nearbyColorState=UIConstants.NEARBY_INTERACTION_DEFAULT_STATE)
void	SetIconFromAction (SCR_ActionUIInfo info)
void	SetColors (notnull SCR_NearbyContextColorsComponentInteract colorset, bool showOuterBackground)
void	ChangeVisibility (bool isInLineOfSight)
UserActionContext	GetAssignedContext ()
	Get the context that currently uses this Widget.
ScriptInvokerVoid	GetOnContextAssigned ()

Static Protected Member Functions
static bool	IsHealingAction (BaseUserAction userAct)
static bool	IsHealingAction (BaseUserAction userAct, out bool showOuterBackground, out int nearbyColorState)

Protected Attributes
ref SCR_ContextBasicInteractionBlipWidgets	m_Widgets = new SCR_ContextBasicInteractionBlipWidgets()
const float	ENABLED_NEARBY_INTERACTION_GLOW_OPACITY = 0.6
const float	DISABLED_NEARBY_INTERACTION_OPACITY = 0.4
BaseUserAction	m_FirstAction
ref ScriptInvokerVoid	m_OnContextAssigned
ref UserActionContext	m_AssignedContext
ref map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract >	m_mCachedActionColors
	Holds all the different cached id with the enum as key.
Color	m_IconColor
Color	m_GlowColor
Color	m_BackgroundColor

Detailed Description

Definition at line 1 of file SCR_NearbyContextWidgetComponentInteract.c.

Member Function Documentation

ChangeVisibility()

void SCR_NearbyContextWidgetComponentInteract::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 182 of file SCR_NearbyContextWidgetComponentInteract.c.

GetAssignedContext()

UserActionContext SCR_NearbyContextWidgetComponentInteract::GetAssignedContext ( )

inlineprotected

Get the context that currently uses this Widget.

Definition at line 206 of file SCR_NearbyContextWidgetComponentInteract.c.

GetOnContextAssigned()

ScriptInvokerVoid SCR_NearbyContextWidgetComponentInteract::GetOnContextAssigned ( )

inlineprotected

Definition at line 212 of file SCR_NearbyContextWidgetComponentInteract.c.

HandlerAttached()

override void SCR_NearbyContextWidgetComponentInteract::HandlerAttached ( Widget w )

inlineprotected

Definition at line 23 of file SCR_NearbyContextWidgetComponentInteract.c.

HasColorData()

bool SCR_NearbyContextWidgetComponentInteract::HasColorData ( )

inlineprotected

Definition at line 70 of file SCR_NearbyContextWidgetComponentInteract.c.

IsHealingAction() [1/2]

bool SCR_NearbyContextWidgetComponentInteract::IsHealingAction ( BaseUserAction userAct )

inlinestaticprotected

Definition at line 114 of file SCR_NearbyContextWidgetComponentInteract.c.

IsHealingAction() [2/2]

bool SCR_NearbyContextWidgetComponentInteract::IsHealingAction ( BaseUserAction userAct, out bool showOuterBackground, out int nearbyColorState )

inlinestaticprotected

Definition at line 122 of file SCR_NearbyContextWidgetComponentInteract.c.

OnAssigned() [1/2]

void SCR_NearbyContextWidgetComponentInteract::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 35 of file SCR_NearbyContextWidgetComponentInteract.c.

OnAssigned() [2/2]

void SCR_NearbyContextWidgetComponentInteract::OnAssigned ( SCR_ActionUIInfo info, BaseUserAction 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]	info	containing all the information for the widget Icon, etc. Can be null
[in]	context	the Widget gets assigned to

Definition at line 59 of file SCR_NearbyContextWidgetComponentInteract.c.

SetColors()

void SCR_NearbyContextWidgetComponentInteract::SetColors ( notnull SCR_NearbyContextColorsComponentInteract colorset, bool showOuterBackground )

inlineprotected

Set the colors from the given colorset

Parameters

[in]	colorset	The set of colors to apply
[in]	showOuterBackground	Should the outer shadow/background effect be displayed

Definition at line 159 of file SCR_NearbyContextWidgetComponentInteract.c.

SetColorsData()

void SCR_NearbyContextWidgetComponentInteract::SetColorsData ( map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract > cachedActionColors )

inlineprotected

Definition at line 76 of file SCR_NearbyContextWidgetComponentInteract.c.

SetIconFromAction()

void SCR_NearbyContextWidgetComponentInteract::SetIconFromAction ( SCR_ActionUIInfo info )

inlineprotected

Try to set the Icon defined in the UIInfo from action first return True if icon was able to be set from Action or from UIInfo

Definition at line 139 of file SCR_NearbyContextWidgetComponentInteract.c.

UpdateColors() [1/2]

void SCR_NearbyContextWidgetComponentInteract::UpdateColors ( BaseUserAction userAct, SCR_ENearbyInteractionContextColors nearbyColorState = UIConstants.NEARBY_INTERACTION_DEFAULT_STATE )

inlineprotected

Definition at line 102 of file SCR_NearbyContextWidgetComponentInteract.c.

UpdateColors() [2/2]

void SCR_NearbyContextWidgetComponentInteract::UpdateColors ( UserActionContext ctx, SCR_ENearbyInteractionContextColors nearbyColorState = UIConstants.NEARBY_INTERACTION_DEFAULT_STATE )

inlineprotected

Definition at line 82 of file SCR_NearbyContextWidgetComponentInteract.c.

Member Data Documentation

DISABLED_NEARBY_INTERACTION_OPACITY

const float SCR_NearbyContextWidgetComponentInteract::DISABLED_NEARBY_INTERACTION_OPACITY = 0.4

protected

Definition at line 6 of file SCR_NearbyContextWidgetComponentInteract.c.

ENABLED_NEARBY_INTERACTION_GLOW_OPACITY

const float SCR_NearbyContextWidgetComponentInteract::ENABLED_NEARBY_INTERACTION_GLOW_OPACITY = 0.6

protected

Definition at line 5 of file SCR_NearbyContextWidgetComponentInteract.c.

m_AssignedContext

ref UserActionContext SCR_NearbyContextWidgetComponentInteract::m_AssignedContext

protected

Definition at line 13 of file SCR_NearbyContextWidgetComponentInteract.c.

m_BackgroundColor

Color SCR_NearbyContextWidgetComponentInteract::m_BackgroundColor

protected

Definition at line 20 of file SCR_NearbyContextWidgetComponentInteract.c.

m_FirstAction

BaseUserAction SCR_NearbyContextWidgetComponentInteract::m_FirstAction

protected

Definition at line 8 of file SCR_NearbyContextWidgetComponentInteract.c.

m_GlowColor

Color SCR_NearbyContextWidgetComponentInteract::m_GlowColor

protected

Definition at line 19 of file SCR_NearbyContextWidgetComponentInteract.c.

m_IconColor

Color SCR_NearbyContextWidgetComponentInteract::m_IconColor

protected

Definition at line 18 of file SCR_NearbyContextWidgetComponentInteract.c.

m_mCachedActionColors

ref map<SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract> SCR_NearbyContextWidgetComponentInteract::m_mCachedActionColors

protected

Holds all the different cached id with the enum as key.

Definition at line 16 of file SCR_NearbyContextWidgetComponentInteract.c.

m_OnContextAssigned

ref ScriptInvokerVoid SCR_NearbyContextWidgetComponentInteract::m_OnContextAssigned

protected

Definition at line 12 of file SCR_NearbyContextWidgetComponentInteract.c.

m_Widgets

ref SCR_ContextBasicInteractionBlipWidgets SCR_NearbyContextWidgetComponentInteract::m_Widgets = new SCR_ContextBasicInteractionBlipWidgets()

protected

Definition at line 3 of file SCR_NearbyContextWidgetComponentInteract.c.

---

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

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