SCR_MapMarkerMenuEntry Interface Reference

Base entry for marker selection menu. More...

Inheritance diagram for SCR_MapMarkerMenuEntry:

Public Member Functions
SCR_EMapMarkerType	GetMarkerType ()
void	SetMarkerType (SCR_EMapMarkerType type)
int	GetMarkerConfigID ()
void	SetMarkerConfigID (int id)
void	SetSymbolProps (EMilitarySymbolIdentity faction, Color color, EMilitarySymbolDimension dimension, EMilitarySymbolIcon iconFlag, EMilitarySymbolAmplifier amplifier)
	Set military symbol properties.
void	SetLayout ()
	Set custom layout based on marker type.
override void	SetEntryComponent (SCR_SelectionMenuEntryComponent entryComponent)
void	SCR_MapMarkerMenuEntry ()
Public Member Functions inherited from SCR_SelectionMenuEntry
ScriptInvoker	GetOnPerform ()
ScriptInvoker	GetOnPerformFail ()
ScriptInvoker	GetOnIconChange ()
void	Update ()
	Public method to make entry update itself.
void	Perform ()
	Public method to call entry perform Don't override! To define entry perform behavior override OnPerform() below.
void	Enable (bool enable)
void	SetId (string id)
string	GetId ()
void	SetName (string name)
void	SetDescription (string description)
void	SetIcon (ResourceName iconPath, string imageSetName="")
	Set icon and invoke change.
void	SetIconFromDeafaultImageSet (string imageSetName="")
ResourceName	GetCustomLayout ()
void	SetCustomLayout (ResourceName layout)
void	SetEntryComponent (SCR_SelectionMenuEntryComponent entryComponent)
SCR_SelectionMenuEntryComponent	GetEntryComponent ()
bool	IsEnabled ()
void	SetInputAction (string action)
string	GetInputAction ()
void	SCR_SelectionMenuEntry ()
Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.
string	GetIconSetName ()
	Returns Icon Set name if imageset.
bool	HasIcon ()
	Check if the info has an icon defined.
bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.
void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.
LocalizedString	GetDescription ()
	Get description.
bool	HasDescription ()
	Check if the info has a description defined.
bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.
void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.
LocalizedString	GetName ()
	Get name.
bool	HasName ()
	Check if the info has a name defined.
bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.
void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Static Public Attributes
const string	WIDGET_SYMBOL = "SymbolOverlay"

Protected Attributes
int	m_iMarkerConfigID
SCR_EMapMarkerType	m_eMarkerType
SCR_MilitarySymbolUIComponent	m_SymbolComp
ref Color	m_Color = GUIColors.DEFAULT
ref SCR_MilitarySymbol	m_MilSymbol = new SCR_MilitarySymbol()
Protected Attributes inherited from SCR_SelectionMenuEntry
string	m_sId
bool	m_bEnabled
string	m_sInputAction
ResourceName	m_sCustomLayout
ref SCR_SelectionMenuEntryComponent	m_EntryComponent
ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerform
ref ScriptInvoker< SCR_SelectionMenuEntry >	m_OnPerformFail
ref ScriptInvoker< SCR_SelectionMenuEntry, ResourceName, string >	m_OnIconChange
Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon
string	IconSetName
Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description
Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.
static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.
static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.
static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.
Protected Member Functions inherited from SCR_SelectionMenuEntry
void	InvokeOnPerform ()
void	InvokeOnPerformFail ()
void	InvokeOnIconChange (ResourceName icon, string imageSetImage)
void	OnPerform ()
	Empty methods for deifinition of perform behavior.
void	OnEntryClick (SCR_SelectionMenuEntryComponent entryComponent)
Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
void	CopyFrom (SCR_UIName source)

Detailed Description

Base entry for marker selection menu.

Constructor & Destructor Documentation

SCR_MapMarkerMenuEntry()

void SCR_MapMarkerMenuEntry.SCR_MapMarkerMenuEntry

(

)

Member Function Documentation

GetMarkerConfigID()

int SCR_MapMarkerMenuEntry.GetMarkerConfigID

(

)

GetMarkerType()

SCR_EMapMarkerType SCR_MapMarkerMenuEntry.GetMarkerType

(

)

SetEntryComponent()

override void SCR_MapMarkerMenuEntry.SetEntryComponent

(

SCR_SelectionMenuEntryComponent

entryComponent

)

Implements SCR_SelectionMenuEntry.

SetLayout()

void SCR_MapMarkerMenuEntry.SetLayout

(

)

Set custom layout based on marker type.

SetMarkerConfigID()

void SCR_MapMarkerMenuEntry.SetMarkerConfigID

(

int

id

)

SetMarkerType()

void SCR_MapMarkerMenuEntry.SetMarkerType

(

SCR_EMapMarkerType

type

)

SetSymbolProps()

void SCR_MapMarkerMenuEntry.SetSymbolProps	(	EMilitarySymbolIdentity	faction,
		Color	color,
		EMilitarySymbolDimension	dimension,
		EMilitarySymbolIcon	iconFlag,
		EMilitarySymbolAmplifier	amplifier
	)

Set military symbol properties.

Member Data Documentation

m_Color

ref Color SCR_MapMarkerMenuEntry.m_Color = GUIColors.DEFAULT

protected

m_eMarkerType

SCR_EMapMarkerType SCR_MapMarkerMenuEntry.m_eMarkerType

protected

m_iMarkerConfigID

int SCR_MapMarkerMenuEntry.m_iMarkerConfigID

protected

m_MilSymbol

ref SCR_MilitarySymbol SCR_MapMarkerMenuEntry.m_MilSymbol = new SCR_MilitarySymbol()

protected

m_SymbolComp

SCR_MilitarySymbolUIComponent SCR_MapMarkerMenuEntry.m_SymbolComp

protected

WIDGET_SYMBOL

const string SCR_MapMarkerMenuEntry.WIDGET_SYMBOL = "SymbolOverlay"

static

---

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

• Game/Map/Markers/SCR_MapMarkerMenuEntry.c