ScriptedSelectionMenuEntry Interface Reference

Inheritance diagram for ScriptedSelectionMenuEntry:

Public Member Functions
override void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
override bool	CanBeShownScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
override bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
override bool	GetEntryNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.
override bool	GetEntryDescriptionScript (out string outDescription)
	If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.
override bool	GetEntryIconPathScript (out string outIconPath)
	If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.
override UIInfo	GetUIInfoScript ()
	Can be overridden to return desired UIInfo in GetUIInfo method.
void	UpdateVisuals ()
	Base visuals update function for specific entry update.
ResourceName	GetEntryLayout ()
	API for entry widget and component.
void	SetEntryLayout (ResourceName entryLayout)
Widget	GetEntryWidget ()
void	SetEntryWidget (Widget root)
string	GetName ()
void	SetName (string name)
Public Member Functions inherited from BaseSelectionMenuEntry
proto external bool	CanBeShown (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
proto external bool	CanBePerformed (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
proto external void	Perform (IEntity user, BaseSelectionMenu sourceMenu)
	Request to perform this entry.
proto external string	GetEntryName ()
	Return the name of this entry.
proto external string	GetEntryDescription ()
	Return the description of this entry.
proto external string	GetEntryIconPath ()
	Return the icon path of this entry.
proto external UIInfo	GetUIInfo ()
	Get related UI info or null if none.

Static Public Attributes
const string	LAYOUT_ENTRY_DEFAULT = "{121C45A1F59DC1AF}UI/layouts/Common/RadialMenu/RadialEntryElement.layout"

Protected Attributes
ResourceName	m_EntryLayout = LAYOUT_ENTRY_DEFAULT
ref Widget	m_wEntry
string	m_sName

Member Function Documentation

CanBePerformedScript()

override bool ScriptedSelectionMenuEntry.CanBePerformedScript	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Can this entry be performed?

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_AIMessageSelectionMenuEntry, SCR_BaseGroup, SCR_EditorActionRadialEntry, SCR_EditorModeRadialEntry, and SCR_GroupWeaponEntry.

CanBeShownScript()

override bool ScriptedSelectionMenuEntry.CanBeShownScript	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Can this entry be shown?

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_AIMessageSelectionMenuEntry, SCR_EditorActionRadialEntry, and SCR_EditorModeRadialEntry.

GetEntryDescriptionScript()

override bool ScriptedSelectionMenuEntry.GetEntryDescriptionScript

(

out string

outDescription

)

If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.

If not overriden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_AIMessageSelectionMenuEntry, SCR_EditorActionRadialEntry, and SCR_EditorModeRadialEntry.

GetEntryIconPathScript()

override bool ScriptedSelectionMenuEntry.GetEntryIconPathScript

(

out string

outIconPath

)

If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.

If not overriden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_EditorActionRadialEntry, and SCR_EditorModeRadialEntry.

GetEntryLayout()

ResourceName ScriptedSelectionMenuEntry.GetEntryLayout

(

)

API for entry widget and component.

GetEntryNameScript()

override bool ScriptedSelectionMenuEntry.GetEntryNameScript

(

out string

outName

)

If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.

If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_AIMessageSelectionMenuEntry, SCR_BaseGroup, SCR_EditorActionRadialEntry, and SCR_EditorModeRadialEntry.

GetEntryWidget()

Widget ScriptedSelectionMenuEntry.GetEntryWidget

(

)

GetName()

string ScriptedSelectionMenuEntry.GetName

(

)

GetUIInfoScript()

override UIInfo ScriptedSelectionMenuEntry.GetUIInfoScript

(

)

Can be overridden to return desired UIInfo in GetUIInfo method.

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_BaseGroup, and SCR_GroupWeaponEntry.

OnPerform()

override void ScriptedSelectionMenuEntry.OnPerform	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Callback for when this entry is supposed to be performed.

Implements BaseScriptedSelectionMenuEntry.

Implemented in SCR_AIMessageSelectionMenuEntry, SCR_BaseGroup, SCR_EditorActionRadialEntry, SCR_EditorModeRadialEntry, and SCR_GroupWeaponEntry.

SetEntryLayout()

void ScriptedSelectionMenuEntry.SetEntryLayout

(

ResourceName

entryLayout

)

SetEntryWidget()

void ScriptedSelectionMenuEntry.SetEntryWidget

(

Widget

root

)

SetName()

void ScriptedSelectionMenuEntry.SetName

(

string

name

)

UpdateVisuals()

void ScriptedSelectionMenuEntry.UpdateVisuals

(

)

Base visuals update function for specific entry update.

Member Data Documentation

LAYOUT_ENTRY_DEFAULT

const string ScriptedSelectionMenuEntry.LAYOUT_ENTRY_DEFAULT = "{121C45A1F59DC1AF}UI/layouts/Common/RadialMenu/RadialEntryElement.layout"

static

m_EntryLayout

ResourceName ScriptedSelectionMenuEntry.m_EntryLayout = LAYOUT_ENTRY_DEFAULT

protected

m_sName

string ScriptedSelectionMenuEntry.m_sName

protected

m_wEntry

ref Widget ScriptedSelectionMenuEntry.m_wEntry

protected

---

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

• GameCode/UI/HUD/SelectionMenu/ScriptedSelectionMenuEntry.c