Inheritance diagram for SCR_NameTagDisplay:

Protected Member Functions
SCR_NameTagData	GetEntityNameTag (IEntity ent)
	Retrieve nametag from entity map.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	SCR_GameModeBase event.
void	OnControllableDeleted (IEntity entity)
	SCR_GameModeBase event.
void	OnNewVehicleOccupant (IEntity vehicle, SCR_NameTagData occupant)
void	OnLeaveVehicleOccupant (IEntity vehicle, SCR_NameTagData occupant)
void	OnGroupJoined (SCR_AIGroup group, int playerID)
void	OnGroupLeft (SCR_AIGroup group, int playerID)
void	OnGroupLeaderChanged (int groupID, int leaderID)
void	Update (float timeSlice)
void	UpdateTagElements (SCR_NameTagData data)
bool	IsFactionFriendly (notnull Faction entityFaction)
bool	IsPlayerOrAI (notnull IEntity entity)
bool	CheckFilters (notnull IEntity entity)
bool	CanDisplayNameTag (notnull IEntity entity)
void	AdjustRange (bool adjust, float FOVZoomed)
void	InitNameTags ()
	Basic initialization of invokers.
void	ProcessFiltered ()
	Process newly gathered entities.
void	InitializeTag (IEntity entity)
void	CreateTagWidget (ENameTagEntityType type=0)
	Create widget for nametag.
void	ForceRedoTag (notnull SCR_NameTagData data, notnull IEntity entity)
void	CleanupTag (notnull SCR_NameTagData data, bool removeFromArray=true)
void	CleanupAllTags ()
	Unregister events of all tags and move to uninitialized tag pool.
void	CleanupDisplay (bool destroyWidgets)
void	StopUpdate ()
	Stop updating nametags.
void	UpdateDebug ()
	Debug.
override void	DisplayUpdate (IEntity owner, float timeSlice)
override bool	DisplayStartDrawInit (IEntity owner)
override void	DisplayStartDraw (IEntity owner)
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
	Reinit curent player tag after new entity is controlled.
void	RefreshTags (IEntity localPlayer)
	Refreshes the tags by clearning up all tags, then processing them.
void	OnFilterTagsChanged (int filters)
override void	DisplayStopDraw (IEntity owner)

Static Protected Member Functions
static array< ref SCR_NameTagZone >	GetNametagZones ()

Protected Attributes
ref array< IEntity >	m_aFilteredEntities = new array<IEntity>()
ref array< ref SCR_NameTagData >	m_aUninitializedTags = {}
ref array< ref SCR_VehicleTagData >	m_aUninitializedVehTags = {}
ref array< ref SCR_NameTagData >	m_aNameTags = {}
ref map< IEntity, ref SCR_NameTagData >	m_aNameTagEntities = new map<IEntity, ref SCR_NameTagData>()
bool	m_bIsRulesetInit = false
bool	m_bSleepDisplay = false
int	m_iCurrentPlayerID
ref SCR_NameTagData	m_CurrentPlayerTag
Faction	m_CurrentFaction
PlayerManager	m_PlayerManager
SCR_AdditionalGameModeSettingsComponent	m_AdditionalSettings

Static Protected Attributes
static ref SCR_NameTagConfig	s_NametagCfg

Detailed Description

Nametag UI Attached to SCR_HUDManagerComponent which is a component of SCR_PlayerController

Definition at line 4 of file SCR_NameTagDisplay.c.

Member Function Documentation

◆ AdjustRange()

void SCR_NameTagDisplay::AdjustRange	(	bool	adjust,
		float	FOVZoomed )

inlineprotected

Adjust zone range based on zoom

Parameters

adjust	determines if we are adjusting the ranges or restorign them to default
FOVZoomed	is the new FOV we are adjusting to

Definition at line 356 of file SCR_NameTagDisplay.c.

◆ CanDisplayNameTag()

bool SCR_NameTagDisplay::CanDisplayNameTag ( notnull IEntity entity )

inlineprotected

Definition at line 334 of file SCR_NameTagDisplay.c.

◆ CheckFilters()

bool SCR_NameTagDisplay::CheckFilters ( notnull IEntity entity )

inlineprotected

Definition at line 277 of file SCR_NameTagDisplay.c.

◆ CleanupAllTags()

void SCR_NameTagDisplay::CleanupAllTags ( )

inlineprotected

Unregister events of all tags and move to uninitialized tag pool.

Definition at line 567 of file SCR_NameTagDisplay.c.

◆ CleanupDisplay()

void SCR_NameTagDisplay::CleanupDisplay ( bool destroyWidgets )

inlineprotected

Clear all tags and their widgets

Parameters

destroyWidgets determines whether the widgets are kept or destroyed

Definition at line 581 of file SCR_NameTagDisplay.c.

◆ CleanupTag()

void SCR_NameTagDisplay::CleanupTag	(	notnull SCR_NameTagData	data,
		bool	removeFromArray = true )

inlineprotected

Unregister events and move to unitialized tag pool

Parameters

data	is the subject nametag
removeFromArray	determines whether the tag is removed from main array, this is not desired when entrire array is being cleaned up

Definition at line 533 of file SCR_NameTagDisplay.c.

◆ CreateTagWidget()

void SCR_NameTagDisplay::CreateTagWidget ( ENameTagEntityType type = 0 )

inlineprotected

Create widget for nametag.

Definition at line 503 of file SCR_NameTagDisplay.c.

◆ DisplayControlledEntityChanged()

override void SCR_NameTagDisplay::DisplayControlledEntityChanged	(	IEntity	from,
		IEntity	to )

inlineprotected

Reinit curent player tag after new entity is controlled.

Definition at line 714 of file SCR_NameTagDisplay.c.

◆ DisplayStartDraw()

override void SCR_NameTagDisplay::DisplayStartDraw ( IEntity owner )

inlineprotected

Definition at line 707 of file SCR_NameTagDisplay.c.

◆ DisplayStartDrawInit()

override bool SCR_NameTagDisplay::DisplayStartDrawInit ( IEntity owner )

inlineprotected

Definition at line 666 of file SCR_NameTagDisplay.c.

◆ DisplayStopDraw()

override void SCR_NameTagDisplay::DisplayStopDraw ( IEntity owner )

inlineprotected

Definition at line 744 of file SCR_NameTagDisplay.c.

◆ DisplayUpdate()

override void SCR_NameTagDisplay::DisplayUpdate	(	IEntity	owner,
		float	timeSlice )

inlineprotected

Definition at line 655 of file SCR_NameTagDisplay.c.

◆ ForceRedoTag()

void SCR_NameTagDisplay::ForceRedoTag	(	notnull SCR_NameTagData	data,
		notnull IEntity	entity )

inlineprotected

Forces the deletion and re-initialisation of a nametag to remake it entirely.

Parameters

data	is the subject nametag.
entity	is the entity the nametag is for.

Definition at line 521 of file SCR_NameTagDisplay.c.

◆ GetEntityNameTag()

SCR_NameTagData SCR_NameTagDisplay::GetEntityNameTag ( IEntity ent )

inlineprotected

Retrieve nametag from entity map.

Definition at line 43 of file SCR_NameTagDisplay.c.

◆ GetNametagZones()

array< ref SCR_NameTagZone > SCR_NameTagDisplay::GetNametagZones ( )

inlinestaticprotected

Get zone array from assigned zone config

Returns: array of nametag zones

Definition at line 33 of file SCR_NameTagDisplay.c.

◆ InitializeTag()

void SCR_NameTagDisplay::InitializeTag ( IEntity entity )

inlineprotected

Initialize name tag contex instance

Parameters

entity is a character entity

Definition at line 453 of file SCR_NameTagDisplay.c.

◆ InitNameTags()

void SCR_NameTagDisplay::InitNameTags ( )

inlineprotected

Basic initialization of invokers.

Definition at line 372 of file SCR_NameTagDisplay.c.

◆ IsFactionFriendly()

bool SCR_NameTagDisplay::IsFactionFriendly ( notnull Faction entityFaction )

inlineprotected

Check if entity is faction friendly to current players faction

Parameters

entityFaction Is a player entity

Returns: Returns true if checked entity is faction friendly

Definition at line 240 of file SCR_NameTagDisplay.c.

◆ IsPlayerOrAI()

bool SCR_NameTagDisplay::IsPlayerOrAI ( notnull IEntity entity )

inlineprotected

Definition at line 258 of file SCR_NameTagDisplay.c.

◆ OnControllableDeleted()

void SCR_NameTagDisplay::OnControllableDeleted ( IEntity entity )

inlineprotected

SCR_GameModeBase event.

Definition at line 76 of file SCR_NameTagDisplay.c.

◆ OnControllableDestroyed()

void SCR_NameTagDisplay::OnControllableDestroyed ( notnull SCR_InstigatorContextData instigatorContextData )

inlineprotected

SCR_GameModeBase event.

Definition at line 55 of file SCR_NameTagDisplay.c.

◆ OnFilterTagsChanged()

void SCR_NameTagDisplay::OnFilterTagsChanged ( int filters )

inlineprotected

When the filters change from the game settings, this method makes sure the nametags get refreshed as well

Parameters

[in] filters Scripts listens to two separate script invokers that send over enum filters. This method does not care about the actual settings those are checked in the init of the nametags

Definition at line 738 of file SCR_NameTagDisplay.c.

◆ OnGroupJoined()

void SCR_NameTagDisplay::OnGroupJoined	(	SCR_AIGroup	group,
		int	playerID )

inlineprotected

Definition at line 138 of file SCR_NameTagDisplay.c.

◆ OnGroupLeaderChanged()

void SCR_NameTagDisplay::OnGroupLeaderChanged	(	int	groupID,
		int	leaderID )

inlineprotected

Definition at line 168 of file SCR_NameTagDisplay.c.

◆ OnGroupLeft()

void SCR_NameTagDisplay::OnGroupLeft	(	SCR_AIGroup	group,
		int	playerID )

inlineprotected

Definition at line 155 of file SCR_NameTagDisplay.c.

◆ OnLeaveVehicleOccupant()

void SCR_NameTagDisplay::OnLeaveVehicleOccupant	(	IEntity	vehicle,
		SCR_NameTagData	occupant )

inlineprotected

Definition at line 124 of file SCR_NameTagDisplay.c.

◆ OnNewVehicleOccupant()

void SCR_NameTagDisplay::OnNewVehicleOccupant	(	IEntity	vehicle,
		SCR_NameTagData	occupant )

inlineprotected

Definition at line 94 of file SCR_NameTagDisplay.c.

◆ ProcessFiltered()

void SCR_NameTagDisplay::ProcessFiltered ( )

inlineprotected

Process newly gathered entities.

Definition at line 414 of file SCR_NameTagDisplay.c.

◆ RefreshTags()

void SCR_NameTagDisplay::RefreshTags ( IEntity localPlayer )

inlineprotected

Refreshes the tags by clearning up all tags, then processing them.

Definition at line 721 of file SCR_NameTagDisplay.c.

◆ StopUpdate()

void SCR_NameTagDisplay::StopUpdate ( )

inlineprotected

Stop updating nametags.

Definition at line 624 of file SCR_NameTagDisplay.c.

◆ Update()

void SCR_NameTagDisplay::Update ( float timeSlice )

inlineprotected

Decide which entities should have their nametags drawn

Parameters

timeSlice is the OnFrame timeslice

Definition at line 204 of file SCR_NameTagDisplay.c.

◆ UpdateDebug()

void SCR_NameTagDisplay::UpdateDebug ( )

inlineprotected

Debug.

Definition at line 632 of file SCR_NameTagDisplay.c.

◆ UpdateTagElements()

void SCR_NameTagDisplay::UpdateTagElements ( SCR_NameTagData data )

inlineprotected

Update all elements of the requested tag

Parameters

data	is nametag data struct

Definition at line 230 of file SCR_NameTagDisplay.c.

Member Data Documentation

◆ m_AdditionalSettings

SCR_AdditionalGameModeSettingsComponent SCR_NameTagDisplay::m_AdditionalSettings

protected

Definition at line 26 of file SCR_NameTagDisplay.c.

◆ m_aFilteredEntities

ref array<IEntity> SCR_NameTagDisplay::m_aFilteredEntities = new array<IEntity>()

protected

Definition at line 10 of file SCR_NameTagDisplay.c.

◆ m_aNameTagEntities

ref map<IEntity, ref SCR_NameTagData> SCR_NameTagDisplay::m_aNameTagEntities = new map<IEntity, ref SCR_NameTagData>()

protected

Definition at line 14 of file SCR_NameTagDisplay.c.

◆ m_aNameTags

ref array<ref SCR_NameTagData> SCR_NameTagDisplay::m_aNameTags = {}

protected

Definition at line 13 of file SCR_NameTagDisplay.c.

◆ m_aUninitializedTags

ref array<ref SCR_NameTagData> SCR_NameTagDisplay::m_aUninitializedTags = {}

protected

Definition at line 11 of file SCR_NameTagDisplay.c.

◆ m_aUninitializedVehTags

ref array<ref SCR_VehicleTagData> SCR_NameTagDisplay::m_aUninitializedVehTags = {}

protected

Definition at line 12 of file SCR_NameTagDisplay.c.

◆ m_bIsRulesetInit

bool SCR_NameTagDisplay::m_bIsRulesetInit = false

protected

Definition at line 16 of file SCR_NameTagDisplay.c.

◆ m_bSleepDisplay

bool SCR_NameTagDisplay::m_bSleepDisplay = false

protected

Definition at line 17 of file SCR_NameTagDisplay.c.

◆ m_CurrentFaction

Faction SCR_NameTagDisplay::m_CurrentFaction

protected

Definition at line 21 of file SCR_NameTagDisplay.c.

◆ m_CurrentPlayerTag

ref SCR_NameTagData SCR_NameTagDisplay::m_CurrentPlayerTag

protected

Definition at line 20 of file SCR_NameTagDisplay.c.

◆ m_iCurrentPlayerID

int SCR_NameTagDisplay::m_iCurrentPlayerID

protected

Definition at line 18 of file SCR_NameTagDisplay.c.

◆ m_PlayerManager

PlayerManager SCR_NameTagDisplay::m_PlayerManager

protected

Definition at line 22 of file SCR_NameTagDisplay.c.

◆ s_NametagCfg

ref SCR_NameTagConfig SCR_NameTagDisplay::s_NametagCfg

staticprotected

Definition at line 24 of file SCR_NameTagDisplay.c.

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

scripts/Game/UI/Nametags/SCR_NameTagDisplay.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ AdjustRange()

◆ CanDisplayNameTag()

◆ CheckFilters()

◆ CleanupAllTags()

◆ CleanupDisplay()

◆ CleanupTag()

◆ CreateTagWidget()

◆ DisplayControlledEntityChanged()

◆ DisplayStartDraw()

◆ DisplayStartDrawInit()

◆ DisplayStopDraw()

◆ DisplayUpdate()

◆ ForceRedoTag()

◆ GetEntityNameTag()

◆ GetNametagZones()

◆ InitializeTag()

◆ InitNameTags()

◆ IsFactionFriendly()

◆ IsPlayerOrAI()

◆ OnControllableDeleted()

◆ OnControllableDestroyed()

◆ OnFilterTagsChanged()

◆ OnGroupJoined()

◆ OnGroupLeaderChanged()

◆ OnGroupLeft()

◆ OnLeaveVehicleOccupant()

◆ OnNewVehicleOccupant()

◆ ProcessFiltered()

◆ RefreshTags()

◆ StopUpdate()

◆ Update()

◆ UpdateDebug()

◆ UpdateTagElements()

Member Data Documentation

◆ m_AdditionalSettings

◆ m_aFilteredEntities

◆ m_aNameTagEntities

◆ m_aNameTags

◆ m_aUninitializedTags

◆ m_aUninitializedVehTags

◆ m_bIsRulesetInit

◆ m_bSleepDisplay

◆ m_CurrentFaction

◆ m_CurrentPlayerTag

◆ m_iCurrentPlayerID

◆ m_PlayerManager

◆ s_NametagCfg