Base class for all vehicle UI state and damage indicators. More...

Inheritance diagram for SCR_BaseVehicleInfo:

Public Member Functions
override void	DisplayUpdate (IEntity owner, float timeSlice)

override bool	DisplayStartDrawInit (IEntity owner)

override void	DisplayStartDraw (IEntity owner)
	Create the UI.

override void	DisplayStopDraw (IEntity owner)
	Destroy the UI.

override void	DisplayInit (IEntity owner)
	Init the UI, runs 1x at the start of the game.

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)

Public Attributes
EVehicleInfoColor	m_eColor

Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Protected Member Functions
EVehicleInfoState	GetState ()
	Can be overridden to get state of actual system or linked to an event.

bool	IsBlinking ()
	Can be overridden to get state of actual system or linked to an event.

void	Scale (ImageWidget widget, float scale)

void	Scale (TextWidget widget, float scale)

void	Scale (OverlayWidget widget, float scale)

void	SetIcon (string icon)

void	SetColor (EVehicleInfoState state, EVehicleInfoColor color)

bool	UpdateRequired (EVehicleInfoState state)

Protected Member Functions inherited from SCR_InfoDisplayExtended
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_Imageset = "{3262679C50EF4F01}UI/Textures/Icons/icons_wrapperUI.imageset"

ResourceName	m_ImagesetGlow = "{00FE3DBDFD15227B}UI/Textures/Icons/icons_wrapperUI-glow.imageset"

ImageWidget	m_wIcon

ImageWidget	m_wGlow

OverlayWidget	m_wSizeOverlay

string	m_sIcon

float	m_fWidgetScale

bool	m_bShowGhost

EVehicleInfoState	m_eState = EVehicleInfoState.ERROR

bool	m_bIsBlinking

int	m_iBlinkingOffset

Color	m_aColors [5]

Color	m_aColorsGlow [5]

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
const int	ICON_SIZE = 64

Detailed Description

Base class for all vehicle UI state and damage indicators.

Member Function Documentation

◆ DisplayInit()

override void SCR_BaseVehicleInfo.DisplayInit ( IEntity owner )

Init the UI, runs 1x at the start of the game.

Implements SCR_InfoDisplayExtended.

Implemented in SCR_EngineHitZoneInfo, SCR_FuelTankInfo, SCR_GearboxHitZoneInfo, SCR_GearShiftInfo, SCR_HandBrakeInfo, SCR_HZInfoHeli, SCR_LightManagerInfo, SCR_LightManagerInfoMulti, SCR_VInfoAutoHover, SCR_VInfoParkingBrakeHeli, and SCR_WheelHitZoneInfo.

◆ DisplayStartDraw()

override void SCR_BaseVehicleInfo.DisplayStartDraw ( IEntity owner )

Create the UI.

Implements SCR_InfoDisplayExtended.

Implemented in SCR_GearShiftInfo.

◆ DisplayStartDrawInit()

override bool SCR_BaseVehicleInfo.DisplayStartDrawInit ( IEntity owner )

Implements SCR_InfoDisplayExtended.

Implemented in SCR_FuelTankInfo, SCR_GearShiftInfo, SCR_HitZoneInfo, SCR_LightManagerInfo, and SCR_LightManagerInfoMulti.

◆ DisplayStopDraw()

override void SCR_BaseVehicleInfo.DisplayStopDraw ( IEntity owner )

Destroy the UI.

Implements SCR_InfoDisplayExtended.

Implemented in SCR_HitZoneInfo, and SCR_LightManagerInfo.

◆ DisplayUpdate()

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

Implements SCR_InfoDisplayExtended.

Implemented in SCR_GearShiftInfo.

◆ GetState()

EVehicleInfoState SCR_BaseVehicleInfo.GetState ( )

protected

Can be overridden to get state of actual system or linked to an event.

Implemented in SCR_EngineHitZoneInfo, SCR_FuelTankInfo, SCR_GearboxHitZoneInfo, SCR_HandBrakeInfo, SCR_HitZoneInfo, SCR_HZInfoEngineHeli, SCR_HZInfoHeli, SCR_LightManagerInfo, SCR_LightManagerInfoMulti, SCR_VInfoAutoHover, SCR_VInfoParkingBrakeHeli, and SCR_WheelHitZoneInfo.

◆ IsBlinking()

bool SCR_BaseVehicleInfo.IsBlinking ( )

protected

Can be overridden to get state of actual system or linked to an event.

Implemented in SCR_FuelTankInfo.

◆ Scale() [1/3]

void SCR_BaseVehicleInfo.Scale	(	ImageWidget	widget,
		float	scale )

protected

◆ Scale() [2/3]

void SCR_BaseVehicleInfo.Scale	(	OverlayWidget	widget,
		float	scale )

protected

◆ Scale() [3/3]

void SCR_BaseVehicleInfo.Scale	(	TextWidget	widget,
		float	scale )

protected

Implemented in SCR_GearShiftInfo.

◆ SetColor()

void SCR_BaseVehicleInfo.SetColor	(	EVehicleInfoState	state,
		EVehicleInfoColor	color )

protected

Implemented in SCR_LightManagerInfoMulti.

◆ SetIcon()

void SCR_BaseVehicleInfo.SetIcon ( string icon )

protected

Implemented in SCR_LightManagerInfoMulti.

◆ UpdateRequired()

bool SCR_BaseVehicleInfo.UpdateRequired ( EVehicleInfoState state )

protected

Implemented in SCR_LightManagerInfoMulti.

Member Data Documentation

◆ ICON_SIZE

const int SCR_BaseVehicleInfo.ICON_SIZE = 64

staticprotected

◆ m_aColors

Color SCR_BaseVehicleInfo.m_aColors[5]

protected

◆ m_aColorsGlow

Color SCR_BaseVehicleInfo.m_aColorsGlow[5]

protected

◆ m_bIsBlinking

bool SCR_BaseVehicleInfo.m_bIsBlinking

protected

◆ m_bShowGhost

bool SCR_BaseVehicleInfo.m_bShowGhost

protected

◆ m_eColor

EVehicleInfoColor SCR_BaseVehicleInfo.m_eColor

◆ m_eState

EVehicleInfoState SCR_BaseVehicleInfo.m_eState = EVehicleInfoState.ERROR

protected

◆ m_fWidgetScale

float SCR_BaseVehicleInfo.m_fWidgetScale

protected

◆ m_iBlinkingOffset

int SCR_BaseVehicleInfo.m_iBlinkingOffset

protected

◆ m_Imageset

ResourceName SCR_BaseVehicleInfo.m_Imageset = "{3262679C50EF4F01}UI/Textures/Icons/icons_wrapperUI.imageset"

protected

◆ m_ImagesetGlow

ResourceName SCR_BaseVehicleInfo.m_ImagesetGlow = "{00FE3DBDFD15227B}UI/Textures/Icons/icons_wrapperUI-glow.imageset"

protected

◆ m_sIcon

string SCR_BaseVehicleInfo.m_sIcon

protected

◆ m_wGlow

ImageWidget SCR_BaseVehicleInfo.m_wGlow

protected

◆ m_wIcon

ImageWidget SCR_BaseVehicleInfo.m_wIcon

protected

◆ m_wSizeOverlay

OverlayWidget SCR_BaseVehicleInfo.m_wSizeOverlay

protected

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

Game/UI/HUD/VehicleInfo/SCR_BaseVehicleInfo.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ DisplayInit()

◆ DisplayStartDraw()

◆ DisplayStartDrawInit()

◆ DisplayStopDraw()

◆ DisplayUpdate()

◆ GetState()

◆ IsBlinking()

◆ Scale() [1/3]

◆ Scale() [2/3]

◆ Scale() [3/3]

◆ SetColor()

◆ SetIcon()

◆ UpdateRequired()

Member Data Documentation

◆ ICON_SIZE

◆ m_aColors

◆ m_aColorsGlow

◆ m_bIsBlinking

◆ m_bShowGhost

◆ m_eColor

◆ m_eState

◆ m_fWidgetScale

◆ m_iBlinkingOffset

◆ m_Imageset

◆ m_ImagesetGlow

◆ m_sIcon

◆ m_wGlow

◆ m_wIcon

◆ m_wSizeOverlay