SCR_MapMarkerEntryMilitary Interface Reference

Marker military symbol entry. More...

Inheritance diagram for SCR_MapMarkerEntryMilitary:

Public Member Functions
string	GetMenuDescription ()
ResourceName	GetMenuImageset ()
string	GetMenuIcon ()
array< ref SCR_MarkerMilitaryFactionEntry >	GetMilitaryFactionEntries ()
SCR_MarkerMilitaryFactionEntry	GetFactionEntry (int i)
int	GetFactionEntryID (EMilitarySymbolIdentity faction)
array< ref SCR_MarkerMilitaryDimension >	GetMilitaryDimensions ()
SCR_MarkerMilitaryDimension	GetDimensionEntry (int i)
int	GetDimensionEntryID (EMilitarySymbolDimension dimension)
array< ref SCR_MarkerMilitaryType >	GetMilitaryTypes ()
SCR_MarkerMilitaryType	GetTypeEntry (int i)
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)
	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
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)
	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.

Static Public Attributes
const int	FACTION_DETERMINATOR = 100
const float	DIMENSION_DETERMINATOR = 0.01

Protected Attributes
string	m_sMenuDescription
ResourceName	m_sMenuImageset
string	m_sMenuIcon
ref array< ref SCR_MarkerMilitaryFactionEntry >	m_aMilitaryFactionEntries
ref array< ref SCR_MarkerMilitaryDimension >	m_aMilitaryDimensions
ref array< ref SCR_MarkerMilitaryType >	m_aMilitaryTypes
Protected Attributes inherited from SCR_MapMarkerEntryConfig
ResourceName	m_sMarkerLayout

Detailed Description

Marker military symbol entry.

Member Function Documentation

GetDimensionEntry()

SCR_MarkerMilitaryDimension SCR_MapMarkerEntryMilitary.GetDimensionEntry

(

int

i

)

GetDimensionEntryID()

int SCR_MapMarkerEntryMilitary.GetDimensionEntryID

(

EMilitarySymbolDimension

dimension

)

GetFactionEntry()

SCR_MarkerMilitaryFactionEntry SCR_MapMarkerEntryMilitary.GetFactionEntry

(

int

i

)

GetFactionEntryID()

int SCR_MapMarkerEntryMilitary.GetFactionEntryID

(

EMilitarySymbolIdentity

faction

)

GetMarkerType()

override SCR_EMapMarkerType SCR_MapMarkerEntryMilitary.GetMarkerType

(

)

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

Implements SCR_MapMarkerEntryConfig.

GetMenuDescription()

string SCR_MapMarkerEntryMilitary.GetMenuDescription

(

)

GetMenuIcon()

string SCR_MapMarkerEntryMilitary.GetMenuIcon

(

)

GetMenuImageset()

ResourceName SCR_MapMarkerEntryMilitary.GetMenuImageset

(

)

GetMilitaryDimensions()

array< ref SCR_MarkerMilitaryDimension > SCR_MapMarkerEntryMilitary.GetMilitaryDimensions

(

)

GetMilitaryFactionEntries()

array< ref SCR_MarkerMilitaryFactionEntry > SCR_MapMarkerEntryMilitary.GetMilitaryFactionEntries

(

)

GetMilitaryTypes()

array< ref SCR_MarkerMilitaryType > SCR_MapMarkerEntryMilitary.GetMilitaryTypes

(

)

GetTypeEntry()

SCR_MarkerMilitaryType SCR_MapMarkerEntryMilitary.GetTypeEntry

(

int

i

)

InitClientSettings()

override void SCR_MapMarkerEntryMilitary.InitClientSettings	(	SCR_MapMarkerBase	marker,
		SCR_MapMarkerWidgetComponent	widgetComp
	)

Client side initialization of visuals or other client logic Override this in children where wanted.

Implements SCR_MapMarkerEntryConfig.

OnMapLayerChanged()

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

DIMENSION_DETERMINATOR

const float SCR_MapMarkerEntryMilitary.DIMENSION_DETERMINATOR = 0.01

static

FACTION_DETERMINATOR

const int SCR_MapMarkerEntryMilitary.FACTION_DETERMINATOR = 100

static

m_aMilitaryDimensions

ref array<ref SCR_MarkerMilitaryDimension> SCR_MapMarkerEntryMilitary.m_aMilitaryDimensions

protected

m_aMilitaryFactionEntries

ref array<ref SCR_MarkerMilitaryFactionEntry> SCR_MapMarkerEntryMilitary.m_aMilitaryFactionEntries

protected

m_aMilitaryTypes

ref array<ref SCR_MarkerMilitaryType> SCR_MapMarkerEntryMilitary.m_aMilitaryTypes

protected

m_sMenuDescription

string SCR_MapMarkerEntryMilitary.m_sMenuDescription

protected

m_sMenuIcon

string SCR_MapMarkerEntryMilitary.m_sMenuIcon

protected

m_sMenuImageset

ResourceName SCR_MapMarkerEntryMilitary.m_sMenuImageset

protected

---

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

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