SCR_BaseVehicleInfo Class Reference

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

Inheritance diagram for SCR_BaseVehicleInfo:

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)
override event 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.

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

Detailed Description

Base class for all vehicle UI state and damage indicators.

Definition at line 28 of file SCR_BaseVehicleInfo.c.

Member Function Documentation

DisplayInit()

override void SCR_BaseVehicleInfo::DisplayInit ( IEntity owner )

inlineprotected

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

Definition at line 232 of file SCR_BaseVehicleInfo.c.

DisplayStartDraw()

override void SCR_BaseVehicleInfo::DisplayStartDraw ( IEntity owner )

inlineprotected

Create the UI.

Definition at line 210 of file SCR_BaseVehicleInfo.c.

DisplayStartDrawInit()

override bool SCR_BaseVehicleInfo::DisplayStartDrawInit ( IEntity owner )

inlineprotected

Definition at line 195 of file SCR_BaseVehicleInfo.c.

DisplayStopDraw()

override void SCR_BaseVehicleInfo::DisplayStopDraw ( IEntity owner )

inlineprotected

Destroy the UI.

Definition at line 226 of file SCR_BaseVehicleInfo.c.

DisplayUpdate()

override event void SCR_BaseVehicleInfo::DisplayUpdate ( IEntity owner, float timeSlice )

inlineprotected

Definition at line 156 of file SCR_BaseVehicleInfo.c.

GetState()

EVehicleInfoState SCR_BaseVehicleInfo::GetState ( )

inlineprotected

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

Definition at line 60 of file SCR_BaseVehicleInfo.c.

IsBlinking()

bool SCR_BaseVehicleInfo::IsBlinking ( )

inlineprotected

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

Definition at line 67 of file SCR_BaseVehicleInfo.c.

Scale() [1/3]

void SCR_BaseVehicleInfo::Scale ( ImageWidget widget, float scale )

inlineprotected

Definition at line 73 of file SCR_BaseVehicleInfo.c.

Scale() [2/3]

void SCR_BaseVehicleInfo::Scale ( OverlayWidget widget, float scale )

inlineprotected

Definition at line 98 of file SCR_BaseVehicleInfo.c.

Scale() [3/3]

void SCR_BaseVehicleInfo::Scale ( TextWidget widget, float scale )

inlineprotected

Definition at line 87 of file SCR_BaseVehicleInfo.c.

SetColor()

void SCR_BaseVehicleInfo::SetColor ( EVehicleInfoState state, EVehicleInfoColor color )

inlineprotected

Definition at line 120 of file SCR_BaseVehicleInfo.c.

SetIcon()

void SCR_BaseVehicleInfo::SetIcon ( string icon )

inlineprotected

Definition at line 108 of file SCR_BaseVehicleInfo.c.

UpdateRequired()

bool SCR_BaseVehicleInfo::UpdateRequired ( EVehicleInfoState state )

inlineprotected

Definition at line 150 of file SCR_BaseVehicleInfo.c.

Member Data Documentation

ICON_SIZE

const int SCR_BaseVehicleInfo::ICON_SIZE = 64

protected

Definition at line 56 of file SCR_BaseVehicleInfo.c.

m_aColors

Color SCR_BaseVehicleInfo::m_aColors[5]

protected

Definition at line 53 of file SCR_BaseVehicleInfo.c.

m_aColorsGlow

Color SCR_BaseVehicleInfo::m_aColorsGlow[5]

protected

Definition at line 54 of file SCR_BaseVehicleInfo.c.

m_bIsBlinking

bool SCR_BaseVehicleInfo::m_bIsBlinking

protected

Definition at line 50 of file SCR_BaseVehicleInfo.c.

m_bShowGhost

bool SCR_BaseVehicleInfo::m_bShowGhost

protected

Definition at line 47 of file SCR_BaseVehicleInfo.c.

m_eColor

EVehicleInfoColor SCR_BaseVehicleInfo::m_eColor

protected

Definition at line 41 of file SCR_BaseVehicleInfo.c.

m_eState

EVehicleInfoState SCR_BaseVehicleInfo::m_eState = EVehicleInfoState.ERROR

protected

Definition at line 49 of file SCR_BaseVehicleInfo.c.

m_fWidgetScale

float SCR_BaseVehicleInfo::m_fWidgetScale

protected

Definition at line 44 of file SCR_BaseVehicleInfo.c.

m_iBlinkingOffset

int SCR_BaseVehicleInfo::m_iBlinkingOffset

protected

Definition at line 51 of file SCR_BaseVehicleInfo.c.

m_Imageset

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

protected

Definition at line 30 of file SCR_BaseVehicleInfo.c.

m_ImagesetGlow

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

protected

Definition at line 31 of file SCR_BaseVehicleInfo.c.

m_sIcon

string SCR_BaseVehicleInfo::m_sIcon

protected

Definition at line 38 of file SCR_BaseVehicleInfo.c.

m_wGlow

ImageWidget SCR_BaseVehicleInfo::m_wGlow

protected

Definition at line 34 of file SCR_BaseVehicleInfo.c.

m_wIcon

ImageWidget SCR_BaseVehicleInfo::m_wIcon

protected

Definition at line 33 of file SCR_BaseVehicleInfo.c.

m_wSizeOverlay

OverlayWidget SCR_BaseVehicleInfo::m_wSizeOverlay

protected

Definition at line 35 of file SCR_BaseVehicleInfo.c.

---

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

• scripts/Game/UI/HUD/VehicleInfo/SCR_BaseVehicleInfo.c