SCR_ActionMenuElementComponent Interface Reference

Inheritance diagram for SCR_ActionMenuElementComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
SCR_NearbyContextWidgetComponentInteract	GetIconComponent ()
void	SetVisible (bool state)
bool	Set (notnull BaseUserAction userAction, bool isSelected, bool isAvailable, SCR_ActionUIInfo actionUIInfo)
	Set all the data and how it should be displayed.
void	UpdateColors ()
void	SetOpacity (float position)
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
void	SetIconFromAction (SCR_ActionUIInfo info, BaseUserAction userAction)
	Try to set the Icon defined in the UIInfo from action first.

Protected Attributes
ref SCR_ActionMenuElementWidgets	m_Widgets = new SCR_ActionMenuElementWidgets()
bool	m_bIsSelected
bool	m_bIsDisabled
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const float	NEARBY_INTERACTION_OPACITY_DIVIDER = 3
const float	NEARBY_INTERACTION_OPACITY_MULTIPLIER = 0.9
const float	NEARBY_INTERACTION_OPACITY_CUTOFF = 0.1
const int	m_iFontSizeSelected = 24
const int	m_iFontSizeNotSelected = 20

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

GetIconComponent()

SCR_NearbyContextWidgetComponentInteract SCR_ActionMenuElementComponent.GetIconComponent

(

)

HandlerAttached()

override void SCR_ActionMenuElementComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Set()

bool SCR_ActionMenuElementComponent.Set	(	notnull BaseUserAction	userAction,
		bool	isSelected,
		bool	isAvailable,
		SCR_ActionUIInfo	actionUIInfo )

Set all the data and how it should be displayed.

Parameters

[in]	userAction	Context the Widget gets assigned to
[in]	isSelected	is the userAction currently selected by the player
[in]	isAvailable	is the userAction available (not disabled/blocked)
[in]	actionUIInfo	containing all the information for the widget Icon, etc. Can be null return True if the userAction has at least one actionName

SetIconFromAction()

void SCR_ActionMenuElementComponent.SetIconFromAction ( SCR_ActionUIInfo info, BaseUserAction userAction )

protected

Try to set the Icon defined in the UIInfo from action first.

SetOpacity()

void SCR_ActionMenuElementComponent.SetOpacity

(

float

position

)

SetVisible()

void SCR_ActionMenuElementComponent.SetVisible

(

bool

state

)

UpdateColors()

void SCR_ActionMenuElementComponent.UpdateColors

(

)

Member Data Documentation

m_bIsDisabled

bool SCR_ActionMenuElementComponent.m_bIsDisabled

protected

m_bIsSelected

bool SCR_ActionMenuElementComponent.m_bIsSelected

protected

m_iFontSizeNotSelected

const int SCR_ActionMenuElementComponent.m_iFontSizeNotSelected = 20

staticprotected

m_iFontSizeSelected

const int SCR_ActionMenuElementComponent.m_iFontSizeSelected = 24

staticprotected

m_Widgets

ref SCR_ActionMenuElementWidgets SCR_ActionMenuElementComponent.m_Widgets = new SCR_ActionMenuElementWidgets()

protected

NEARBY_INTERACTION_OPACITY_CUTOFF

const float SCR_ActionMenuElementComponent.NEARBY_INTERACTION_OPACITY_CUTOFF = 0.1

staticprotected

NEARBY_INTERACTION_OPACITY_DIVIDER

const float SCR_ActionMenuElementComponent.NEARBY_INTERACTION_OPACITY_DIVIDER = 3

staticprotected

NEARBY_INTERACTION_OPACITY_MULTIPLIER

const float SCR_ActionMenuElementComponent.NEARBY_INTERACTION_OPACITY_MULTIPLIER = 0.9

staticprotected

---

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

• Game/Interactions/Display/SCR_ActionMenuElementComponent.c