SCR_HintInfoDisplay Interface Reference

Handles SCR_HintUIComponent when using InfoDisplay and HudManager slotting. More...

Inheritance diagram for SCR_HintInfoDisplay:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
override void	DisplayStopDraw (IEntity owner)
override void	DisplayUpdate (IEntity owner, float timeSlice)
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)

Protected Member Functions
void	OnHintShown (bool isShown)
	Make it visible / invisible to trigger rezising of the Group.
void	OnSlotUIResize ()
	Make InfoDisplay in-/visible when menu is changed.
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
string	m_sHintComponentWidget
SCR_HintUIComponent	m_HintComponent
SCR_InfoDisplaySlotHandler	m_SlotHandler
SCR_HUDSlotUIComponent	m_HUDSlotComponent
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()

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder

Detailed Description

Handles SCR_HintUIComponent when using InfoDisplay and HudManager slotting.

Member Function Documentation

DisplayStartDraw()

override void SCR_HintInfoDisplay.DisplayStartDraw

(

IEntity

owner

)

Change visibility to false until Hint is Shown.

Implements SCR_InfoDisplayExtended.

DisplayStopDraw()

override void SCR_HintInfoDisplay.DisplayStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplayExtended.

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

OnHintShown()

void SCR_HintInfoDisplay.OnHintShown ( bool  isShown )

protected

Make it visible / invisible to trigger rezising of the Group.

OnSlotUIResize()

void SCR_HintInfoDisplay.OnSlotUIResize ( )

protected

Make InfoDisplay in-/visible when menu is changed.

Member Data Documentation

m_HintComponent

SCR_HintUIComponent SCR_HintInfoDisplay.m_HintComponent

protected

m_HUDSlotComponent

SCR_HUDSlotUIComponent SCR_HintInfoDisplay.m_HUDSlotComponent

protected

m_sHintComponentWidget

string SCR_HintInfoDisplay.m_sHintComponentWidget

protected

m_SlotHandler

SCR_InfoDisplaySlotHandler SCR_HintInfoDisplay.m_SlotHandler

protected

---

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

• Game/UI/HUD/SCR_HintInfoDisplay.c