Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_ActionMenuInteractionDisplay Interface Reference
Inheritance diagram for SCR_ActionMenuInteractionDisplay:
SCR_BaseInteractionDisplay SCR_InfoDisplayExtended SCR_InfoDisplay GroupInfoDisplay BaseInfoDisplay

Public Member Functions

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 ForceUpdateUI ()
 Allows for external functions to request a UI update.
 
void ~SCR_ActionMenuInteractionDisplay ()
 
- 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)
 
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
 
ResourceName m_sSnackBarLayout
 
- 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 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)
 Itterates through all shown actions and applies the correct padding & opacity.
 
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 ()
 
void CompareNewDateWithOld (ActionDisplayData data)
 Hackfix: We are trying to find clues if we need to update the UI based on the acton data.
 
- Protected Member Functions inherited from SCR_InfoDisplayExtended
bool DisplayStartDrawInit (IEntity owner)
 
void DisplayInit (IEntity owner)
 
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)
 
void AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
 

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_NearbyContextColorsComponentInteractm_aNearbyWidgetColors
 
ref SCR_ActionMenuLayoutWidgets m_Widgets = new SCR_ActionMenuLayoutWidgets()
 
ref SCR_SnackBarController m_SnackBar
 
ref array< ref SCR_ActionMenuElementComponentm_aActionMenuElements = {}
 
ref array< ref SCR_ActionMenuElementComponentm_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_bForceResetScroll bool m_bProgressReachedMax
 
bool m_bIsActionEnabled
 
int m_iContextCount
 
ref TStringArray m_aCurrentContextNames
 
ref map< SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteractm_mCachedActionColors
 Holds all the different cached id with the enum as key.
 
float m_fTotalHeightElements
 
- 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_InfoDisplayHandlerm_aHandlers
 
bool m_bShown
 
Widget m_wRoot
 
Widget m_wContent
 
Widget m_wSlot
 
SCR_HUDManagerComponent m_HUDManager
 
int m_iChildDisplays = 0
 
ref array< BaseInfoDisplaym_aChildDisplays = new array<BaseInfoDisplay>
 
SCR_InfoDisplay m_pParentDisplay
 
bool m_bRegistered = false
 
IEntity m_OwnerEntity
 
ref array< ref SCR_InfoDisplayHandlerm_aUpdatableHandlers = {}
 
ref SCR_InfoDisplayInvoker m_OnStart = new SCR_InfoDisplayInvoker()
 
ref SCR_InfoDisplayInvoker m_OnStop = new SCR_InfoDisplayInvoker()
 

Static Protected Attributes

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"
 

Constructor & Destructor Documentation

◆ ~SCR_ActionMenuInteractionDisplay()

void SCR_ActionMenuInteractionDisplay.~SCR_ActionMenuInteractionDisplay ( )

Member Function Documentation

◆ Collapse()

void SCR_ActionMenuInteractionDisplay.Collapse ( )
protected

◆ CompareNewDateWithOld()

void SCR_ActionMenuInteractionDisplay.CompareNewDateWithOld ( ActionDisplayData data)
protected

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

◆ 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)

◆ DisplayStopDraw()

override void SCR_ActionMenuInteractionDisplay.DisplayStopDraw ( IEntity owner)

◆ DisplayUpdate()

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

◆ Expand()

void SCR_ActionMenuInteractionDisplay.Expand ( )
protected

◆ ForceUpdateUI()

void SCR_ActionMenuInteractionDisplay.ForceUpdateUI ( )

Allows for external functions to request a UI update.

◆ GetButtonFadeInSpeed()

float SCR_ActionMenuInteractionDisplay.GetButtonFadeInSpeed ( )
protected

◆ 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)
protected
Parameters
[in]fTimeSlice

◆ RunExpandTimer()

void SCR_ActionMenuInteractionDisplay.RunExpandTimer ( float fTimeSlice)
protected
Parameters
[in]fTimeSlice

◆ SetDisplayData()

override void SCR_ActionMenuInteractionDisplay.SetDisplayData ( ActionDisplayData data)

Data provided by the interaction handler.

Implements SCR_BaseInteractionDisplay.

◆ SetPaggingEffect()

void SCR_ActionMenuInteractionDisplay.SetPaggingEffect ( int currentAction,
bool scrollingDown )
protected

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

Parameters
[in]intcurrent action

◆ SetPosition()

void SCR_ActionMenuInteractionDisplay.SetPosition ( vector worldPosition)
protected
Parameters
[in]worldPosition

◆ SetScroll()

void SCR_ActionMenuInteractionDisplay.SetScroll ( int currentScroll,
float timeSlice = 0 )
protected
Parameters
[in]currentScrollwhich element in the list are we on
[in]timeSliceelasped time since the last frame

◆ 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 actionsData,
BaseUserAction selectedAction,
UserActionContext currentContext,
float fTimeSlice )
protected

◆ UpdateAnimateActions()

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

◆ UpdateDisplayActions()

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

Member Data Documentation

◆ ANCHOR_X

const float SCR_ActionMenuInteractionDisplay.ANCHOR_X = 0.48
staticprotected

◆ ANCHOR_Y

const float SCR_ActionMenuInteractionDisplay.ANCHOR_Y = 0.94
staticprotected

◆ m_aActionMenuElements

ref array<ref SCR_ActionMenuElementComponent> SCR_ActionMenuInteractionDisplay.m_aActionMenuElements = {}
protected

◆ m_aActiveActionMenuElements

ref array<ref SCR_ActionMenuElementComponent> SCR_ActionMenuInteractionDisplay.m_aActiveActionMenuElements = {}
protected

◆ m_aCurrentContextNames

ref TStringArray SCR_ActionMenuInteractionDisplay.m_aCurrentContextNames
protected

◆ m_aNearbyWidgetColors

ref array<ref SCR_NearbyContextColorsComponentInteract> SCR_ActionMenuInteractionDisplay.m_aNearbyWidgetColors
protected

◆ m_bFixedPlacement

bool SCR_ActionMenuInteractionDisplay.m_bFixedPlacement
protected

◆ m_bForceUpdate

bool SCR_ActionMenuInteractionDisplay.m_bForceUpdate
protected

◆ m_bIsActionEnabled

bool SCR_ActionMenuInteractionDisplay.m_bIsActionEnabled
protected

◆ m_bIsSingleEntryMenu

bool SCR_ActionMenuInteractionDisplay.m_bIsSingleEntryMenu
protected

◆ m_bProgressReachedMax

bool m_bForceResetScroll bool SCR_ActionMenuInteractionDisplay.m_bProgressReachedMax
protected

◆ m_bShouldDisplaySnackBar

bool SCR_ActionMenuInteractionDisplay.m_bShouldDisplaySnackBar
protected

◆ m_DisabledColor

ref Color SCR_ActionMenuInteractionDisplay.m_DisabledColor
protected

◆ m_DisabledColorGlow

ref Color SCR_ActionMenuInteractionDisplay.m_DisabledColorGlow
protected

◆ m_EnabledColor

ref Color SCR_ActionMenuInteractionDisplay.m_EnabledColor
protected

◆ m_fAutoExpandTime

float SCR_ActionMenuInteractionDisplay.m_fAutoExpandTime
protected

◆ m_fButtonFadeInSpeed

float SCR_ActionMenuInteractionDisplay.m_fButtonFadeInSpeed
protected

◆ m_fCurrentScrollAnimation

float SCR_ActionMenuInteractionDisplay.m_fCurrentScrollAnimation
protected

◆ m_fExpandedTimer

float SCR_ActionMenuInteractionDisplay.m_fExpandedTimer
protected

◆ m_fExpandTimer

float SCR_ActionMenuInteractionDisplay.m_fExpandTimer
protected

◆ m_fFadeInOffset

float SCR_ActionMenuInteractionDisplay.m_fFadeInOffset
protected

◆ m_fHeightElement

float SCR_ActionMenuInteractionDisplay.m_fHeightElement
protected

◆ m_fScrollAnimationSpeed

float SCR_ActionMenuInteractionDisplay.m_fScrollAnimationSpeed
protected

◆ m_fSnackBarAppearTimer

float SCR_ActionMenuInteractionDisplay.m_fSnackBarAppearTimer
protected

◆ m_fSnackBarOpacityTimer

float SCR_ActionMenuInteractionDisplay.m_fSnackBarOpacityTimer
protected

◆ m_fTimeSpentAdditionalInfo

float SCR_ActionMenuInteractionDisplay.m_fTimeSpentAdditionalInfo
protected

◆ m_fTotalHeightElements

float SCR_ActionMenuInteractionDisplay.m_fTotalHeightElements
protected

◆ m_fWaitTimeAdditionalInfo

float SCR_ActionMenuInteractionDisplay.m_fWaitTimeAdditionalInfo
protected

◆ m_iContextCount

int SCR_ActionMenuInteractionDisplay.m_iContextCount
protected

◆ m_iCurrentScroll

int SCR_ActionMenuInteractionDisplay.m_iCurrentScroll
protected

◆ m_InteractionHandlerComponent

InteractionHandlerComponent SCR_ActionMenuInteractionDisplay.m_InteractionHandlerComponent
protected

◆ m_LastData

ref ActionDisplayData SCR_ActionMenuInteractionDisplay.m_LastData
protected

◆ m_mCachedActionColors

ref map<SCR_ENearbyInteractionContextColors, ref SCR_NearbyContextColorsComponentInteract> SCR_ActionMenuInteractionDisplay.m_mCachedActionColors
protected

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

◆ m_PerformingColor

ref Color SCR_ActionMenuInteractionDisplay.m_PerformingColor
protected

◆ m_PrevAction

BaseUserAction SCR_ActionMenuInteractionDisplay.m_PrevAction
protected

◆ m_PrevContext

UserActionContext SCR_ActionMenuInteractionDisplay.m_PrevContext
protected

◆ m_sElementLayout

ResourceName SCR_ActionMenuInteractionDisplay.m_sElementLayout

◆ m_SnackBar

ref SCR_SnackBarController SCR_ActionMenuInteractionDisplay.m_SnackBar
protected

◆ m_sSnackBarLayout

ResourceName SCR_ActionMenuInteractionDisplay.m_sSnackBarLayout

◆ m_Widgets

ref SCR_ActionMenuLayoutWidgets SCR_ActionMenuInteractionDisplay.m_Widgets = new SCR_ActionMenuLayoutWidgets()
protected

◆ SAFEZONE_PADDING

const float SCR_ActionMenuInteractionDisplay.SAFEZONE_PADDING = 15.0
staticprotected

◆ SCREEN_POS_MAX

const vector SCR_ActionMenuInteractionDisplay.SCREEN_POS_MAX = "0.85 0.85 0"
staticprotected

◆ SCREEN_POS_MIN

const vector SCR_ActionMenuInteractionDisplay.SCREEN_POS_MIN = "0.15 0.15 0"
staticprotected

◆ WIDGET_DEFAULT_OPACITY

const float SCR_ActionMenuInteractionDisplay.WIDGET_DEFAULT_OPACITY = 1.0
staticprotected

◆ WIDGET_HIDDEN_OPACITY

const float SCR_ActionMenuInteractionDisplay.WIDGET_HIDDEN_OPACITY = 0.75
staticprotected

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