SCR_NearbyContextWidgetComponentInteract Interface Reference

Inheritance diagram for SCR_NearbyContextWidgetComponentInteract:

Public Member Functions
override void	HandlerAttached (Widget w)
void	OnAssigned (SCR_ActionContextUIInfo info, UserActionContext context)
	Will be called everytime the Widget gets assigned to a new context This happens everytime the context is in line of sight again.
void	OnAssigned (SCR_ActionUIInfo info, BaseUserAction context)
	Will be called everytime the Widget gets assigned to a new context This happens everytime the context is in line of sight again.
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	SetColors (notnull SCR_NearbyContextColorsComponentInteract colorset, bool showOuterBackground)
	Set the colors from the given colorset.
void	ChangeVisibility (bool isInLineOfSight)
	Changes the color of the root to make the whole widget darker / lighter to indicate if it's on line of sight or not.
UserActionContext	GetAssignedContext ()
	Get the context that currently uses this Widget.
ScriptInvokerVoid	GetOnContextAssigned ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
bool	IsHealingAction (BaseUserAction userAct, out bool showOuterBackground, out int nearbyColorState)
void	SetIconFromAction (SCR_ActionUIInfo info)
	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.

Protected Attributes
ref SCR_ContextBasicInteractionBlipWidgets	m_Widgets = new SCR_ContextBasicInteractionBlipWidgets()
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
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const float	ENABLED_NEARBY_INTERACTION_GLOW_OPACITY = 0.6
const float	DISABLED_NEARBY_INTERACTION_OPACITY = 0.4

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

ChangeVisibility()

void SCR_NearbyContextWidgetComponentInteract.ChangeVisibility

(

bool

isInLineOfSight

)

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

GetAssignedContext()

UserActionContext SCR_NearbyContextWidgetComponentInteract.GetAssignedContext

(

)

Get the context that currently uses this Widget.

GetOnContextAssigned()

ScriptInvokerVoid SCR_NearbyContextWidgetComponentInteract.GetOnContextAssigned

(

)

HandlerAttached()

override void SCR_NearbyContextWidgetComponentInteract.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

HasColorData()

bool SCR_NearbyContextWidgetComponentInteract.HasColorData

(

)

IsHealingAction()

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

protected

OnAssigned() [1/2]

void SCR_NearbyContextWidgetComponentInteract.OnAssigned	(	SCR_ActionContextUIInfo	info,
		UserActionContext	context )

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

OnAssigned() [2/2]

void SCR_NearbyContextWidgetComponentInteract.OnAssigned	(	SCR_ActionUIInfo	info,
		BaseUserAction	context )

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

SetColors()

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

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

SetColorsData()

void SCR_NearbyContextWidgetComponentInteract.SetColorsData

(

map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract >

cachedActionColors

)

SetIconFromAction()

void SCR_NearbyContextWidgetComponentInteract.SetIconFromAction ( SCR_ActionUIInfo info )

protected

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.

UpdateColors() [1/2]

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

UpdateColors() [2/2]

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

Member Data Documentation

DISABLED_NEARBY_INTERACTION_OPACITY

const float SCR_NearbyContextWidgetComponentInteract.DISABLED_NEARBY_INTERACTION_OPACITY = 0.4

staticprotected

ENABLED_NEARBY_INTERACTION_GLOW_OPACITY

const float SCR_NearbyContextWidgetComponentInteract.ENABLED_NEARBY_INTERACTION_GLOW_OPACITY = 0.6

staticprotected

m_AssignedContext

ref UserActionContext SCR_NearbyContextWidgetComponentInteract.m_AssignedContext

protected

m_BackgroundColor

Color SCR_NearbyContextWidgetComponentInteract.m_BackgroundColor

protected

m_FirstAction

BaseUserAction SCR_NearbyContextWidgetComponentInteract.m_FirstAction

protected

m_GlowColor

Color SCR_NearbyContextWidgetComponentInteract.m_GlowColor

protected

m_IconColor

Color SCR_NearbyContextWidgetComponentInteract.m_IconColor

protected

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.

m_OnContextAssigned

ref ScriptInvokerVoid SCR_NearbyContextWidgetComponentInteract.m_OnContextAssigned

protected

m_Widgets

ref SCR_ContextBasicInteractionBlipWidgets SCR_NearbyContextWidgetComponentInteract.m_Widgets = new SCR_ContextBasicInteractionBlipWidgets()

protected

---

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

• Game/UI/HUD/SCR_NearbyContextWidgetComponentInteract.c