SCR_SelectionMenuEntry Interface Reference

Scripted selection menu entry based on UI info for storing data into SCR_SelectionMenu. More...

Inheritance diagram for SCR_SelectionMenuEntry:

Public Member Functions
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.

Protected Member Functions
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)

Protected Attributes
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.

Detailed Description

Scripted selection menu entry based on UI info for storing data into SCR_SelectionMenu.

Constructor & Destructor Documentation

SCR_SelectionMenuEntry()

void SCR_SelectionMenuEntry.SCR_SelectionMenuEntry

(

)

Member Function Documentation

Enable()

void SCR_SelectionMenuEntry.Enable

(

bool

enable

)

GetCustomLayout()

ResourceName SCR_SelectionMenuEntry.GetCustomLayout

(

)

GetEntryComponent()

SCR_SelectionMenuEntryComponent SCR_SelectionMenuEntry.GetEntryComponent

(

)

GetId()

string SCR_SelectionMenuEntry.GetId

(

)

GetInputAction()

string SCR_SelectionMenuEntry.GetInputAction

(

)

GetOnIconChange()

ScriptInvoker SCR_SelectionMenuEntry.GetOnIconChange

(

)

GetOnPerform()

ScriptInvoker SCR_SelectionMenuEntry.GetOnPerform

(

)

GetOnPerformFail()

ScriptInvoker SCR_SelectionMenuEntry.GetOnPerformFail

(

)

InvokeOnIconChange()

void SCR_SelectionMenuEntry.InvokeOnIconChange ( ResourceName  icon, string  imageSetImage  )

protected

InvokeOnPerform()

void SCR_SelectionMenuEntry.InvokeOnPerform ( )

protected

InvokeOnPerformFail()

void SCR_SelectionMenuEntry.InvokeOnPerformFail ( )

protected

IsEnabled()

bool SCR_SelectionMenuEntry.IsEnabled

(

)

OnEntryClick()

void SCR_SelectionMenuEntry.OnEntryClick ( SCR_SelectionMenuEntryComponent  entryComponent )

protected

OnPerform()

void SCR_SelectionMenuEntry.OnPerform ( )

protected

Empty methods for deifinition of perform behavior.

Implemented in SCR_EditorActionSelectionMenuEntry, SCR_ItemSelectionMenuEntry, and SCR_SelectionMenuCategoryEntry.

Perform()

void SCR_SelectionMenuEntry.Perform

(

)

Public method to call entry perform Don't override! To define entry perform behavior override OnPerform() below.

SetCustomLayout()

void SCR_SelectionMenuEntry.SetCustomLayout

(

ResourceName

layout

)

SetDescription()

void SCR_SelectionMenuEntry.SetDescription

(

string

description

)

SetEntryComponent()

void SCR_SelectionMenuEntry.SetEntryComponent

(

SCR_SelectionMenuEntryComponent

entryComponent

)

Implemented in SCR_MapMarkerMenuCategory, SCR_MapMarkerMenuEntry, and SCR_SelectionMenuEntryCommand.

SetIcon()

void SCR_SelectionMenuEntry.SetIcon	(	ResourceName	iconPath,
		string	imageSetName = ""
	)

Set icon and invoke change.

SetIconFromDeafaultImageSet()

void SCR_SelectionMenuEntry.SetIconFromDeafaultImageSet

(

string

imageSetName = ""

)

SetId()

void SCR_SelectionMenuEntry.SetId

(

string

id

)

SetInputAction()

void SCR_SelectionMenuEntry.SetInputAction

(

string

action

)

SetName()

void SCR_SelectionMenuEntry.SetName

(

string

name

)

Update()

void SCR_SelectionMenuEntry.Update

(

)

Public method to make entry update itself.

Implemented in SCR_ItemSelectionMenuEntry, SCR_VONEntry, and SCR_VONEntryRadio.

Member Data Documentation

m_bEnabled

bool SCR_SelectionMenuEntry.m_bEnabled

protected

m_EntryComponent

ref SCR_SelectionMenuEntryComponent SCR_SelectionMenuEntry.m_EntryComponent

protected

m_OnIconChange

ref ScriptInvoker<SCR_SelectionMenuEntry, ResourceName, string> SCR_SelectionMenuEntry.m_OnIconChange

protected

m_OnPerform

ref ScriptInvoker<SCR_SelectionMenuEntry> SCR_SelectionMenuEntry.m_OnPerform

protected

m_OnPerformFail

ref ScriptInvoker<SCR_SelectionMenuEntry> SCR_SelectionMenuEntry.m_OnPerformFail

protected

m_sCustomLayout

ResourceName SCR_SelectionMenuEntry.m_sCustomLayout

protected

m_sId

string SCR_SelectionMenuEntry.m_sId

protected

m_sInputAction

string SCR_SelectionMenuEntry.m_sInputAction

protected

---

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

• Game/UI/HUD/SelectionMenu/SCR_SelectionMenuEntry.c