SCR_WaypointDisplay Interface Reference

Waypoint UI Attached to SCR_HUDManagerComponent which is a component of SCR_PlayerController. More...

Inheritance diagram for SCR_WaypointDisplay:

Public Member Functions
SCR_Waypoint	FindWaypointByEntity (IEntity entity)
void	GetWaypoints (out array< ref SCR_Waypoint > waypoints)
void	DeleteWaypoint (SCR_Waypoint waypoint)
SCR_Waypoint	CreateWaypoint (vector position)
SCR_Waypoint	CreateWaypoint (IEntity entity)
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)
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
bool	HandleWidgetOpacities (notnull SCR_Waypoint waypoint, notnull IEntity player)
Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)
void	DisplayStartDraw (IEntity owner)
void	DisplayStopDraw (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
ResourceName	m_sWaypointLayout = "{825C6D728AC3E02A}UI/layouts/Waypoint/Waypoint.layout"
ref array< ref SCR_Waypoint >	m_aWaypoints
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()

Static Protected Attributes
static string	DISTANCE_STRING_UNIT = "#AR-Tutorial_WaypointUnits_meters"
static float	WAYPOINT_FADE_THRESHOLD = 20
static float	WAYPOINT_MINIMUM_OPACITY = 0.2
static float	WAYPOINT_DISTANCE_INDICATOR_FADE_START = 100
static float	WAYPOINT_DISTANCE_INDICATOR_FADE_END = 50
static float	WAYPOINT_FADE_IN_DISTANCE = 3

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

Detailed Description

Waypoint UI Attached to SCR_HUDManagerComponent which is a component of SCR_PlayerController.

Member Function Documentation

CreateWaypoint() [1/2]

SCR_Waypoint SCR_WaypointDisplay.CreateWaypoint

(

IEntity

entity

)

CreateWaypoint() [2/2]

SCR_Waypoint SCR_WaypointDisplay.CreateWaypoint

(

vector

position

)

DeleteWaypoint()

void SCR_WaypointDisplay.DeleteWaypoint

(

SCR_Waypoint

waypoint

)

DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

FindWaypointByEntity()

SCR_Waypoint SCR_WaypointDisplay.FindWaypointByEntity

(

IEntity

entity

)

GetWaypoints()

void SCR_WaypointDisplay.GetWaypoints

(

out array< ref SCR_Waypoint >

waypoints

)

HandleWidgetOpacities()

bool SCR_WaypointDisplay.HandleWidgetOpacities ( notnull SCR_Waypoint waypoint, notnull IEntity player )

protected

Member Data Documentation

DISTANCE_STRING_UNIT

string SCR_WaypointDisplay.DISTANCE_STRING_UNIT = "#AR-Tutorial_WaypointUnits_meters"

staticprotected

m_aWaypoints

ref array<ref SCR_Waypoint> SCR_WaypointDisplay.m_aWaypoints

protected

m_sWaypointLayout

ResourceName SCR_WaypointDisplay.m_sWaypointLayout = "{825C6D728AC3E02A}UI/layouts/Waypoint/Waypoint.layout"

protected

WAYPOINT_DISTANCE_INDICATOR_FADE_END

float SCR_WaypointDisplay.WAYPOINT_DISTANCE_INDICATOR_FADE_END = 50

staticprotected

WAYPOINT_DISTANCE_INDICATOR_FADE_START

float SCR_WaypointDisplay.WAYPOINT_DISTANCE_INDICATOR_FADE_START = 100

staticprotected

WAYPOINT_FADE_IN_DISTANCE

float SCR_WaypointDisplay.WAYPOINT_FADE_IN_DISTANCE = 3

staticprotected

WAYPOINT_FADE_THRESHOLD

float SCR_WaypointDisplay.WAYPOINT_FADE_THRESHOLD = 20

staticprotected

WAYPOINT_MINIMUM_OPACITY

float SCR_WaypointDisplay.WAYPOINT_MINIMUM_OPACITY = 0.2

staticprotected

---

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

• Game/UI/Waypoint/SCR_WaypointDisplay.c