BaseSelectionMenu Interface Reference

Inheritance diagram for BaseSelectionMenu:

Public Member Functions
proto external void	Update (IEntity owner, float timeSlice)
	Request an update to this radial menu, ideally called during EOnFrame.
proto external void	Open (IEntity owner)
	Request to open this radial menu.
proto external void	Close (IEntity owner)
	Request to close this radial menu.
proto external bool	IsOpen ()
	Is this radial menu currently open?
proto external void	ClearEntries ()
	Clear the list of entries stored in this menu.
proto external void	AddEntry (BaseSelectionMenuEntry entry)
	Add provided entry to the list of entries (if not contained already)
proto external void	RemoveEntry (BaseSelectionMenuEntry entry)
	Remove provided entry from the list of entries.
proto external bool	ContainsEntry (BaseSelectionMenuEntry entry)
	Returns true if this menu already contains provided entry.
proto external int	GetEntriesCount ()
	Returns the number of entries stored in this menu.
proto external int	GetEntryList (out notnull array< BaseSelectionMenuEntry > outActions)
	Fills the provided array with weak references to entries from this menu Returns the number of output elements.

Member Function Documentation

AddEntry()

proto external void BaseSelectionMenu.AddEntry

(

BaseSelectionMenuEntry

entry

)

Add provided entry to the list of entries (if not contained already)

ClearEntries()

proto external void BaseSelectionMenu.ClearEntries

(

)

Clear the list of entries stored in this menu.

Close()

proto external void BaseSelectionMenu.Close

(

IEntity

owner

)

Request to close this radial menu.

ContainsEntry()

proto external bool BaseSelectionMenu.ContainsEntry

(

BaseSelectionMenuEntry

entry

)

Returns true if this menu already contains provided entry.

GetEntriesCount()

proto external int BaseSelectionMenu.GetEntriesCount

(

)

Returns the number of entries stored in this menu.

GetEntryList()

proto external int BaseSelectionMenu.GetEntryList

(

out notnull array< BaseSelectionMenuEntry >

outActions

)

Fills the provided array with weak references to entries from this menu Returns the number of output elements.

IsOpen()

proto external bool BaseSelectionMenu.IsOpen

(

)

Is this radial menu currently open?

Open()

proto external void BaseSelectionMenu.Open

(

IEntity

owner

)

Request to open this radial menu.

RemoveEntry()

proto external void BaseSelectionMenu.RemoveEntry

(

BaseSelectionMenuEntry

entry

)

Remove provided entry from the list of entries.

Update()

proto external void BaseSelectionMenu.Update	(	IEntity	owner,
		float	timeSlice
	)

Request an update to this radial menu, ideally called during EOnFrame.

---

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

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