SCR_BaseSelectionMenu Interface Reference

Scripted base radial menu implementation. More...

Inheritance diagram for SCR_BaseSelectionMenu:

Public Member Functions
void	SCR_BaseSelectionMenu ()
void	~SCR_BaseSelectionMenu ()
Public Member Functions inherited from BaseSelectionMenu
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.

Protected Member Functions
override void	OnOpen (IEntity owner)
	Callback when open is requested.
override void	OnClose (IEntity owner)
	Callback when close is requested.
override void	OnUpdate (IEntity owner, float timeSlice)
	Callback when menu update is requested.

Protected Attributes
ref SCR_BaseSelectionMenuDisplay	m_pDisplay
	The display responsible for displaying the UI of this radial menu.

Detailed Description

Scripted base radial menu implementation.

Constructor & Destructor Documentation

SCR_BaseSelectionMenu()

void SCR_BaseSelectionMenu.SCR_BaseSelectionMenu

(

)

~SCR_BaseSelectionMenu()

void SCR_BaseSelectionMenu.~SCR_BaseSelectionMenu

(

)

Member Function Documentation

OnClose()

override void SCR_BaseSelectionMenu.OnClose ( IEntity owner )

protected

Callback when close is requested.

Implements ScriptedSelectionMenu.

OnOpen()

override void SCR_BaseSelectionMenu.OnOpen ( IEntity owner )

protected

Callback when open is requested.

Implements ScriptedSelectionMenu.

OnUpdate()

override void SCR_BaseSelectionMenu.OnUpdate ( IEntity owner, float timeSlice )

protected

Callback when menu update is requested.

Implements ScriptedSelectionMenu.

Member Data Documentation

m_pDisplay

ref SCR_BaseSelectionMenuDisplay SCR_BaseSelectionMenu.m_pDisplay

protected

The display responsible for displaying the UI of this radial menu.

---

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

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