SCR_MapMarkerSquadLeader Interface Reference

Dynamic map marker -> squad leader. More...

Inheritance diagram for SCR_MapMarkerSquadLeader:

Public Member Functions
void	OnPlayerIdUpdate ()
void	SetPlayerID (int id)
void	SetTextUpdate ()
SCR_AIGroup	GetGroup ()
void	UpdatePlayerAffiliation ()
	Check whether we are in a squad and if it should be visible on map.
override void	OnCreateMarker ()
	Fetch marker definition from config & create widget.
override void	OnDelete ()
override void	OnUpdate ()
	Called from SCR_MapMarkerManagerComponent.
void	~SCR_MapMarkerSquadLeader ()
Public Member Functions inherited from SCR_MapMarkerEntity
void	SetLocalVisible (bool state)
SCR_EMapMarkerType	GetType ()
int	GetMarkerConfigID ()
void	SetText (string text)
string	GetText ()
void	SetImage (string imageset, string icon)
void	GetImageResource (out ResourceName imageset, out string imageQuad)
vector	GetWorldPos ()
	Get world position coordinates.
void	SetType (SCR_EMapMarkerType type, int configID=-1)
void	SetGlobalVisible (bool state)
IEntity	GetTarget ()
	Return entity this marker is tracking.
void	SetTarget (IEntity target)
	Set entity this marker is tracking.
Faction	GetFaction ()
void	SetFaction (Faction faction)
void	OnCreateMarker ()
	Fetch marker definition from config & create widget.
void	OnDelete ()
void	LayerChangeLogic (int layerID)
void	OnUpdate ()
	Called from SCR_MapMarkerManagerComponent.
void	SCR_MapMarkerEntity (IEntitySource src, IEntity parent)
void	~SCR_MapMarkerEntity ()

Public Attributes
bool	m_bDoGroupTextUpdate

Static Public Attributes
const float	SL_UPDATE_DELAY = 1

Protected Member Functions
void	AssignGroup ()
void	UpdateTarget ()
	Target tracking based on playerID Authority only.
void	UpdateGroupMilitarySymbol ()
	Set military symbol image, can change during lifetime.
void	UpdateGroupText ()
	Set group text, can change during lifetime.
void	OnUserSettingsChanged ()
	Update names when user settings are changed (f.e. xbox UGC)
void	OnFlagSelected ()
	SCR_AIGroup event Triggers when squad flag is changed.
override void	OnMapLayerChanged (int layerID)
override void	EOnInit (IEntity owner)
Protected Member Functions inherited from SCR_MapMarkerEntity
void	OnUpdateType ()
	used client side for initial visibility set
void	OnUpdatePosition ()
	for override within children classes
void	OnUpdateVisibility ()
	Create or destroy marker widget based on current state.
bool	IsVisible ()
void	OnMapClosed (MapConfiguration config)
void	OnMapLayerChanged (int layerID)
override void	EOnInit (IEntity owner)
override void	EOnFrame (IEntity owner, float timeSlice)
	Authority side update.

Protected Attributes
int	m_PlayerID
bool	m_bDoGroupSymbolUpdate
SCR_AIGroup	m_Group
SCR_MapMarkerSquadLeaderComponent	m_SquadLeaderWidgetComp
Protected Attributes inherited from SCR_MapMarkerEntity
SCR_EMapMarkerType	m_eType
int	m_iConfigID = -1
vector	m_vPos
bool	m_bIsGlobalVisible
bool	m_bIsLocalVisible = true
int	m_iScreenX
int	m_iScreenY
float	m_fUpdateDelay = 1
float	m_fTimeTracker
string	m_sText
ResourceName	m_sImageset
string	m_sIconName
SCR_MapMarkerEntryDynamic	m_ConfigEntry
Widget	m_wRoot
SCR_MapEntity	m_MapEntity
SCR_MapMarkerDynamicWComponent	m_MarkerWidgetComp
IEntity	m_Target
Faction	m_MarkerFaction

Detailed Description

Dynamic map marker -> squad leader.

Constructor & Destructor Documentation

~SCR_MapMarkerSquadLeader()

void SCR_MapMarkerSquadLeader.~SCR_MapMarkerSquadLeader

(

)

Member Function Documentation

AssignGroup()

void SCR_MapMarkerSquadLeader.AssignGroup ( )

protected

EOnInit()

override void SCR_MapMarkerSquadLeader.EOnInit ( IEntity  owner )

protected

Implements SCR_MapMarkerEntity.

GetGroup()

SCR_AIGroup SCR_MapMarkerSquadLeader.GetGroup

(

)

OnCreateMarker()

override void SCR_MapMarkerSquadLeader.OnCreateMarker

(

)

Fetch marker definition from config & create widget.

Implements SCR_MapMarkerEntity.

OnDelete()

override void SCR_MapMarkerSquadLeader.OnDelete

(

)

Implements SCR_MapMarkerEntity.

OnFlagSelected()

void SCR_MapMarkerSquadLeader.OnFlagSelected ( )

protected

SCR_AIGroup event Triggers when squad flag is changed.

OnMapLayerChanged()

override void SCR_MapMarkerSquadLeader.OnMapLayerChanged ( int  layerID )

protected

Implements SCR_MapMarkerEntity.

OnPlayerIdUpdate()

void SCR_MapMarkerSquadLeader.OnPlayerIdUpdate

(

)

OnUpdate()

override void SCR_MapMarkerSquadLeader.OnUpdate

(

)

Called from SCR_MapMarkerManagerComponent.

Implements SCR_MapMarkerEntity.

OnUserSettingsChanged()

void SCR_MapMarkerSquadLeader.OnUserSettingsChanged ( )

protected

Update names when user settings are changed (f.e. xbox UGC)

SetPlayerID()

void SCR_MapMarkerSquadLeader.SetPlayerID

(

int

id

)

SetTextUpdate()

void SCR_MapMarkerSquadLeader.SetTextUpdate

(

)

UpdateGroupMilitarySymbol()

void SCR_MapMarkerSquadLeader.UpdateGroupMilitarySymbol ( )

protected

Set military symbol image, can change during lifetime.

UpdateGroupText()

void SCR_MapMarkerSquadLeader.UpdateGroupText ( )

protected

Set group text, can change during lifetime.

UpdatePlayerAffiliation()

void SCR_MapMarkerSquadLeader.UpdatePlayerAffiliation

(

)

Check whether we are in a squad and if it should be visible on map.

UpdateTarget()

void SCR_MapMarkerSquadLeader.UpdateTarget ( )

protected

Target tracking based on playerID Authority only.

Member Data Documentation

m_bDoGroupSymbolUpdate

bool SCR_MapMarkerSquadLeader.m_bDoGroupSymbolUpdate

protected

m_bDoGroupTextUpdate

bool SCR_MapMarkerSquadLeader.m_bDoGroupTextUpdate

m_Group

SCR_AIGroup SCR_MapMarkerSquadLeader.m_Group

protected

m_PlayerID

int SCR_MapMarkerSquadLeader.m_PlayerID

protected

m_SquadLeaderWidgetComp

SCR_MapMarkerSquadLeaderComponent SCR_MapMarkerSquadLeader.m_SquadLeaderWidgetComp

protected

SL_UPDATE_DELAY

const float SCR_MapMarkerSquadLeader.SL_UPDATE_DELAY = 1

static

---

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

• Game/Map/Markers/Objects/SCR_MapMarkerSquadLeader.c