SCR_EditorPingInfoDisplay Interface Reference

Communication with game master. More...

Inheritance diagram for SCR_EditorPingInfoDisplay:

Public Member Functions
override void	UpdateValues (IEntity owner, float timeSlice)
override void	OnStartDraw (IEntity owner)
override void	OnStopDraw (IEntity owner)
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	OnEditorPingAction (float value, EActionTrigger reason)
void	OnEditorPingUnlimitedOnlyAction (float value, EActionTrigger reason)
void	SendPing (bool unlimitedOnly)
void	OnPingEntityRegister (int reporterID, SCR_EditableEntityComponent pingEntity)
void	OnPingEntityUnregister (int reporterID, SCR_EditableEntityComponent pingEntity)
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)
override void	OnInit (IEntity owner)

Protected Attributes
ResourceName	m_WidgetPrefab
ResourceName	m_SlotWidgetPrefab
bool	m_bCanUpdate
WorkspaceWidget	m_Workspace
SCR_PingEditorComponent	m_PingManager
ref map< SCR_EditableEntityComponent, SCR_EditableEntitySceneSlotUIComponent >	m_EntitySlots = new map<SCR_EditableEntityComponent, SCR_EditableEntitySceneSlotUIComponent>
ref map< SCR_EditableEntityComponent, Widget >	m_EntityWidgets = new map<SCR_EditableEntityComponent, Widget>
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

Communication with game master.

ToDo: Use some general GUD icon drawing?

Member Function Documentation

OnEditorPingAction()

void SCR_EditorPingInfoDisplay.OnEditorPingAction ( float value, EActionTrigger reason )

protected

OnEditorPingUnlimitedOnlyAction()

void SCR_EditorPingInfoDisplay.OnEditorPingUnlimitedOnlyAction ( float value, EActionTrigger reason )

protected

OnPingEntityRegister()

void SCR_EditorPingInfoDisplay.OnPingEntityRegister ( int reporterID, SCR_EditableEntityComponent pingEntity )

protected

OnPingEntityUnregister()

void SCR_EditorPingInfoDisplay.OnPingEntityUnregister ( int reporterID, SCR_EditableEntityComponent pingEntity )

protected

OnStartDraw()

override void SCR_EditorPingInfoDisplay.OnStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplay.

OnStopDraw()

override void SCR_EditorPingInfoDisplay.OnStopDraw

(

IEntity

owner

)

Implements SCR_InfoDisplay.

SendPing()

void SCR_EditorPingInfoDisplay.SendPing ( bool unlimitedOnly )

protected

UpdateValues()

override void SCR_EditorPingInfoDisplay.UpdateValues	(	IEntity	owner,
		float	timeSlice )

Implements SCR_InfoDisplay.

Member Data Documentation

m_bCanUpdate

bool SCR_EditorPingInfoDisplay.m_bCanUpdate

protected

m_EntitySlots

ref map<SCR_EditableEntityComponent, SCR_EditableEntitySceneSlotUIComponent> SCR_EditorPingInfoDisplay.m_EntitySlots = new map<SCR_EditableEntityComponent, SCR_EditableEntitySceneSlotUIComponent>

protected

m_EntityWidgets

ref map<SCR_EditableEntityComponent, Widget> SCR_EditorPingInfoDisplay.m_EntityWidgets = new map<SCR_EditableEntityComponent, Widget>

protected

m_PingManager

SCR_PingEditorComponent SCR_EditorPingInfoDisplay.m_PingManager

protected

m_SlotWidgetPrefab

ResourceName SCR_EditorPingInfoDisplay.m_SlotWidgetPrefab

protected

m_WidgetPrefab

ResourceName SCR_EditorPingInfoDisplay.m_WidgetPrefab

protected

m_Workspace

WorkspaceWidget SCR_EditorPingInfoDisplay.m_Workspace

protected

---

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

• Game/Editor/UI/InfoDisplays/SCR_EditorPingInfoDisplay.c