SCR_MapMarkerEntryPlaced Interface Reference

Marker entry which can be placed through map. More...

Inheritance diagram for SCR_MapMarkerEntryPlaced:

Public Member Functions
string	GetMenuDescription ()
ResourceName	GetMenuImageset ()
string	GetMenuIcon ()
Color	GetColorEntry (int i)
bool	GetIconEntry (int i, out ResourceName imageset, out ResourceName imagesetGlow, out string imageQuad)
int	GetIconCategoryID (int iconID)
array< ref SCR_MarkerColorEntry >	GetColorEntries ()
array< ref SCR_MarkerIconEntry >	GetIconEntries ()
array< ref SCR_MarkerIconCategory >	GetIconCategories ()
override SCR_EMapMarkerType	GetMarkerType ()
	Override this in child classes with own config entries to define type.
override 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.
override void	OnMapLayerChanged (notnull SCR_MapMarkerWidgetComponent widgetComp, int layerID)
	Override this to set up client side behavior for when map changes zoom layers.
Public Member Functions inherited from SCR_MapMarkerEntryConfig
ResourceName	GetMarkerLayout ()
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	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
string	m_sMenuDescription
ResourceName	m_sMenuImageset
string	m_sMenuIcon
ref array< ref SCR_MarkerIconCategory >	m_aPlacedMarkerIconCategories
ref array< ref SCR_MarkerIconEntry >	m_aPlacedMarkerIcons
ref array< ref SCR_MarkerColorEntry >	m_aPlacedMarkerColors
Protected Attributes inherited from SCR_MapMarkerEntryConfig
ResourceName	m_sMarkerLayout

Detailed Description

Marker entry which can be placed through map.

Member Function Documentation

GetColorEntries()

array< ref SCR_MarkerColorEntry > SCR_MapMarkerEntryPlaced.GetColorEntries

(

)

GetColorEntry()

Color SCR_MapMarkerEntryPlaced.GetColorEntry

(

int

i

)

GetIconCategories()

array< ref SCR_MarkerIconCategory > SCR_MapMarkerEntryPlaced.GetIconCategories

(

)

GetIconCategoryID()

int SCR_MapMarkerEntryPlaced.GetIconCategoryID

(

int

iconID

)

GetIconEntries()

array< ref SCR_MarkerIconEntry > SCR_MapMarkerEntryPlaced.GetIconEntries

(

)

GetIconEntry()

bool SCR_MapMarkerEntryPlaced.GetIconEntry	(	int	i,
		out ResourceName	imageset,
		out ResourceName	imagesetGlow,
		out string	imageQuad )

GetMarkerType()

override SCR_EMapMarkerType SCR_MapMarkerEntryPlaced.GetMarkerType

(

)

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

Implements SCR_MapMarkerEntryConfig.

GetMenuDescription()

string SCR_MapMarkerEntryPlaced.GetMenuDescription

(

)

GetMenuIcon()

string SCR_MapMarkerEntryPlaced.GetMenuIcon

(

)

GetMenuImageset()

ResourceName SCR_MapMarkerEntryPlaced.GetMenuImageset

(

)

InitClientSettings()

override void SCR_MapMarkerEntryPlaced.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.

Implements SCR_MapMarkerEntryConfig.

OnMapLayerChanged()

override void SCR_MapMarkerEntryPlaced.OnMapLayerChanged	(	notnull SCR_MapMarkerWidgetComponent	widgetComp,
		int	layerID )

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

Implements SCR_MapMarkerEntryConfig.

Member Data Documentation

m_aPlacedMarkerColors

ref array<ref SCR_MarkerColorEntry> SCR_MapMarkerEntryPlaced.m_aPlacedMarkerColors

protected

m_aPlacedMarkerIconCategories

ref array<ref SCR_MarkerIconCategory> SCR_MapMarkerEntryPlaced.m_aPlacedMarkerIconCategories

protected

m_aPlacedMarkerIcons

ref array<ref SCR_MarkerIconEntry> SCR_MapMarkerEntryPlaced.m_aPlacedMarkerIcons

protected

m_sMenuDescription

string SCR_MapMarkerEntryPlaced.m_sMenuDescription

protected

m_sMenuIcon

string SCR_MapMarkerEntryPlaced.m_sMenuIcon

protected

m_sMenuImageset

ResourceName SCR_MapMarkerEntryPlaced.m_sMenuImageset

protected

---

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

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