Inheritance diagram for SCR_PlacedCommandInfoDisplay:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)

override void	DisplayStopDraw (IEntity owner)

override void	DisplayUpdate (IEntity owner, float timeSlice)

void	FadeOutPulseDelayed ()

void	VisualizeCommand (vector targetPosition, SCR_BaseGroupCommand command)
	Initializes the visualization of the provided command.

void	SetCanUpdatePosition (bool canUpdate)

void	SetIsPreview (bool isPreview)

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
void	UpdatePosition ()

bool	IsInLineOfSight (vector point, vector transform[4])
	Performs a dot product check against threshold whether point is in line of sight of provided transformation.

void	FadeOutPulse (WidgetAnimationOpacity anim)

void	DeleteWidget (WidgetAnimationOpacity anim=null)

void	HideWidget (bool deleteWidget=false)

void	HandleVisualizationDuration ()

bool	GetWorldToScreenPosition (BaseWorld world, vector worldPosition, out float posX, out float posY, int cameraIndex=-1)
	Recalculates worldPosition to screen space.

Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (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
float	m_fCommandVisualRange

ref Curve	m_aScaleCurve

string	m_sCommandFrameWidgetName

string	m_sCommandIconWidgetName

string	m_sCommandGlowWidgetName

string	m_sCommandPulseWidgetName

string	m_sCommandPulsePreviewWidgetName

float	m_fCommandIconWidgetSize

float	m_fCommandGlowWidgetSize

float	m_fCommandPulsePreviewWidgetSize

bool	m_bCanUpdate

bool	m_bCanUpdatePosition

bool	m_bIsPreview

float	m_fDistance

vector	m_vCommandPosition

WorkspaceWidget	m_wWorkspace

Widget	m_wCommandFrameWidget

ImageWidget	m_wCommandIconWidget

ImageWidget	m_wCommandGlowWidget

ImageWidget	m_wCommandPulseWidget

ImageWidget	m_wCommandPulsePreviewWidget

ref SCR_PhysicsHelper	m_PhysicsHelper

SCR_ECommandVisualizationDuration	m_eCommandVisualizationDuration

ref TraceParam	m_TraceParam

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 const int	PULSE_WIDGET_MAX_SIZE = 70

static const float	BASE_FOV = 100

static const float	LINE_OF_SIGHT_THRESHOLD = 0.25

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Member Function Documentation

◆ DeleteWidget()

void SCR_PlacedCommandInfoDisplay.DeleteWidget ( WidgetAnimationOpacity anim = null )

protected

◆ DisplayStartDraw()

override void SCR_PlacedCommandInfoDisplay.DisplayStartDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayStopDraw()

override void SCR_PlacedCommandInfoDisplay.DisplayStopDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

◆ DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

◆ FadeOutPulse()

void SCR_PlacedCommandInfoDisplay.FadeOutPulse ( WidgetAnimationOpacity anim )

protected

◆ FadeOutPulseDelayed()

void SCR_PlacedCommandInfoDisplay.FadeOutPulseDelayed ( )

◆ GetWorldToScreenPosition()

bool SCR_PlacedCommandInfoDisplay.GetWorldToScreenPosition	(	BaseWorld	world,
		vector	worldPosition,
		out float	posX,
		out float	posY,
		int	cameraIndex = -1 )

protected

Recalculates worldPosition to screen space.

Parameters

[in]	world
[in]	worldPosition
[out]	posX	X Position on the screen
[out]	posY	Y Position on the screen
[in]	int	Camera thats being used

◆ HandleVisualizationDuration()

void SCR_PlacedCommandInfoDisplay.HandleVisualizationDuration ( )

protected

◆ HideWidget()

void SCR_PlacedCommandInfoDisplay.HideWidget ( bool deleteWidget = false )

protected

◆ IsInLineOfSight()

bool SCR_PlacedCommandInfoDisplay.IsInLineOfSight	(	vector	point,
		vector	transform[4] )

protected

Performs a dot product check against threshold whether point is in line of sight of provided transformation.

Parameters

[in] vector point Point to perform check for

Returns: true if is in line of sight, flase otherwise

◆ SetCanUpdatePosition()

void SCR_PlacedCommandInfoDisplay.SetCanUpdatePosition ( bool canUpdate )

◆ SetIsPreview()

void SCR_PlacedCommandInfoDisplay.SetIsPreview ( bool isPreview )

◆ UpdatePosition()

void SCR_PlacedCommandInfoDisplay.UpdatePosition ( )

protected

◆ VisualizeCommand()

void SCR_PlacedCommandInfoDisplay.VisualizeCommand	(	vector	targetPosition,
		SCR_BaseGroupCommand	command )

Initializes the visualization of the provided command.

Parameters

[in]	targetPosition
[in]	command

Member Data Documentation

◆ BASE_FOV

const float SCR_PlacedCommandInfoDisplay.BASE_FOV = 100

staticprotected

◆ LINE_OF_SIGHT_THRESHOLD

const float SCR_PlacedCommandInfoDisplay.LINE_OF_SIGHT_THRESHOLD = 0.25

staticprotected

◆ m_aScaleCurve

ref Curve SCR_PlacedCommandInfoDisplay.m_aScaleCurve

protected

◆ m_bCanUpdate

bool SCR_PlacedCommandInfoDisplay.m_bCanUpdate

protected

◆ m_bCanUpdatePosition

bool SCR_PlacedCommandInfoDisplay.m_bCanUpdatePosition

protected

◆ m_bIsPreview

bool SCR_PlacedCommandInfoDisplay.m_bIsPreview

protected

◆ m_eCommandVisualizationDuration

SCR_ECommandVisualizationDuration SCR_PlacedCommandInfoDisplay.m_eCommandVisualizationDuration

protected

◆ m_fCommandGlowWidgetSize

float SCR_PlacedCommandInfoDisplay.m_fCommandGlowWidgetSize

protected

◆ m_fCommandIconWidgetSize

float SCR_PlacedCommandInfoDisplay.m_fCommandIconWidgetSize

protected

◆ m_fCommandPulsePreviewWidgetSize

float SCR_PlacedCommandInfoDisplay.m_fCommandPulsePreviewWidgetSize

protected

◆ m_fCommandVisualRange

float SCR_PlacedCommandInfoDisplay.m_fCommandVisualRange

protected

◆ m_fDistance

float SCR_PlacedCommandInfoDisplay.m_fDistance

protected

◆ m_PhysicsHelper

ref SCR_PhysicsHelper SCR_PlacedCommandInfoDisplay.m_PhysicsHelper

protected

◆ m_sCommandFrameWidgetName

string SCR_PlacedCommandInfoDisplay.m_sCommandFrameWidgetName

protected

◆ m_sCommandGlowWidgetName

string SCR_PlacedCommandInfoDisplay.m_sCommandGlowWidgetName

protected

◆ m_sCommandIconWidgetName

string SCR_PlacedCommandInfoDisplay.m_sCommandIconWidgetName

protected

◆ m_sCommandPulsePreviewWidgetName

string SCR_PlacedCommandInfoDisplay.m_sCommandPulsePreviewWidgetName

protected

◆ m_sCommandPulseWidgetName

string SCR_PlacedCommandInfoDisplay.m_sCommandPulseWidgetName

protected

◆ m_TraceParam

ref TraceParam SCR_PlacedCommandInfoDisplay.m_TraceParam

protected

◆ m_vCommandPosition

vector SCR_PlacedCommandInfoDisplay.m_vCommandPosition

protected

◆ m_wCommandFrameWidget

Widget SCR_PlacedCommandInfoDisplay.m_wCommandFrameWidget

protected

◆ m_wCommandGlowWidget

ImageWidget SCR_PlacedCommandInfoDisplay.m_wCommandGlowWidget

protected

◆ m_wCommandIconWidget

ImageWidget SCR_PlacedCommandInfoDisplay.m_wCommandIconWidget

protected

◆ m_wCommandPulsePreviewWidget

ImageWidget SCR_PlacedCommandInfoDisplay.m_wCommandPulsePreviewWidget

protected

◆ m_wCommandPulseWidget

ImageWidget SCR_PlacedCommandInfoDisplay.m_wCommandPulseWidget

protected

◆ m_wWorkspace

WorkspaceWidget SCR_PlacedCommandInfoDisplay.m_wWorkspace

protected

◆ PULSE_WIDGET_MAX_SIZE

const int SCR_PlacedCommandInfoDisplay.PULSE_WIDGET_MAX_SIZE = 70

staticprotected

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

Game/UI/HUD/SCR_PlacedCommandInfoDisplay.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ DeleteWidget()

◆ DisplayStartDraw()

◆ DisplayStopDraw()

◆ DisplayUpdate()

◆ FadeOutPulse()

◆ FadeOutPulseDelayed()

◆ GetWorldToScreenPosition()

◆ HandleVisualizationDuration()

◆ HideWidget()

◆ IsInLineOfSight()

◆ SetCanUpdatePosition()

◆ SetIsPreview()

◆ UpdatePosition()

◆ VisualizeCommand()

Member Data Documentation

◆ BASE_FOV

◆ LINE_OF_SIGHT_THRESHOLD

◆ m_aScaleCurve

◆ m_bCanUpdate

◆ m_bCanUpdatePosition

◆ m_bIsPreview

◆ m_eCommandVisualizationDuration

◆ m_fCommandGlowWidgetSize

◆ m_fCommandIconWidgetSize

◆ m_fCommandPulsePreviewWidgetSize

◆ m_fCommandVisualRange

◆ m_fDistance

◆ m_PhysicsHelper

◆ m_sCommandFrameWidgetName

◆ m_sCommandGlowWidgetName

◆ m_sCommandIconWidgetName

◆ m_sCommandPulsePreviewWidgetName

◆ m_sCommandPulseWidgetName

◆ m_TraceParam

◆ m_vCommandPosition

◆ m_wCommandFrameWidget

◆ m_wCommandGlowWidget

◆ m_wCommandIconWidget

◆ m_wCommandPulsePreviewWidget

◆ m_wCommandPulseWidget

◆ m_wWorkspace

◆ PULSE_WIDGET_MAX_SIZE