SCR_NameTagZone Interface Reference

Nametag zone config setup. More...

Public Member Functions
int	GetZoneStart ()
	Getter - minimum distance for the nametag to be drawn in this zone.
void	OnZoneChanged (SCR_NameTagData data)
	On nametag switching to different zone.
void	DrawElements (SCR_NameTagData data)
	Iterate through and draw every element(widget) assigned to this zone.
void	UpdateElementDefs (SCR_NameTagData data)
	Iterate through and set every element to default values according to their state.
void	HideElements (SCR_NameTagData data)
	Clear elements upon zone switch since some may not be configured in the current zone anymore.
void	SCR_NameTagZone ()
void	~SCR_NameTagZone ()

Public Attributes
int	m_iZoneEnd
int	m_iZoneEndPow2
int	m_iElementsCount

Protected Attributes
string	m_sZoneName
int	m_iZoneStart
ref array< ref SCR_NTElementBase >	m_aElements

Detailed Description

Nametag zone config setup.

Constructor & Destructor Documentation

SCR_NameTagZone()

void SCR_NameTagZone.SCR_NameTagZone

(

)

~SCR_NameTagZone()

void SCR_NameTagZone.~SCR_NameTagZone

(

)

Member Function Documentation

DrawElements()

void SCR_NameTagZone.DrawElements

(

SCR_NameTagData

data

)

Iterate through and draw every element(widget) assigned to this zone.

Parameters

data	is nametag struct class

GetZoneStart()

int SCR_NameTagZone.GetZoneStart

(

)

Getter - minimum distance for the nametag to be drawn in this zone.

Returns

min draw distance

HideElements()

void SCR_NameTagZone.HideElements

(

SCR_NameTagData

data

)

Clear elements upon zone switch since some may not be configured in the current zone anymore.

Parameters

data	is nametag struct class

OnZoneChanged()

void SCR_NameTagZone.OnZoneChanged

(

SCR_NameTagData

data

)

On nametag switching to different zone.

Parameters

data	is nametag struct

UpdateElementDefs()

void SCR_NameTagZone.UpdateElementDefs

(

SCR_NameTagData

data

)

Iterate through and set every element to default values according to their state.

Parameters

data	is nametag struct class

Member Data Documentation

m_aElements

ref array<ref SCR_NTElementBase> SCR_NameTagZone.m_aElements

protected

m_iElementsCount

int SCR_NameTagZone.m_iElementsCount

m_iZoneEnd

int SCR_NameTagZone.m_iZoneEnd

m_iZoneEndPow2

int SCR_NameTagZone.m_iZoneEndPow2

m_iZoneStart

int SCR_NameTagZone.m_iZoneStart

protected

m_sZoneName

string SCR_NameTagZone.m_sZoneName

protected

---

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

• Game/UI/Nametags/SCR_NameTagConfig.c