SCR_MapMarkerEntryConfig Interface Reference

Base entry config. More...

Inheritance diagram for SCR_MapMarkerEntryConfig:

Public Member Functions
SCR_EMapMarkerType	GetMarkerType ()
	Override this in child classes with own config entries to define type.
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	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.
void	InitServerLogic ()
	Override this to set up server side logic & event behavior for dynamic markers.
void	InitClientLogic ()
	Override this to set up logic & event behavior on client.
void	OnMapLayerChanged (notnull SCR_MapMarkerWidgetComponent widgetComp, int layerID)
	Override this to set up client side behavior for when map changes zoom layers.
void	OnMapLayerChangedDynamic (notnull SCR_MapMarkerDynamicWComponent widgetComp, int layerID)
	Override this to set up client side behavior for when map changes zoom layers.
void	OnMapInit (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map init.
void	OnMapOpen (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map open.
void	OnMapClose (notnull SCR_MapEntity mapEnt, notnull SCR_MapMarkersUI markerUIComp)
	Override this to set up client side behavior on map close.

Protected Attributes
ResourceName	m_sMarkerLayout

Detailed Description

Base entry config.

Member Function Documentation

GetMarkerLayout()

ResourceName SCR_MapMarkerEntryConfig.GetMarkerLayout

(

)

GetMarkerType()

SCR_EMapMarkerType SCR_MapMarkerEntryConfig.GetMarkerType

(

)

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

Implemented in SCR_MapMarkerEntryDotCircle, SCR_MapMarkerEntryDynamicExample, SCR_MapMarkerEntryImageText, SCR_MapMarkerEntryMilitary, SCR_MapMarkerEntryPlaced, SCR_MapMarkerEntryRecon, SCR_MapMarkerEntrySquadLeader, and SCR_MapMarkerEntrySquadMember.

InitClientLogic()

void SCR_MapMarkerEntryConfig.InitClientLogic

(

)

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

Implemented in SCR_MapMarkerEntrySquadLeader.

InitClientSettings()

void SCR_MapMarkerEntryConfig.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.

Implemented in SCR_MapMarkerEntryImageText, SCR_MapMarkerEntryMilitary, and SCR_MapMarkerEntryPlaced.

InitClientSettingsDynamic()

void SCR_MapMarkerEntryConfig.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.

Implemented in SCR_MapMarkerEntryDynamic, SCR_MapMarkerEntryDynamicExample, and SCR_MapMarkerEntrySquadMember.

InitServerLogic()

void SCR_MapMarkerEntryConfig.InitServerLogic

(

)

Override this to set up server side logic & event behavior for dynamic markers.

Implemented in SCR_MapMarkerEntryDynamic, SCR_MapMarkerEntryDynamicExample, SCR_MapMarkerEntrySquadLeader, and SCR_MapMarkerEntrySquadMember.

OnMapClose()

void SCR_MapMarkerEntryConfig.OnMapClose	(	notnull SCR_MapEntity	mapEnt,
		notnull SCR_MapMarkersUI	markerUIComp )

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

OnMapInit()

void SCR_MapMarkerEntryConfig.OnMapInit	(	notnull SCR_MapEntity	mapEnt,
		notnull SCR_MapMarkersUI	markerUIComp )

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

Implemented in SCR_MapMarkerEntrySquadLeader.

OnMapLayerChanged()

void SCR_MapMarkerEntryConfig.OnMapLayerChanged	(	notnull SCR_MapMarkerWidgetComponent	widgetComp,
		int	layerID )

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

Implemented in SCR_MapMarkerEntryMilitary, and SCR_MapMarkerEntryPlaced.

OnMapLayerChangedDynamic()

void SCR_MapMarkerEntryConfig.OnMapLayerChangedDynamic	(	notnull SCR_MapMarkerDynamicWComponent	widgetComp,
		int	layerID )

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

Implemented in SCR_MapMarkerEntrySquadLeader, and SCR_MapMarkerEntrySquadMember.

OnMapOpen()

void SCR_MapMarkerEntryConfig.OnMapOpen	(	notnull SCR_MapEntity	mapEnt,
		notnull SCR_MapMarkersUI	markerUIComp )

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

Implemented in SCR_MapMarkerEntrySquadLeader.

Member Data Documentation

m_sMarkerLayout

ResourceName SCR_MapMarkerEntryConfig.m_sMarkerLayout

protected

---

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

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