SCR_BaseInteractionDisplay Interface Reference

Base class for displaying interactions in the UI. More...

Inheritance diagram for SCR_BaseInteractionDisplay:

Public Member Functions
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)
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)

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder
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)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
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()

Detailed Description

Base class for displaying interactions in the UI.

Member Function Documentation

HideDisplay()

void SCR_BaseInteractionDisplay.HideDisplay

(

)

Override to handle what should happen when display is supposed to hide when it was previously shown.

Implemented in SCR_ActionMenuInteractionDisplay.

OnActionFinish()

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

Override to handle what should happen when an action ends.

Optional method.

Parameters

pUser	The entity which stopped performing this action
pFinishedAction	The action that was performed
eFinishReason	The reason for why this action ended

Implemented in SCR_ActionMenuInteractionDisplay.

OnActionProgress()

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

Override to handle what should happen when action is being "ticked".

Optional method.

Parameters

pUser	The entity which started performing this action
pPerformedAction	The action that is being performed
fProgress	The progress of the action in seconds
fDuration	The duration of the action in seconds

Implemented in SCR_ActionMenuInteractionDisplay.

OnActionStart()

void SCR_BaseInteractionDisplay.OnActionStart	(	IEntity	pUser,
		BaseUserAction	pPerformedAction )

Override to handle what should happen when an action is performed.

Optional method.

Parameters

pUser	The entity which started performing this action
pPerformedAction	The action that was performed

Implemented in SCR_ActionMenuInteractionDisplay.

SetDisplayData()

void SCR_BaseInteractionDisplay.SetDisplayData

(

ActionDisplayData

data

)

Data provided by the interaction handler.

Implemented in SCR_ActionMenuInteractionDisplay.

ShowDisplay()

void SCR_BaseInteractionDisplay.ShowDisplay

(

)

Override to handle what should happen when display is supposed to show when it was previously closed.

Implemented in SCR_ActionMenuInteractionDisplay.

---

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

• Game/Interactions/Base/SCR_BaseInteractionDisplay.c