SCR_NameTagRulesetSingle Interface Reference

Inheritance diagram for SCR_NameTagRulesetSingle:

Protected Member Functions
override bool	TestVisibilityFiltered (SCR_NameTagData data, float timeSlice)
	Determine secondary visibility rules from the filtered tags.
override void	DetermineVisibility (float timeSlice)
	Uses provided nametag data to determine which tags pass the visibility conditions and filters them into a new array.
override void	Cleanup ()
	Cleanup.
Protected Member Functions inherited from SCR_NameTagRulesetBase
bool	TestVisibility (SCR_NameTagData data, float timeSlice)
	Determine whether the tag passes basic conditions for visibility.
bool	TestVisibilityFiltered (SCR_NameTagData data, float timeSlice)
	Determine secondary visibility rules from the filtered tags.
void	UpdateVisibleTag (SCR_NameTagData data, float timeSlice)
	Update for visible tags.
void	CheckLOS ()
	Change opacity based on line of sight.
bool	TraceLOS (SCR_NameTagData data)
	Check if target is visible to the player.
void	SelectTagToExpand (float timeSlice)
	Evaluates if player is focusing a nametag entity or not, expands/collapses nametag after a set time.
void	ExpandTag (SCR_NameTagData data)
	Logic for showing additional info when nametag becomes expanded.
void	CollapseTag (float timeSlice, SCR_NameTagData data)
	Logic for collapsing the nametag back to its basic format.
bool	DisableTag (SCR_NameTagData data, float timeSlice)
	Fade out tag and disable it when it no longer passes rules for visibility.
float	GetCameraToEntityAngle (vector targetOrigin, float verticalWeight)
	Calculates angle between screen center and target entity.
void	CalculateScreenPos (SCR_NameTagData data)
	Calculate tag 2d screen pos.
void	DetermineVisibility (float timeSlice)
	Uses provided nametag data to determine which tags pass the visibility conditions and filters them into a new array.
void	OnUserSettingChanged ()
	Settings changed event.
void	Cleanup ()
	Cleanup.
void	UpdateDebug ()
	Debug.

Protected Attributes
ref array< ref SCR_NameTagData >	m_aSecondaryTags = {}
Protected Attributes inherited from SCR_NameTagRulesetBase
float	m_fTagFocusDelay
bool	m_bCancelFadeOnNewFocus
bool	m_bTraceForLOS
float	m_fLOSFadeDelay
int	m_iMaxAngle
float	m_fTimeElapsed = 0
float	m_fTimeFade = 0
float	m_fFocusPrioAngle
int	m_iIndexLOS = 0
int	m_iRefResolutionX
int	m_iRefResolutionY
SCR_NameTagData	m_ClosestAngleTag
SCR_NameTagData	m_PrimaryTag
SCR_NameTagData	m_ExpandedTag
SCR_2DPIPSightsComponent	m_PIPSightsComp
BaseWorld	m_World
WorkspaceWidget	m_Workspace
SCR_NameTagDisplay	m_NTDisplay
SCR_NameTagConfig	m_ZoneCfg
ref array< ref SCR_NameTagData >	m_aNameTags = {}
ref array< ref SCR_NameTagData >	m_aCandidateTags = {}

Additional Inherited Members
Public Member Functions inherited from SCR_NameTagRulesetBase
bool	Init (SCR_NameTagDisplay display, SCR_NameTagConfig config)
	Initialize ruleset.
void	Update (float timeSlice, array< ref SCR_NameTagData > nameTags, SCR_NameTagData nameTagPlayer)
void	~SCR_NameTagRulesetBase ()
Public Attributes inherited from SCR_NameTagRulesetBase
float	m_fTagFadeTime
float	m_fDeadEntitiesCleanup
SCR_NameTagData	m_CurrentPlayerTag
Static Public Attributes inherited from SCR_NameTagRulesetBase
const int	DISABLE_FLAGS = ENameTagFlags.UPDATE_DISABLE | ENameTagFlags.DISABLED
const int	SECONDARY_FLAGS = ENameTagEntityState.VON
const int	NEAR_TAG_ANGLE = 3
const int	DISABLED_CLEANUP = 5.0
const int	POSITION_UPDATE = 0.1
const float	POS_TRANSITION_MULT = 2
const float	VERT_ANGLE_ADJUST = 0.3
const vector	HEAD_LOS_OFFSET = "0 0.05 0"
const float	VON_STOP_TIME = 1

Member Function Documentation

Cleanup()

override void SCR_NameTagRulesetSingle.Cleanup ( )

protected

Cleanup.

Implements SCR_NameTagRulesetBase.

DetermineVisibility()

override void SCR_NameTagRulesetSingle.DetermineVisibility ( float  timeSlice )

protected

Uses provided nametag data to determine which tags pass the visibility conditions and filters them into a new array.

Parameters

timeSlice

is frame time slice

Implements SCR_NameTagRulesetBase.

TestVisibilityFiltered()

override bool SCR_NameTagRulesetSingle.TestVisibilityFiltered ( SCR_NameTagData  data, float  timeSlice  )

protected

Determine secondary visibility rules from the filtered tags.

Parameters

data	is the subject nametag
timeSlice	is frame time slice

Returns

Returns true if tag passed conditions for visibility

Implements SCR_NameTagRulesetBase.

Member Data Documentation

m_aSecondaryTags

ref array<ref SCR_NameTagData> SCR_NameTagRulesetSingle.m_aSecondaryTags = {}

protected

---

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

• Game/UI/Nametags/SCR_NameTagRulesetSingle.c