BaseScriptedSelectionMenuEntry Interface Reference

Inheritance diagram for BaseScriptedSelectionMenuEntry:

Public Member Functions
bool	CanBeShownScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be shown?
bool	CanBePerformedScript (IEntity user, BaseSelectionMenu sourceMenu)
	Can this entry be performed?
void	OnPerform (IEntity user, BaseSelectionMenu sourceMenu)
	Callback for when this entry is supposed to be performed.
bool	GetEntryNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseSelectionMenuEntry.GetEntryName is called.
bool	GetEntryDescriptionScript (out string outDescription)
	If overridden and true is returned, outDescription is returned when BaseSelectionMenuEntry.GetEntryDescription is called.
bool	GetEntryIconPathScript (out string outIconPath)
	If overridden and true is returned, outIconPath is returned when BaseSelectionMenuEntry.GetEntryIconPath is called.
UIInfo	GetUIInfoScript ()
	Can be overriden to return desired UIInfo in GetUIInfo method.
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.

Member Function Documentation

CanBePerformedScript()

bool BaseScriptedSelectionMenuEntry.CanBePerformedScript	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

Can this entry be performed?

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

CanBeShownScript()

bool BaseScriptedSelectionMenuEntry.CanBeShownScript	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

Can this entry be shown?

Implemented in SCR_EditorActionRadialEntry, SCR_EditorModeRadialEntry, SCR_AIMessageSelectionMenuEntry, and ScriptedSelectionMenuEntry.

GetEntryDescriptionScript()

bool BaseScriptedSelectionMenuEntry.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)

Implemented in SCR_EditorActionRadialEntry, SCR_EditorModeRadialEntry, SCR_AIMessageSelectionMenuEntry, and ScriptedSelectionMenuEntry.

GetEntryIconPathScript()

bool BaseScriptedSelectionMenuEntry.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)

Implemented in SCR_EditorActionRadialEntry, SCR_EditorModeRadialEntry, and ScriptedSelectionMenuEntry.

GetEntryNameScript()

bool BaseScriptedSelectionMenuEntry.GetEntryNameScript

(

out string

outName

)

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

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

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

GetUIInfoScript()

UIInfo BaseScriptedSelectionMenuEntry.GetUIInfoScript

(

)

Can be overriden to return desired UIInfo in GetUIInfo method.

Implemented in SCR_BaseGroup, SCR_GroupWeaponEntry, and ScriptedSelectionMenuEntry.

OnPerform()

void BaseScriptedSelectionMenuEntry.OnPerform	(	IEntity	user,
		BaseSelectionMenu	sourceMenu
	)

Callback for when this entry is supposed to be performed.

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

---

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

• Game/generated/UI/HUD/SelectionMenu/BaseScriptedSelectionMenuEntry.c