SCR_InfoDisplay.c File Reference

Go to the source code of this file.

Typedefs
typedef func	SCR_InfoDisplayStartStopCallback
typedef ScriptInvokerBase< SCR_InfoDisplayStartStopCallback >	SCR_InfoDisplayInvoker

Enumerations
enum	EWidgetAnchor

Functions
void	SCR_InfoDisplayStartStopCallback (SCR_InfoDisplay display)
enum EWidgetAnchor	Attribute ("", UIWidgets.ResourceNamePicker, "Layout", "layout")] ResourceName m_LayoutPath
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)
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
bool	IsShown ()
Widget	GetRootWidget ()
bool	GetDimensions (out float width, out float height, bool addSafezones=true)
bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
void	RegisterToHudManager ()
override event void	OnStartDraw (IEntity owner)
void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
override event void	OnStopDraw (IEntity owner)
override event void	UpdateValues (IEntity owner, float timeSlice)
override event void	OnInit (IEntity owner)

Variables
	TOPLEFT
	TOP
	TOPRIGHT
	LEFT
	CENTER
	RIGHT
	BOTTOMLEFT
	BOTTOM
	BOTTOMRIGHT
EHudLayers	m_eLayer
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()

Typedef Documentation

SCR_InfoDisplayInvoker

typedef ScriptInvokerBase<SCR_InfoDisplayStartStopCallback> SCR_InfoDisplayInvoker

Definition at line 3 of file SCR_InfoDisplay.c.

SCR_InfoDisplayStartStopCallback

typedef func SCR_InfoDisplayStartStopCallback

Definition at line 2 of file SCR_InfoDisplay.c.

Enumeration Type Documentation

EWidgetAnchor

enum EWidgetAnchor

Definition at line 8 of file SCR_InfoDisplay.c.

Function Documentation

AdaptiveOpacity_Update()

void AdaptiveOpacity_Update ( float opacity, float sceneBrightness, bool init = false )

protected

Definition at line 472 of file SCR_InfoDisplay.c.

Attribute()

enum EWidgetAnchor Attribute	(	""	,
		UIWidgets.	ResourceNamePicker,
		"Layout"	,
		"layout"	)

GetAnchorPosition()

bool GetAnchorPosition ( out float x, out float y, EWidgetAnchor anchor = EWidgetAnchor.TOPLEFT, bool addSafezones = true )

protected

Get width and height of the InfoDisplay element, optionally with safezones adjustments

Parameters

[out]	x
[out]	y
	anchor
	addSafezones

Returns

false if content widget is null, true otherwise

Definition at line 265 of file SCR_InfoDisplay.c.

GetContentWidget()

Widget GetContentWidget ( )

protected

Definition at line 110 of file SCR_InfoDisplay.c.

GetContentWidgetName()

string GetContentWidgetName ( )

protected

Definition at line 116 of file SCR_InfoDisplay.c.

GetDimensions()

bool GetDimensions ( out float width, out float height, bool addSafezones = true )

protected

Get width and height of the InfoDisplay element, optionally with safezones adjustments

Parameters

[out]	width
[out]	height
	addSafezones

Returns

false if content widget is null, true otherwise

Definition at line 234 of file SCR_InfoDisplay.c.

GetHandler()

SCR_InfoDisplayHandler GetHandler ( typename handlerType )

protected

Definition at line 80 of file SCR_InfoDisplay.c.

GetOnStart()

SCR_InfoDisplayInvoker GetOnStart ( )

protected

Definition at line 92 of file SCR_InfoDisplay.c.

GetOnStop()

SCR_InfoDisplayInvoker GetOnStop ( )

protected

Definition at line 98 of file SCR_InfoDisplay.c.

GetOwnerEntity()

IEntity GetOwnerEntity ( )

protected

Definition at line 104 of file SCR_InfoDisplay.c.

GetRootWidget()

Widget GetRootWidget ( )

protected

Definition at line 223 of file SCR_InfoDisplay.c.

IsShown()

bool IsShown ( )

protected

Definition at line 217 of file SCR_InfoDisplay.c.

OnShownFinished()

void OnShownFinished ( Widget w, float targetOpacity, WidgetAnimationOpacity anim = null )

protected

Definition at line 209 of file SCR_InfoDisplay.c.

OnStartDraw()

override event void OnStartDraw ( IEntity owner )

protected

Definition at line 408 of file SCR_InfoDisplay.c.

OnStopDraw()

override event void OnStopDraw ( IEntity owner )

protected

Definition at line 520 of file SCR_InfoDisplay.c.

RegisterToHudManager()

void RegisterToHudManager ( )

protected

Definition at line 344 of file SCR_InfoDisplay.c.

SCR_InfoDisplayStartStopCallback()

void SCR_InfoDisplayStartStopCallback

(

SCR_InfoDisplay

display

)

SetContentWidget()

void SetContentWidget ( notnull Widget content )

protected

Definition at line 128 of file SCR_InfoDisplay.c.

SetRootWidget()

void SetRootWidget ( notnull Widget root )

protected

Definition at line 122 of file SCR_InfoDisplay.c.

Show()

void Show ( bool show, float speed = UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve = EAnimationCurve.LINEAR )

protected

Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility. Use this method instead of SetVisible/SetOpacity.

Parameters

show	true to show, false to hide
speed	fade rate, default 0
curve	hiding interpolation, default linear

Definition at line 138 of file SCR_InfoDisplay.c.

UpdateValues()

override event void UpdateValues ( IEntity owner, float timeSlice )

protected

Definition at line 547 of file SCR_InfoDisplay.c.

Variable Documentation

BOTTOM

@ BOTTOM

Definition at line 7 of file SCR_InfoDisplay.c.

BOTTOMLEFT

BOTTOMLEFT

Definition at line 6 of file SCR_InfoDisplay.c.

BOTTOMRIGHT

BOTTOMRIGHT

Definition at line 8 of file SCR_InfoDisplay.c.

CENTER

@ CENTER

Definition at line 4 of file SCR_InfoDisplay.c.

LEFT

@ LEFT

Definition at line 3 of file SCR_InfoDisplay.c.

m_aChildDisplays

ref array<BaseInfoDisplay> m_aChildDisplays = new array<BaseInfoDisplay>

protected

Definition at line 69 of file SCR_InfoDisplay.c.

m_aHandlers

ref array<ref SCR_InfoDisplayHandler> m_aHandlers

protected

Definition at line 57 of file SCR_InfoDisplay.c.

m_aUpdatableHandlers

ref array<ref SCR_InfoDisplayHandler> m_aUpdatableHandlers = {}

protected

Definition at line 74 of file SCR_InfoDisplay.c.

m_bRegistered

bool m_bRegistered = false

protected

Definition at line 71 of file SCR_InfoDisplay.c.

m_bShown

bool m_bShown

protected

Definition at line 61 of file SCR_InfoDisplay.c.

m_eLayer

EHudLayers m_eLayer

Definition at line 28 of file SCR_InfoDisplay.c.

m_HUDManager

SCR_HUDManagerComponent m_HUDManager

protected

Definition at line 66 of file SCR_InfoDisplay.c.

m_iChildDisplays

int m_iChildDisplays = 0

protected

Definition at line 68 of file SCR_InfoDisplay.c.

m_iContentHeightAdjustment

int m_iContentHeightAdjustment

protected

Definition at line 47 of file SCR_InfoDisplay.c.

m_iContentWidthAdjustment

int m_iContentWidthAdjustment

protected

Definition at line 44 of file SCR_InfoDisplay.c.

m_OnStart

ref SCR_InfoDisplayInvoker m_OnStart = new SCR_InfoDisplayInvoker()

protected

Definition at line 76 of file SCR_InfoDisplay.c.

m_OnStop

ref SCR_InfoDisplayInvoker m_OnStop = new SCR_InfoDisplayInvoker()

protected

Definition at line 77 of file SCR_InfoDisplay.c.

m_OwnerEntity

IEntity m_OwnerEntity

protected

Definition at line 73 of file SCR_InfoDisplay.c.

m_pParentDisplay

SCR_InfoDisplay m_pParentDisplay

protected

Definition at line 70 of file SCR_InfoDisplay.c.

m_sAdaptiveOpacityWidgetName

string m_sAdaptiveOpacityWidgetName

protected

Definition at line 54 of file SCR_InfoDisplay.c.

m_sContentWidget

string m_sContentWidget

protected

Definition at line 41 of file SCR_InfoDisplay.c.

m_sParentSlot

string m_sParentSlot

protected

Definition at line 37 of file SCR_InfoDisplay.c.

m_wContent

Widget m_wContent

protected

Definition at line 64 of file SCR_InfoDisplay.c.

m_wRoot

Widget m_wRoot

protected

Definition at line 63 of file SCR_InfoDisplay.c.

m_wSlot

Widget m_wSlot

protected

Definition at line 65 of file SCR_InfoDisplay.c.

RIGHT

@ RIGHT

Definition at line 5 of file SCR_InfoDisplay.c.

TOP

@ TOP

Definition at line 1 of file SCR_InfoDisplay.c.

TOPLEFT

TOPLEFT

Definition at line 0 of file SCR_InfoDisplay.c.

TOPRIGHT

TOPRIGHT

Definition at line 2 of file SCR_InfoDisplay.c.