SCR_NTElementBase Interface Reference

Nametag zone element base class, not for setup. More...

Inheritance diagram for SCR_NTElementBase:

Public Member Functions
void	SetDefaults (SCR_NameTagData data, int index)
	Set initial/default widget values for the element.
void	UpdateElement (SCR_NameTagData data, int index)
	Widget element update.
void	SCR_NTElementBase ()

Public Attributes
string	m_sWidgetName

Protected Member Functions
void	InitElementWidget (SCR_NameTagData data, int index)
	Find and set this elements widget of nametag struct.
SCR_NTStateConfigBase	GetEntityStateConfig (SCR_NameTagData data)
	Get config for entity state setup.
void	ScaleElement (SCR_NameTagData data, int index)
	Element scaling.

Protected Attributes
ref array< ref SCR_NTStateConfigBase >	m_aEntityStates
bool	m_bScaleElement
ref map< ENameTagEntityState, SCR_NTStateConfigBase >	m_aEntityStatesMap = new map< ENameTagEntityState, SCR_NTStateConfigBase>

Detailed Description

Nametag zone element base class, not for setup.

Constructor & Destructor Documentation

SCR_NTElementBase()

void SCR_NTElementBase.SCR_NTElementBase

(

)

Member Function Documentation

GetEntityStateConfig()

SCR_NTStateConfigBase SCR_NTElementBase.GetEntityStateConfig ( SCR_NameTagData data )

protected

Get config for entity state setup.

Parameters

data	is nametag struct

Returns

state config of this element

InitElementWidget()

void SCR_NTElementBase.InitElementWidget ( SCR_NameTagData data, int index )

protected

Find and set this elements widget of nametag struct.

ScaleElement()

void SCR_NTElementBase.ScaleElement ( SCR_NameTagData data, int index )

protected

Element scaling.

Parameters

data	is the nametag struct

Implemented in SCR_NTIconBase, and SCR_NTTextBase.

SetDefaults()

void SCR_NTElementBase.SetDefaults	(	SCR_NameTagData	data,
		int	index )

Set initial/default widget values for the element.

Implemented in SCR_NTIconBase, SCR_NTIconPlatform, SCR_NTIconState, and SCR_NTTextBase.

UpdateElement()

void SCR_NTElementBase.UpdateElement	(	SCR_NameTagData	data,
		int	index )

Widget element update.

Parameters

data	is nametag struct

Implemented in SCR_NTIconPlatform, SCR_NTName, and SCR_NTTextDebug.

Member Data Documentation

m_aEntityStates

ref array<ref SCR_NTStateConfigBase> SCR_NTElementBase.m_aEntityStates

protected

m_aEntityStatesMap

ref map<ENameTagEntityState, SCR_NTStateConfigBase> SCR_NTElementBase.m_aEntityStatesMap = new map< ENameTagEntityState, SCR_NTStateConfigBase>

protected

m_bScaleElement

bool SCR_NTElementBase.m_bScaleElement

protected

m_sWidgetName

string SCR_NTElementBase.m_sWidgetName

---

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

• Game/UI/Nametags/NTZoneElements/SCR_NTElementBase.c