SCR_NameTagData Class Reference

Nametag data. More...

Inheritance diagram for SCR_NameTagData:

Protected Member Functions
void	UpdatePriorityEntityState ()
	Update the highest priority entity state (as ordered in enum).
void	ActivateEntityState (ENameTagEntityState state)
void	DeactivateEntityState (ENameTagEntityState state)
void	SetVisibility (Widget widget, bool visible, float visibleOpacity, bool animate=true)
void	ResizeElement (Widget widget, float targetVal)
	Resize nametag element.
void	UpdateEntityType ()
	Determine type of nametag entity.
void	GetName (out string name, out notnull array< string > nameParams)
BaseCompartmentSlot	GetVehicleCompartment ()
void	SetTagPosition (ENameTagPosition pos, bool gradualChange=true)
void	SetGroup (SCR_AIGroup group)
	Set group state if it matches with current player group.
void	CheckAISubordinate (IEntity entity)
	Set AI_SUBORDINATE if it falls under current players command.
void	AddAsVehicleOccupant (IEntity vehicle, BaseCompartmentSlot slot, ENameTagFlags flag)
	Add this tag as occupant to a vehicle tag.
void	RemoveVehicleOccupant (IEntity vehicle)
	Remove this tag as occupant to a vehicle tag.
void	OnVehicleEntered (IEntity vehicle, BaseCompartmentManagerComponent manager, int mgrID, int slotID)
	SCR_CompartmentAccessComponent event.
void	OnVehicleLeft (IEntity vehicle, BaseCompartmentManagerComponent manager, int mgrID, int slotID)
	SCR_CompartmentAccessComponent event.
void	OnReceivedVON (int playerId, BaseTransceiver receiver, int frequency, float quality)
	VoNComponent event, only used for "Current player" tag.
void	OnLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
	SCR_CharacterController event.
void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
	SCR_CharacterFactionAffiliationComponent callback.
void	Cleanup (bool removeFromArray=true)
bool	UpdateEntityStateFlags ()
void	UpdateTagPos ()
	Update tag position.
void	InitDefaults ()
	Init default tag data.
void	InitData (SCR_NameTagConfig config)
	Init configurable data.
bool	InitTag (SCR_NameTagDisplay display, IEntity entity, SCR_NameTagConfig config, bool IsCurrentPlayer=false)
void	ResetTag ()
	Uninitialize class when its being moved to unused tags in order to be reused.
void	SCR_NameTagData (ResourceName layout, Widget rootWidget)
void	~SCR_NameTagData ()

Protected Attributes
SCR_NameTagDisplay	m_NTDisplay
BaseCompartmentSlot	m_VehicleCompartment
SCR_GroupsManagerComponent	m_GroupManager
SCR_PossessingManagerComponent	m_PossessingManager
float	m_fDeadEntitiesCleanup
float	m_fTagFadeSpeed
ref Widget	m_aNametagElements [10]

Detailed Description

Nametag data.

Definition at line 56 of file SCR_NameTagData.c.

Constructor & Destructor Documentation

SCR_NameTagData()

void SCR_NameTagData::SCR_NameTagData ( ResourceName layout, Widget rootWidget )

inlineprotected

Definition at line 733 of file SCR_NameTagData.c.

~SCR_NameTagData()

void SCR_NameTagData::~SCR_NameTagData ( )

inlineprotected

Definition at line 744 of file SCR_NameTagData.c.

Member Function Documentation

ActivateEntityState()

void SCR_NameTagData::ActivateEntityState ( ENameTagEntityState state )

inlineprotected

Add entity state flag

Parameters

state

is the flag to be added

Definition at line 138 of file SCR_NameTagData.c.

AddAsVehicleOccupant()

void SCR_NameTagData::AddAsVehicleOccupant ( IEntity vehicle, BaseCompartmentSlot slot, ENameTagFlags flag )

inlineprotected

Add this tag as occupant to a vehicle tag.

Definition at line 396 of file SCR_NameTagData.c.

CheckAISubordinate()

void SCR_NameTagData::CheckAISubordinate ( IEntity entity )

inlineprotected

Set AI_SUBORDINATE if it falls under current players command.

Definition at line 372 of file SCR_NameTagData.c.

Cleanup()

void SCR_NameTagData::Cleanup ( bool removeFromArray = true )

inlineprotected

Cleanup

Parameters

removeFromArray

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

Definition at line 506 of file SCR_NameTagData.c.

DeactivateEntityState()

void SCR_NameTagData::DeactivateEntityState ( ENameTagEntityState state )

inlineprotected

Remove ENameTagEntityState flag

Parameters

state

is the flag to be removed

Definition at line 170 of file SCR_NameTagData.c.

GetName()

void SCR_NameTagData::GetName ( out string name, out notnull array< string > nameParams )

inlineprotected

Get/update nametag name

Parameters

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

Definition at line 277 of file SCR_NameTagData.c.

GetVehicleCompartment()

BaseCompartmentSlot SCR_NameTagData::GetVehicleCompartment ( )

inlineprotected

Definition at line 308 of file SCR_NameTagData.c.

InitData()

void SCR_NameTagData::InitData ( SCR_NameTagConfig config )

inlineprotected

Init configurable data.

Definition at line 617 of file SCR_NameTagData.c.

InitDefaults()

void SCR_NameTagData::InitDefaults ( )

inlineprotected

Init default tag data.

Definition at line 593 of file SCR_NameTagData.c.

InitTag()

bool SCR_NameTagData::InitTag ( SCR_NameTagDisplay display, IEntity entity, SCR_NameTagConfig config, bool IsCurrentPlayer = false )

inlineprotected

Init nametag data class, the widget is held and reused, data has to be reinitialized

Parameters

display	is nametag info display
entity	is nametag subject

Returns

false if nametag is not valid and should be cleaned up

Definition at line 660 of file SCR_NameTagData.c.

OnFactionChanged()

void SCR_NameTagData::OnFactionChanged ( FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction )

inlineprotected

SCR_CharacterFactionAffiliationComponent callback.

Definition at line 494 of file SCR_NameTagData.c.

OnLifeStateChanged()

void SCR_NameTagData::OnLifeStateChanged ( ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState )

inlineprotected

SCR_CharacterController event.

Definition at line 484 of file SCR_NameTagData.c.

OnReceivedVON()

void SCR_NameTagData::OnReceivedVON ( int playerId, BaseTransceiver receiver, int frequency, float quality )

inlineprotected

VoNComponent event, only used for "Current player" tag.

Definition at line 469 of file SCR_NameTagData.c.

OnVehicleEntered()

void SCR_NameTagData::OnVehicleEntered ( IEntity vehicle, BaseCompartmentManagerComponent manager, int mgrID, int slotID )

inlineprotected

SCR_CompartmentAccessComponent event.

Definition at line 414 of file SCR_NameTagData.c.

OnVehicleLeft()

void SCR_NameTagData::OnVehicleLeft ( IEntity vehicle, BaseCompartmentManagerComponent manager, int mgrID, int slotID )

inlineprotected

SCR_CompartmentAccessComponent event.

Definition at line 443 of file SCR_NameTagData.c.

RemoveVehicleOccupant()

void SCR_NameTagData::RemoveVehicleOccupant ( IEntity vehicle )

inlineprotected

Remove this tag as occupant to a vehicle tag.

Definition at line 405 of file SCR_NameTagData.c.

ResetTag()

void SCR_NameTagData::ResetTag ( )

inlineprotected

Uninitialize class when its being moved to unused tags in order to be reused.

Definition at line 701 of file SCR_NameTagData.c.

ResizeElement()

void SCR_NameTagData::ResizeElement ( Widget widget, float targetVal )

inlineprotected

Resize nametag element.

Definition at line 223 of file SCR_NameTagData.c.

SetGroup()

void SCR_NameTagData::SetGroup ( SCR_AIGroup group )

inlineprotected

Set group state if it matches with current player group.

Definition at line 329 of file SCR_NameTagData.c.

SetTagPosition()

void SCR_NameTagData::SetTagPosition ( ENameTagPosition pos, bool gradualChange = true )

inlineprotected

Set what is the nametag position attached to

Parameters

pos	is the new tag position
gradualChange	controls whether the position change will be instant (false) or gradually lerped

Definition at line 317 of file SCR_NameTagData.c.

SetVisibility()

void SCR_NameTagData::SetVisibility ( Widget widget, bool visible, float visibleOpacity, bool animate = true )

inlineprotected

Set visibility of nametag widget

Parameters

widget	is the target widget
visible	controls whether the widget should be made visible or invisible
animate	controls if the widget should fade in/out

Definition at line 187 of file SCR_NameTagData.c.

UpdateEntityStateFlags()

bool SCR_NameTagData::UpdateEntityStateFlags ( )

inlineprotected

Initial check of active states for JIP /return false if invalid/should be cleaned up

Definition at line 521 of file SCR_NameTagData.c.

UpdateEntityType()

void SCR_NameTagData::UpdateEntityType ( )

inlineprotected

Determine type of nametag entity.

Definition at line 231 of file SCR_NameTagData.c.

UpdatePriorityEntityState()

void SCR_NameTagData::UpdatePriorityEntityState ( )

inlineprotected

Update the highest priority entity state (as ordered in enum).

Definition at line 112 of file SCR_NameTagData.c.

UpdateTagPos()

void SCR_NameTagData::UpdateTagPos ( )

inlineprotected

Update tag position.

Definition at line 566 of file SCR_NameTagData.c.

Member Data Documentation

m_aNametagElements

ref Widget SCR_NameTagData::m_aNametagElements[10]

protected

Definition at line 109 of file SCR_NameTagData.c.

m_fDeadEntitiesCleanup

float SCR_NameTagData::m_fDeadEntitiesCleanup

protected

Definition at line 105 of file SCR_NameTagData.c.

m_fTagFadeSpeed

float SCR_NameTagData::m_fTagFadeSpeed

protected

Definition at line 106 of file SCR_NameTagData.c.

m_GroupManager

SCR_GroupsManagerComponent SCR_NameTagData::m_GroupManager

protected

Definition at line 101 of file SCR_NameTagData.c.

m_NTDisplay

SCR_NameTagDisplay SCR_NameTagData::m_NTDisplay

protected

Definition at line 99 of file SCR_NameTagData.c.

m_PossessingManager

SCR_PossessingManagerComponent SCR_NameTagData::m_PossessingManager

protected

Definition at line 102 of file SCR_NameTagData.c.

m_VehicleCompartment

BaseCompartmentSlot SCR_NameTagData::m_VehicleCompartment

protected

Definition at line 100 of file SCR_NameTagData.c.

---

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

• scripts/Game/UI/Nametags/SCR_NameTagData.c