Inheritance diagram for SCR_ActionMenuInteractionDisplay:

Protected Member Functions
void	Create ()
	Creates and initializes root widget to be slotted with actions.
void	Destroy ()
bool	Update (ActionsTuple actionsData, BaseUserAction selectedAction, UserActionContext currentContext, float fTimeSlice)
bool	UpdateAnimateActions (ActionsTuple actionsData, BaseUserAction selectedAction, UserActionContext currentContext, bool isSingleAction, float fTimeSlice)
bool	UpdateDisplayActions (ActionsTuple actionsData, BaseUserAction selectedAction, UserActionContext currentContext, int actionsCount)
void	SetPaggingEffect (int currentAction, bool scrollingDown)
bool	GetSafeZone (vector worldPosition, vector screenPosition, vector min01, vector max01, out vector clampedPosition)
void	SetPosition (vector worldPosition)
void	SetScroll (int currentScroll, float timeSlice=0)
void	RunExpandTimer (float fTimeSlice)
void	RunExpandedTimer (float fTimeSlice)
void	Expand ()
void	Collapse ()
float	GetButtonFadeInSpeed ()
override void	OnActionStart (IEntity pUser, BaseUserAction pPerformedAction)
	Called when action starts being performed.
override void	OnActionProgress (IEntity pUser, BaseUserAction pPerformedAction, float fProgress, float fDuration)
	Called when action is being performed.
override void	OnActionFinish (IEntity pUser, BaseUserAction pFinishedAction, ActionFinishReason eFinishReason)
	Called when an action is finished.
override void	DisplayUpdate (IEntity owner, float timeSlice)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
override void	ShowDisplay ()
	Called when display was hidden and is supposed to be shown. Called before first ShowActionsDisplay call.
override void	HideDisplay ()
	Called when display was open and is supposed to hide. Called after last ShowActionsDisplay call.
override void	SetDisplayData (ActionDisplayData data)
	Data provided by the interaction handler.
void	CompareNewDateWithOld (ActionDisplayData data)
	Hackfix: We are trying to find clues if we need to update the UI based on the acton data.
void	ForceUpdateUI ()
	Allows for external functions to request a UI update.
void	~SCR_ActionMenuInteractionDisplay ()

Protected Attributes
ref Color	m_EnabledColor
ref Color	m_DisabledColor
ref Color	m_DisabledColorGlow
ref Color	m_PerformingColor
bool	m_bFixedPlacement
float	m_fScrollAnimationSpeed
float	m_fAutoExpandTime
float	m_fFadeInOffset
float	m_fWaitTimeAdditionalInfo
float	m_fHeightElement
float	m_fButtonFadeInSpeed
ref array< ref SCR_NearbyContextColorsComponentInteract >	m_aNearbyWidgetColors
ref SCR_ActionMenuLayoutWidgets	m_Widgets = new SCR_ActionMenuLayoutWidgets()
ref SCR_SnackBarController	m_SnackBar
ref array< ref SCR_ActionMenuElementComponent >	m_aActionMenuElements = {}
ref array< ref SCR_ActionMenuElementComponent >	m_aActiveActionMenuElements = {}
InteractionHandlerComponent	m_InteractionHandlerComponent
BaseUserAction	m_PrevAction
UserActionContext	m_PrevContext
ref ActionDisplayData	m_LastData
bool	m_bIsSingleEntryMenu
int	m_iCurrentScroll
float	m_fCurrentScrollAnimation
float	m_fExpandTimer
float	m_fExpandedTimer
float	m_fSnackBarAppearTimer
float	m_fSnackBarOpacityTimer
bool	m_bShouldDisplaySnackBar
float	m_fTimeSpentAdditionalInfo
bool	m_bForceUpdate
bool	m_bProgressReachedMax
bool	m_bIsActionEnabled
int	m_iContextCount
ref TStringArray	m_aCurrentContextNames
ref map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract >	m_mCachedActionColors
	Holds all the different cached id with the enum as key.
float	m_fTotalHeightElements
const float	ANCHOR_X = 0.48
const float	ANCHOR_Y = 0.94
const float	SAFEZONE_PADDING = 15.0
const float	WIDGET_DEFAULT_OPACITY = 1.0
const float	WIDGET_HIDDEN_OPACITY = 0.75
const vector	SCREEN_POS_MIN = "0.15 0.15 0"
const vector	SCREEN_POS_MAX = "0.85 0.85 0"
const string	SETTING_HINT_ACTION = "m_bShowInteractionHint"

Detailed Description

Definition at line 1 of file SCR_ActionMenuInteractionDisplay.c.

Constructor & Destructor Documentation

◆ ~SCR_ActionMenuInteractionDisplay()

void SCR_ActionMenuInteractionDisplay::~SCR_ActionMenuInteractionDisplay ( )

inlineprotected

Definition at line 883 of file SCR_ActionMenuInteractionDisplay.c.

Member Function Documentation

◆ Collapse()

void SCR_ActionMenuInteractionDisplay::Collapse ( )

inlineprotected

Definition at line 672 of file SCR_ActionMenuInteractionDisplay.c.

◆ CompareNewDateWithOld()

void SCR_ActionMenuInteractionDisplay::CompareNewDateWithOld ( ActionDisplayData data )

inlineprotected

Hackfix: We are trying to find clues if we need to update the UI based on the acton data.

Definition at line 833 of file SCR_ActionMenuInteractionDisplay.c.

◆ Create()

void SCR_ActionMenuInteractionDisplay::Create ( )

inlineprotected

Creates and initializes root widget to be slotted with actions.

Definition at line 103 of file SCR_ActionMenuInteractionDisplay.c.

◆ Destroy()

void SCR_ActionMenuInteractionDisplay::Destroy ( )

inlineprotected

Definition at line 158 of file SCR_ActionMenuInteractionDisplay.c.

◆ DisplayStartDraw()

override void SCR_ActionMenuInteractionDisplay::DisplayStartDraw ( IEntity owner )

inlineprotected

Definition at line 771 of file SCR_ActionMenuInteractionDisplay.c.

◆ DisplayStopDraw()

override void SCR_ActionMenuInteractionDisplay::DisplayStopDraw ( IEntity owner )

inlineprotected

Definition at line 782 of file SCR_ActionMenuInteractionDisplay.c.

◆ DisplayUpdate()

override void SCR_ActionMenuInteractionDisplay::DisplayUpdate	(	IEntity	owner,
		float	timeSlice )

inlineprotected

Definition at line 730 of file SCR_ActionMenuInteractionDisplay.c.

◆ Expand()

void SCR_ActionMenuInteractionDisplay::Expand ( )

inlineprotected

Definition at line 665 of file SCR_ActionMenuInteractionDisplay.c.

◆ ForceUpdateUI()

void SCR_ActionMenuInteractionDisplay::ForceUpdateUI ( )

inlineprotected

Allows for external functions to request a UI update.

Definition at line 876 of file SCR_ActionMenuInteractionDisplay.c.

◆ GetButtonFadeInSpeed()

float SCR_ActionMenuInteractionDisplay::GetButtonFadeInSpeed ( )

inlineprotected

Definition at line 680 of file SCR_ActionMenuInteractionDisplay.c.

◆ GetSafeZone()

bool SCR_ActionMenuInteractionDisplay::GetSafeZone	(	vector	worldPosition,
		vector	screenPosition,
		vector	min01,
		vector	max01,
		out vector	clampedPosition )

inlineprotected

Definition at line 504 of file SCR_ActionMenuInteractionDisplay.c.

◆ HideDisplay()

override void SCR_ActionMenuInteractionDisplay::HideDisplay ( )

inlineprotected

Called when display was open and is supposed to hide. Called after last ShowActionsDisplay call.

Definition at line 800 of file SCR_ActionMenuInteractionDisplay.c.

◆ OnActionFinish()

override void SCR_ActionMenuInteractionDisplay::OnActionFinish	(	IEntity	pUser,
		BaseUserAction	pFinishedAction,
		ActionFinishReason	eFinishReason )

inlineprotected

Called when an action is finished.

Definition at line 718 of file SCR_ActionMenuInteractionDisplay.c.

◆ OnActionProgress()

override void SCR_ActionMenuInteractionDisplay::OnActionProgress	(	IEntity	pUser,
		BaseUserAction	pPerformedAction,
		float	fProgress,
		float	fDuration )

inlineprotected

Called when action is being performed.

Definition at line 698 of file SCR_ActionMenuInteractionDisplay.c.

◆ OnActionStart()

override void SCR_ActionMenuInteractionDisplay::OnActionStart	(	IEntity	pUser,
		BaseUserAction	pPerformedAction )

inlineprotected

Called when action starts being performed.

Definition at line 688 of file SCR_ActionMenuInteractionDisplay.c.

◆ RunExpandedTimer()

void SCR_ActionMenuInteractionDisplay::RunExpandedTimer ( float fTimeSlice )

inlineprotected

Parameters

[in] fTimeSlice

Definition at line 651 of file SCR_ActionMenuInteractionDisplay.c.

◆ RunExpandTimer()

void SCR_ActionMenuInteractionDisplay::RunExpandTimer ( float fTimeSlice )

inlineprotected

Parameters

[in] fTimeSlice

Definition at line 633 of file SCR_ActionMenuInteractionDisplay.c.

◆ SetDisplayData()

override void SCR_ActionMenuInteractionDisplay::SetDisplayData ( ActionDisplayData data )

inlineprotected

Data provided by the interaction handler.

Definition at line 824 of file SCR_ActionMenuInteractionDisplay.c.

◆ SetPaggingEffect()

void SCR_ActionMenuInteractionDisplay::SetPaggingEffect	(	int	currentAction,
		bool	scrollingDown )

inlineprotected

Itterates through all shown actions and applies the correct padding & opacity

Parameters

[in] int current action

Definition at line 458 of file SCR_ActionMenuInteractionDisplay.c.

◆ SetPosition()

void SCR_ActionMenuInteractionDisplay::SetPosition ( vector worldPosition )

inlineprotected

Parameters

[in] worldPosition

Definition at line 579 of file SCR_ActionMenuInteractionDisplay.c.

◆ SetScroll()

void SCR_ActionMenuInteractionDisplay::SetScroll	(	int	currentScroll,
		float	timeSlice = 0 )

inlineprotected

Parameters

[in]	currentScroll	which element in the list are we on
[in]	timeSlice	elasped time since the last frame

Definition at line 606 of file SCR_ActionMenuInteractionDisplay.c.

◆ ShowDisplay()

override void SCR_ActionMenuInteractionDisplay::ShowDisplay ( )

inlineprotected

Called when display was hidden and is supposed to be shown. Called before first ShowActionsDisplay call.

Definition at line 790 of file SCR_ActionMenuInteractionDisplay.c.

◆ Update()

bool SCR_ActionMenuInteractionDisplay::Update	(	ActionsTuple	actionsData,
		BaseUserAction	selectedAction,
		UserActionContext	currentContext,
		float	fTimeSlice )

inlineprotected

Definition at line 168 of file SCR_ActionMenuInteractionDisplay.c.

◆ UpdateAnimateActions()

bool SCR_ActionMenuInteractionDisplay::UpdateAnimateActions	(	ActionsTuple	actionsData,
		BaseUserAction	selectedAction,
		UserActionContext	currentContext,
		bool	isSingleAction,
		float	fTimeSlice )

inlineprotected

Definition at line 204 of file SCR_ActionMenuInteractionDisplay.c.

◆ UpdateDisplayActions()

bool SCR_ActionMenuInteractionDisplay::UpdateDisplayActions	(	ActionsTuple	actionsData,
		BaseUserAction	selectedAction,
		UserActionContext	currentContext,
		int	actionsCount )