SCR_MapMarkerEntrySquadLeader Interface Reference

Squad leader marker entry. More...

Inheritance diagram for SCR_MapMarkerEntrySquadLeader:

Public Member Functions
void	RegisterMarker (SCR_MapMarkerSquadLeader marker, SCR_AIGroup group)
	Register marker here so it can be fetched from the map.
void	UnregisterMarker (SCR_AIGroup group)
override SCR_EMapMarkerType	GetMarkerType ()
	Override this in child classes with own config entries to define type.
override void	InitServerLogic ()
	Override this to set up logic & event behavior on server.
override void	InitClientLogic ()
	Override this to set up logic & event behavior on client.
override void	OnMapLayerChangedDynamic (notnull SCR_MapMarkerDynamicWComponent widgetComp, int layerID)
	Override this to set up client side behavior for when map changes zoom layers.
override void	OnMapOpen (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map open.
override void	OnMapInit (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map init.
Public Member Functions inherited from SCR_MapMarkerEntryDynamic
ResourceName	GetMarkerPrefab ()
override void	InitClientSettingsDynamic (notnull SCR_MapMarkerEntity marker, notnull SCR_MapMarkerDynamicWComponent widgetComp)
	Client side initialization of visuals or other client logic for dynamic markers Override this in children where wanted.
Public Member Functions inherited from SCR_MapMarkerEntryConfig
ResourceName	GetMarkerLayout ()
void	InitClientSettings (SCR_MapMarkerBase marker, SCR_MapMarkerWidgetComponent widgetComp, bool skipProfanityFilter=false)
	Client side initialization of visuals or other client logic Override this in children where wanted.
void	OnMapLayerChanged (notnull SCR_MapMarkerWidgetComponent widgetComp, int layerID)
	Override this to set up client side behavior for when map changes zoom layers.
void	OnMapClose (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map close.

Protected Member Functions
void	FocusCurrentSquad ()
	Pans the map to your own squad.
void	UpdateToolEntryState ()
	Enables/disables the map tool button for panning to your squad.
void	OnPlayableGroupCreated (SCR_AIGroup group)
	SCR_GroupsManagerComponent event.
void	OnPlayableGroupRemoved (SCR_AIGroup group)
	SCR_GroupsManagerComponent event.
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.
void	OnPlayerSpawned (int playerId, IEntity player)
	SCR_BaseGameMode event.
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	SCR_BaseGameMode event.
void	OnPlayerDeleted (int playerId, IEntity player)
	SCR_BaseGameMode event.
void	OnGroupCustomNameChanged (SCR_AIGroup group)
	SCR_AIGroup event.
void	UpdateMarkerTarget (int playerID)
	Update marker target, will trigger creation of a marker if within map.

Protected Attributes
SCR_GroupsManagerComponent	m_GroupsManager
SCR_MapToolEntry	m_ToolMenuEntry
SCR_AIGroup	m_bCurrentSquad
ref map< SCR_AIGroup, SCR_MapMarkerSquadLeader >	m_mGroupMarkers = new map<SCR_AIGroup, SCR_MapMarkerSquadLeader>()
Protected Attributes inherited from SCR_MapMarkerEntryDynamic
ResourceName	m_sMarkerPrefab
SCR_MapMarkerManagerComponent	m_MarkerMgr
Protected Attributes inherited from SCR_MapMarkerEntryConfig
ResourceName	m_sMarkerLayout

Detailed Description

Squad leader marker entry.

Member Function Documentation

FocusCurrentSquad()

void SCR_MapMarkerEntrySquadLeader.FocusCurrentSquad ( )

protected

Pans the map to your own squad.

GetMarkerType()

override SCR_EMapMarkerType SCR_MapMarkerEntrySquadLeader.GetMarkerType

(

)

Override this in child classes with own config entries to define type.

Implements SCR_MapMarkerEntryConfig.

InitClientLogic()

override void SCR_MapMarkerEntrySquadLeader.InitClientLogic

(

)

Override this to set up logic & event behavior on client.

Implements SCR_MapMarkerEntryConfig.

InitServerLogic()

override void SCR_MapMarkerEntrySquadLeader.InitServerLogic

(

)

Override this to set up logic & event behavior on server.

Implements SCR_MapMarkerEntryDynamic.

OnGroupCustomNameChanged()

void SCR_MapMarkerEntrySquadLeader.OnGroupCustomNameChanged ( SCR_AIGroup group )

protected

SCR_AIGroup event.

OnMapInit()

override void SCR_MapMarkerEntrySquadLeader.OnMapInit	(	notnull SCR_MapEntity	mapEnt,
		notnull SCR_MapMarkersUI	markerUIComp )

Override this to set up client side behavior on map init.

Implements SCR_MapMarkerEntryConfig.

OnMapLayerChangedDynamic()

override void SCR_MapMarkerEntrySquadLeader.OnMapLayerChangedDynamic	(	notnull SCR_MapMarkerDynamicWComponent	widgetComp,
		int	layerID )

Override this to set up client side behavior for when map changes zoom layers.

Implements SCR_MapMarkerEntryConfig.

OnMapOpen()

override void SCR_MapMarkerEntrySquadLeader.OnMapOpen	(	notnull SCR_MapEntity	mapEnt,
		notnull SCR_MapMarkersUI	markerUIComp )

Override this to set up client side behavior on map open.

Implements SCR_MapMarkerEntryConfig.

OnPlayableGroupCreated()

void SCR_MapMarkerEntrySquadLeader.OnPlayableGroupCreated ( SCR_AIGroup group )

protected

SCR_GroupsManagerComponent event.

OnPlayableGroupRemoved()

void SCR_MapMarkerEntrySquadLeader.OnPlayableGroupRemoved ( SCR_AIGroup group )

protected

SCR_GroupsManagerComponent event.

OnPlayerAdded()

void SCR_MapMarkerEntrySquadLeader.OnPlayerAdded ( SCR_AIGroup group, int playerId )

protected

SCR_AIGroup event.

OnPlayerDeleted()

void SCR_MapMarkerEntrySquadLeader.OnPlayerDeleted ( int playerId, IEntity player )

protected

SCR_BaseGameMode event.

OnPlayerKilled()

void SCR_MapMarkerEntrySquadLeader.OnPlayerKilled ( notnull SCR_InstigatorContextData instigatorContextData )

protected

SCR_BaseGameMode event.

OnPlayerLeaderChanged()

void SCR_MapMarkerEntrySquadLeader.OnPlayerLeaderChanged ( int groupID, int playerId )

protected

SCR_AIGroup event.

OnPlayerRemoved()

void SCR_MapMarkerEntrySquadLeader.OnPlayerRemoved ( SCR_AIGroup group, int playerId )

protected

SCR_AIGroup event.

OnPlayerSpawned()

void SCR_MapMarkerEntrySquadLeader.OnPlayerSpawned ( int playerId, IEntity player )

protected

SCR_BaseGameMode event.

RegisterMarker()

void SCR_MapMarkerEntrySquadLeader.RegisterMarker	(	SCR_MapMarkerSquadLeader	marker,
		SCR_AIGroup	group )

Register marker here so it can be fetched from the map.

UnregisterMarker()

void SCR_MapMarkerEntrySquadLeader.UnregisterMarker

(

SCR_AIGroup

group

)

UpdateMarkerTarget()

void SCR_MapMarkerEntrySquadLeader.UpdateMarkerTarget ( int playerID )

protected

Update marker target, will trigger creation of a marker if within map.

UpdateToolEntryState()

void SCR_MapMarkerEntrySquadLeader.UpdateToolEntryState ( )

protected

Enables/disables the map tool button for panning to your squad.

Member Data Documentation

m_bCurrentSquad

SCR_AIGroup SCR_MapMarkerEntrySquadLeader.m_bCurrentSquad

protected

m_GroupsManager

SCR_GroupsManagerComponent SCR_MapMarkerEntrySquadLeader.m_GroupsManager

protected

m_mGroupMarkers

ref map<SCR_AIGroup, SCR_MapMarkerSquadLeader> SCR_MapMarkerEntrySquadLeader.m_mGroupMarkers = new map<SCR_AIGroup, SCR_MapMarkerSquadLeader>()

protected

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapMarkerEntrySquadLeader.m_ToolMenuEntry

protected

---

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

• Game/Map/Markers/Config/SCR_MapMarkerEntrySquadLeader.c