SCR_MapMarkerSquadMember Interface Reference

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

Inheritance diagram for SCR_MapMarkerSquadMember:

Public Member Functions
void	UpdateLocalVisibility ()
	Check whether we are in a squad and if it should be visible on map.
void	OnPlayerIdUpdate ()
	Rpl event when m_iPlayerID is updated.
void	SetPlayerID (int id)
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	OnUpdate ()
	Called from SCR_MapMarkerManagerComponent.
void	~SCR_MapMarkerSquadMember ()
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	OnDelete ()
void	LayerChangeLogic (int layerID)
void	SCR_MapMarkerEntity (IEntitySource src, IEntity parent)
void	~SCR_MapMarkerEntity ()

Protected Member Functions
void	UpdateTarget ()
	Target tracking based on playerID Authority only.
void	OnPlayerLeaderChanged (int groupID, int playerId)
	SCR_AIGroup event.
void	OnPlayerAdded (SCR_AIGroup group, int playerId)
	SCR_AIGroup event.
void	OnPlayerRemoved (SCR_AIGroup group, int playerId)
	SCR_AIGroup event.
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)
override void	EOnFrame (IEntity owner, float timeSlice)
	Authority side update.

Protected Attributes
int	m_iPlayerID
SCR_MapMarkerSquadMemberComponent	m_SquadMemberWidgetComp
bool	m_bDoLocalVisibilityUpdate
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 member.

Constructor & Destructor Documentation

~SCR_MapMarkerSquadMember()

void SCR_MapMarkerSquadMember.~SCR_MapMarkerSquadMember

(

)

Member Function Documentation

EOnInit()

override void SCR_MapMarkerSquadMember.EOnInit ( IEntity owner )

protected

Implements SCR_MapMarkerEntity.

OnCreateMarker()

override void SCR_MapMarkerSquadMember.OnCreateMarker

(

)

Fetch marker definition from config & create widget.

Implements SCR_MapMarkerEntity.

OnMapLayerChanged()

override void SCR_MapMarkerSquadMember.OnMapLayerChanged ( int layerID )

protected

Implements SCR_MapMarkerEntity.

OnPlayerAdded()

void SCR_MapMarkerSquadMember.OnPlayerAdded ( SCR_AIGroup group, int playerId )

protected

SCR_AIGroup event.

OnPlayerIdUpdate()

void SCR_MapMarkerSquadMember.OnPlayerIdUpdate

(

)

Rpl event when m_iPlayerID is updated.

OnPlayerLeaderChanged()

void SCR_MapMarkerSquadMember.OnPlayerLeaderChanged ( int groupID, int playerId )

protected

SCR_AIGroup event.

OnPlayerRemoved()

void SCR_MapMarkerSquadMember.OnPlayerRemoved ( SCR_AIGroup group, int playerId )

protected

SCR_AIGroup event.

OnUpdate()

override void SCR_MapMarkerSquadMember.OnUpdate

(

)

Called from SCR_MapMarkerManagerComponent.

Implements SCR_MapMarkerEntity.

SetPlayerID()

void SCR_MapMarkerSquadMember.SetPlayerID

(

int

id

)

Parameters

[in]

id

UpdateLocalVisibility()

void SCR_MapMarkerSquadMember.UpdateLocalVisibility

(

)

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

UpdatePlayerAffiliation()

void SCR_MapMarkerSquadMember.UpdatePlayerAffiliation

(

)

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

UpdateTarget()

void SCR_MapMarkerSquadMember.UpdateTarget ( )

protected

Target tracking based on playerID Authority only.

Member Data Documentation

m_bDoLocalVisibilityUpdate

bool SCR_MapMarkerSquadMember.m_bDoLocalVisibilityUpdate

protected

m_iPlayerID

int SCR_MapMarkerSquadMember.m_iPlayerID

protected

m_SquadMemberWidgetComp

SCR_MapMarkerSquadMemberComponent SCR_MapMarkerSquadMember.m_SquadMemberWidgetComp

protected

---

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

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