SCR_ActionMenuInteractionDisplay Interface Reference

Inheritance diagram for SCR_ActionMenuInteractionDisplay:

Public Member Functions
void	SetPosition (vector vWorldPosition)
void	SetScroll (int iCurrentScroll, float fTimeSlice=0)
void	UpdateArrow (Widget w, EActionMenuScroll state)
void	RunExpandTimer (float fTimeSlice)
void	RunExpandedTimer (float fTimeSlice)
void	Expand ()
void	Collapse ()
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	~SCR_ActionMenuInteractionDisplay ()
void	OnActionStart (IEntity pUser, BaseUserAction pPerformedAction)
	Override to handle what should happen when an action is performed.
void	OnActionProgress (IEntity pUser, BaseUserAction pPerformedAction, float fProgress, float fDuration)
	Override to handle what should happen when action is being "ticked".
void	OnActionFinish (IEntity pUser, BaseUserAction pFinishedAction, ActionFinishReason eFinishReason)
	Override to handle what should happen when an action ends.
void	ShowDisplay ()
	Override to handle what should happen when display is supposed to show when it was previously closed.
void	HideDisplay ()
	Override to handle what should happen when display is supposed to hide when it was previously shown.
void	SetDisplayData (ActionDisplayData data)
	Data provided by the interaction handler.
Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)
override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.
Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)
SCR_InfoDisplayInvoker	GetOnStart ()
SCR_InfoDisplayInvoker	GetOnStop ()
IEntity	GetOwnerEntity ()
Widget	GetContentWidget ()
string	GetContentWidgetName ()
void	SetRootWidget (notnull Widget root)
void	SetContentWidget (notnull Widget content)
void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.
bool	IsShown ()
Widget	GetRootWidget ()
bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.
bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.
void	RegisterToHudManager ()
Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)
Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Public Attributes
ResourceName	m_sElementLayout
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder

Protected Member Functions
void	Create ()
	Creates and initializes root widget to be slotted with actions.
void	Destroy ()
bool	Update (ActionsTuple pActionsData, BaseUserAction pSelectedAction, UserActionContext pCurrentContext, float fTimeSlice)
bool	GetSafeZone (vector worldPosition, vector screenPosition, vector min01, vector max01, out vector clampedPosition)
void	SetScreenPosition (vector screenPosition)
Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)
void	DisplayStartDraw (IEntity owner)
void	DisplayStopDraw (IEntity owner)
void	DisplayInit (IEntity owner)
void	DisplayUpdate (IEntity owner, float timeSlice)
void	DisplayControlledEntityChanged (IEntity from, IEntity to)
void	DisplayConsciousnessChanged (bool conscious, bool init=false)
void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.
void	DisplayOnResumed ()
void	InitializeInterfaceSettings ()
void	OnSettingsChanged ()
Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
override void	OnStartDraw (IEntity owner)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
override void	OnStopDraw (IEntity owner)
override void	UpdateValues (IEntity owner, float timeSlice)
override void	OnInit (IEntity owner)
void	OnInit (IEntity owner)
void	UpdateValues (IEntity owner, float timeSlice)
void	OnStartDraw (IEntity owner)
void	OnStopDraw (IEntity owner)

Protected Attributes
bool	m_bFixedPlacement
float	m_fScrollAnimationSpeed
float	m_fAutoExpandTime
float	m_fFadeInSpeed
float	m_fFadeInOffset
EActionMenu	m_eState = EActionMenu.UNDEFINED
Widget	m_wActionMenu
Widget	m_wActionButton
Widget	m_wArrowUp
Widget	m_wArrowDown
Widget	m_wHoldText
ImageWidget	m_wArrowIcon
ref map< BaseUserAction, ActionMenuElement >	m_mActionWidget = new map<BaseUserAction,ActionMenuElement>
ref array< ref ActionMenuElement >	m_aActionMenuElements = new array<ref ActionMenuElement>
int	m_iCurrentScroll = 0
float	m_fCurrentScrollAnimation = 0.0
float	m_fExpandTimer = 0.0
float	m_fExpandedTimer = 0.0
UserActionContext	m_pPrevContext = null
ref ActionDisplayData	m_pLastData
Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled
string	m_sInterfaceSettingName
SCR_PlayerController	m_PlayerController
SCR_CharacterControllerComponent	m_CharacterController
SCR_CharacterCameraHandlerComponent	m_CameraHandler
MenuManager	m_MenuManager
EventHandlerManagerComponent	m_EventHandlerManager
SCR_EditorManagerEntity	m_EditorManager
bool	m_bAttachedToPlayerController
bool	m_bInThirdPerson
bool	m_bInADS
bool	m_bIsUnconscious
bool	m_bInPauseMenu
bool	m_bInEditor
bool	m_bCanShow
bool	m_bIsEnabledInSettings = true
bool	m_bShowInAllCameras = true
Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot
string	m_sContentWidget
int	m_iContentWidthAdjustment
int	m_iContentHeightAdjustment
string	m_sAdaptiveOpacityWidgetName
ref array< ref SCR_InfoDisplayHandler >	m_aHandlers
bool	m_bShown
Widget	m_wRoot
Widget	m_wContent
Widget	m_wSlot
SCR_HUDManagerComponent	m_HUDManager
int	m_iChildDisplays = 0
ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>
SCR_InfoDisplay	m_pParentDisplay
bool	m_bRegistered = false
IEntity	m_OwnerEntity
ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}
ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()
ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Static Protected Attributes
const float	CONTINUES_ACTION_RESET_HOLD = 0.25

Constructor & Destructor Documentation

~SCR_ActionMenuInteractionDisplay()

void SCR_ActionMenuInteractionDisplay.~SCR_ActionMenuInteractionDisplay

(

)

Member Function Documentation

Collapse()

void SCR_ActionMenuInteractionDisplay.Collapse

(

)

Create()

void SCR_ActionMenuInteractionDisplay.Create ( )

protected

Creates and initializes root widget to be slotted with actions.

Destroy()

void SCR_ActionMenuInteractionDisplay.Destroy ( )

protected

DisplayStartDraw()

override void SCR_ActionMenuInteractionDisplay.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayStopDraw()

override void SCR_ActionMenuInteractionDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

Expand()

void SCR_ActionMenuInteractionDisplay.Expand

(

)

GetSafeZone()

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

protected

HideDisplay()

override void SCR_ActionMenuInteractionDisplay.HideDisplay

(

)

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

Implements SCR_BaseInteractionDisplay.

OnActionFinish()

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

Called when an action is finished.

Implements SCR_BaseInteractionDisplay.

OnActionProgress()

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

Called when action is being performed.

Implements SCR_BaseInteractionDisplay.

OnActionStart()

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

Called when action starts being performed.

Implements SCR_BaseInteractionDisplay.

RunExpandedTimer()

void SCR_ActionMenuInteractionDisplay.RunExpandedTimer

(

float

fTimeSlice

)

RunExpandTimer()

void SCR_ActionMenuInteractionDisplay.RunExpandTimer

(

float

fTimeSlice

)

SetDisplayData()

override void SCR_ActionMenuInteractionDisplay.SetDisplayData

(

ActionDisplayData

data

)

Data provided by the interaction handler.

Implements SCR_BaseInteractionDisplay.

SetPosition()

void SCR_ActionMenuInteractionDisplay.SetPosition

(

vector

vWorldPosition

)

SetScreenPosition()

void SCR_ActionMenuInteractionDisplay.SetScreenPosition ( vector  screenPosition )

protected

SetScroll()

void SCR_ActionMenuInteractionDisplay.SetScroll	(	int	iCurrentScroll,
		float	fTimeSlice = 0
	)

ShowDisplay()

override void SCR_ActionMenuInteractionDisplay.ShowDisplay

(

)

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

Implements SCR_BaseInteractionDisplay.

Update()

bool SCR_ActionMenuInteractionDisplay.Update ( ActionsTuple  pActionsData, BaseUserAction  pSelectedAction, UserActionContext  pCurrentContext, float  fTimeSlice  )

protected

UpdateArrow()

void SCR_ActionMenuInteractionDisplay.UpdateArrow	(	Widget	w,
		EActionMenuScroll	state
	)

Member Data Documentation

CONTINUES_ACTION_RESET_HOLD

const float SCR_ActionMenuInteractionDisplay.CONTINUES_ACTION_RESET_HOLD = 0.25

staticprotected

m_aActionMenuElements

ref array<ref ActionMenuElement> SCR_ActionMenuInteractionDisplay.m_aActionMenuElements = new array<ref ActionMenuElement>

protected

m_bFixedPlacement

bool SCR_ActionMenuInteractionDisplay.m_bFixedPlacement

protected

m_eState

EActionMenu SCR_ActionMenuInteractionDisplay.m_eState = EActionMenu.UNDEFINED

protected

m_fAutoExpandTime

float SCR_ActionMenuInteractionDisplay.m_fAutoExpandTime

protected

m_fCurrentScrollAnimation

float SCR_ActionMenuInteractionDisplay.m_fCurrentScrollAnimation = 0.0

protected

m_fExpandedTimer

float SCR_ActionMenuInteractionDisplay.m_fExpandedTimer = 0.0

protected

m_fExpandTimer

float SCR_ActionMenuInteractionDisplay.m_fExpandTimer = 0.0

protected

m_fFadeInOffset

float SCR_ActionMenuInteractionDisplay.m_fFadeInOffset

protected

m_fFadeInSpeed

float SCR_ActionMenuInteractionDisplay.m_fFadeInSpeed

protected

m_fScrollAnimationSpeed

float SCR_ActionMenuInteractionDisplay.m_fScrollAnimationSpeed

protected

m_iCurrentScroll

int SCR_ActionMenuInteractionDisplay.m_iCurrentScroll = 0

protected

m_mActionWidget

ref map<BaseUserAction,ActionMenuElement> SCR_ActionMenuInteractionDisplay.m_mActionWidget = new map<BaseUserAction,ActionMenuElement>

protected

m_pLastData

ref ActionDisplayData SCR_ActionMenuInteractionDisplay.m_pLastData

protected

m_pPrevContext

UserActionContext SCR_ActionMenuInteractionDisplay.m_pPrevContext = null

protected

m_sElementLayout

ResourceName SCR_ActionMenuInteractionDisplay.m_sElementLayout

m_wActionButton

Widget SCR_ActionMenuInteractionDisplay.m_wActionButton

protected

m_wActionMenu

Widget SCR_ActionMenuInteractionDisplay.m_wActionMenu

protected

m_wArrowDown

Widget SCR_ActionMenuInteractionDisplay.m_wArrowDown

protected

m_wArrowIcon

ImageWidget SCR_ActionMenuInteractionDisplay.m_wArrowIcon

protected

m_wArrowUp

Widget SCR_ActionMenuInteractionDisplay.m_wArrowUp

protected

m_wHoldText

Widget SCR_ActionMenuInteractionDisplay.m_wHoldText

protected

---

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

• Game/Interactions/Display/SCR_ActionMenuInteractionDisplay.c