SCR_VehicleTagData Interface Reference

Inheritance diagram for SCR_VehicleTagData:

Public Member Functions
int	GetMainPlayerID ()
	Returns playerID of the most important player in the vehicle.
void	UpdatePassenger (SCR_NameTagData tag, bool IsEntering, bool isControlledEntity=false)
	Update current tracked passangers within the vehicle.
override void	GetName (out string name, out notnull array< string > nameParams)
	Get/update nametag name.
override void	UpdateTagPos ()
	Update tag position.
Public Member Functions inherited from SCR_NameTagData
void	UpdatePriorityEntityState ()
	Update the highest priority entity state (as ordered in enum)
void	ActivateEntityState (ENameTagEntityState state)
	Add entity state flag.
void	DeactivateEntityState (ENameTagEntityState state)
	Remove ENameTagEntityState flag.
void	SetVisibility (Widget widget, bool visible, float visibleOpacity, bool animate=true)
	Set visibility of nametag widget.
void	ResizeElement (Widget widget, float targetVal)
	Resize nametag element.
void	UpdateEntityType ()
	Determine type of nametag entity.
BaseCompartmentSlot	GetVehicleCompartment ()
void	SetTagPosition (ENameTagPosition pos, bool gradualChange=true)
	Set what is the nametag position attached to.
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	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	Cleanup (bool removeFromArray=true)
	Cleanup.
bool	InitTag (SCR_NameTagDisplay display, IEntity entity, SCR_NameTagConfig config, bool IsCurrentPlayer=false)
	Init nametag data class, the widget is held and reused, data has to be reinitialized.
void	ResetTag ()
	Uninitialize class when its being moved to unsued tags in order to be reused.
void	SCR_NameTagData (ResourceName layout, Widget rootWidget)
void	~SCR_NameTagData ()

Public Attributes
bool	m_bIsControlledPresent = false
SCR_NameTagData	m_MainTag
ref array< SCR_NameTagData >	m_aPassengers = {}
Public Attributes inherited from SCR_NameTagData
ENameTagFlags	m_Flags
ENameTagEntityState	m_eEntityStateFlags
ENameTagEntityState	m_ePriorityEntityState
ENameTagPosition	m_eAttachedTo
ENameTagPosition	m_eAttachedToLast
ENameTagEntityType	m_eType
bool	m_bIsCurrentPlayer
int	m_iZoneID
int	m_iGroupID
int	m_iPlayerID
int	m_iSpineBone
int	m_iHeadBone
float	m_fTimeSliceUpdate
float	m_fTimeSliceVON
float	m_fTimeSlicePosChange
float	m_fTimeSliceCleanup
float	m_fTimeSliceFade
float	m_fTimeSliceVisibility
float	m_fDistance
float	m_fOpacityFade
float	m_fVisibleOpacity = 1
float	m_fAngleToScreenCenter
vector	m_vTagScreenPos
vector	m_vTagWorldPos
vector	m_vTagWorldPosLast
vector	m_vEntHeadPos
vector	m_vEntWorldPos
string	m_sName
ref array< string >	m_aNameParams
IEntity	m_Entity
Widget	m_NameTagWidget
SCR_VehicleTagData	m_VehicleParent
SCR_CharacterControllerComponent	m_CharController
float	m_fDeadEntitiesCleanup
float	m_fTagFadeSpeed
ref Widget	m_aNametagElements [10]

Protected Member Functions
void	UpdateMainTag ()
	Update main tag (usually driver)
override bool	UpdateEntityStateFlags ()
	Initial check of active states for JIP /return false if invalid/should be cleaned up.
override void	InitDefaults ()
	Init default tag data.
Protected Member Functions inherited from SCR_NameTagData
void	AddAsVehicleOccupant (IEntity vehicle, BaseCompartmentSlot slot, ENameTagFlags flag)
	Add this tag as occupant to a vehicle tag.
void	InitData (SCR_NameTagConfig config)
	Init configurable data.

Additional Inherited Members
Static Public Attributes inherited from SCR_NameTagData
const string	HEAD_BONE = "head"
const string	SPINE_BONE = "Neck1"
const vector	HEAD_OFFSET = "0 0.3 0"
const vector	BODY_OFFSET = "0 -0.1 0"
Protected Attributes inherited from SCR_NameTagData
SCR_NameTagDisplay	m_NTDisplay
BaseCompartmentSlot	m_VehicleCompartment
SCR_GroupsManagerComponent	m_GroupManager
SCR_PossessingManagerComponent	m_PossessingManager

Member Function Documentation

GetMainPlayerID()

int SCR_VehicleTagData.GetMainPlayerID

(

)

Returns playerID of the most important player in the vehicle.

GetName()

override void SCR_VehicleTagData.GetName	(	out string	name,
		out notnull array< string >	nameParams )

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)

Implements SCR_NameTagData.

InitDefaults()

override void SCR_VehicleTagData.InitDefaults ( )

protected

Init default tag data.

Implements SCR_NameTagData.

UpdateEntityStateFlags()

override bool SCR_VehicleTagData.UpdateEntityStateFlags ( )

protected

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

Implements SCR_NameTagData.

UpdateMainTag()

void SCR_VehicleTagData.UpdateMainTag ( )

protected

Update main tag (usually driver)

UpdatePassenger()

void SCR_VehicleTagData.UpdatePassenger	(	SCR_NameTagData	tag,
		bool	IsEntering,
		bool	isControlledEntity = false )

Update current tracked passangers within the vehicle.

UpdateTagPos()

override void SCR_VehicleTagData.UpdateTagPos

(

)

Update tag position.

Implements SCR_NameTagData.

Member Data Documentation

m_aPassengers

ref array<SCR_NameTagData> SCR_VehicleTagData.m_aPassengers = {}

m_bIsControlledPresent

bool SCR_VehicleTagData.m_bIsControlledPresent = false

m_MainTag

SCR_NameTagData SCR_VehicleTagData.m_MainTag

---

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

• Game/UI/Nametags/SCR_VehicleTagData.c