SCR_NTTextBase Interface Reference

Base nametag element for text. More...

Inheritance diagram for SCR_NTTextBase:

Public Member Functions
override void	SetDefaults (SCR_NameTagData data, int index)
	Set initial/default widget values for the element.
Public Member Functions inherited from SCR_NTElementBase
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 ()

Protected Member Functions
void	GetText (SCR_NameTagData data, out string name, out notnull array< string > nameParams)
	Get text from this element.
void	SetText (SCR_NameTagData data, string text, notnull array< string > nameParams, int index)
	Set text for this element.
override void	ScaleElement (SCR_NameTagData data, int index)
	Element scaling.
Protected Member Functions inherited from SCR_NTElementBase
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
int	m_fTextSizeMax
int	m_fTextSizeMin
ResourceName	m_FontResource
Protected Attributes inherited from SCR_NTElementBase
ref array< ref SCR_NTStateConfigBase >	m_aEntityStates
bool	m_bScaleElement
ref map< ENameTagEntityState, SCR_NTStateConfigBase >	m_aEntityStatesMap = new map< ENameTagEntityState, SCR_NTStateConfigBase>

Additional Inherited Members
Public Attributes inherited from SCR_NTElementBase
string	m_sWidgetName

Detailed Description

Base nametag element for text.

Member Function Documentation

GetText()

void SCR_NTTextBase.GetText ( SCR_NameTagData  data, out string  name, out notnull array< string >  nameParams  )

protected

Get text from this element.

Parameters

	data	is nametag struct
[out]	name	Name or formatting of name
[out]	names	If uses formating: Firstname, Alias and Surname (Alias can be an empty string)

Implemented in SCR_NTName, and SCR_NTTextDebug.

ScaleElement()

override void SCR_NTTextBase.ScaleElement ( SCR_NameTagData  data, int  index  )

protected

Element scaling.

Parameters

data	is the nametag struct

Implements SCR_NTElementBase.

SetDefaults()

override void SCR_NTTextBase.SetDefaults	(	SCR_NameTagData	data,
		int	index
	)

Set initial/default widget values for the element.

Implements SCR_NTElementBase.

SetText()

void SCR_NTTextBase.SetText ( SCR_NameTagData  data, string  text, notnull array< string >  nameParams, int  index  )

protected

Set text for this element.

Parameters

data	is nametag struct

Member Data Documentation

m_FontResource

ResourceName SCR_NTTextBase.m_FontResource

protected

m_fTextSizeMax

int SCR_NTTextBase.m_fTextSizeMax

protected

m_fTextSizeMin

int SCR_NTTextBase.m_fTextSizeMin

protected

---

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

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