BaseSelectionMenuEntry Interface Reference

Inheritance diagram for BaseSelectionMenuEntry:

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

CanBePerformed()

proto external bool BaseSelectionMenuEntry.CanBePerformed	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Can this entry be performed?

CanBeShown()

proto external bool BaseSelectionMenuEntry.CanBeShown	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Can this entry be shown?

GetEntryDescription()

proto external string BaseSelectionMenuEntry.GetEntryDescription

(

)

Return the description of this entry.

By default returns the value in UIInfo or empty string if UIInfo doesn't exist

GetEntryIconPath()

proto external string BaseSelectionMenuEntry.GetEntryIconPath

(

)

Return the icon path of this entry.

By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetEntryName()

proto external string BaseSelectionMenuEntry.GetEntryName

(

)

Return the name of this entry.

By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetUIInfo()

proto external UIInfo BaseSelectionMenuEntry.GetUIInfo

(

)

Get related UI info or null if none.

Perform()

proto external void BaseSelectionMenuEntry.Perform	(	IEntity	user,
		BaseSelectionMenu	sourceMenu )

Request to perform this entry.

---

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

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