SCR_RadialMenuController Interface Reference

Class created for quick application of radial menu into components It finds global menu, holds controller settings and data required for menu. More...

Public Member Functions
ScriptInvoker	GetOnInputOpen ()
ScriptInvoker	GetOnTakeControl ()
ScriptInvoker	GetOnControllerChanged ()
void	Control (IEntity owner, SCR_RadialMenu radialMenu=null)
	Take control over selected menu Filling no menu will take control over the global radial menu.
void	StopControl (bool closeMenu=false)
	Stop opening controls of current menu.
void	SetMenuDisplay ()
void	UpdateMenuData ()
void	OnInputOpen ()
void	SetEnableControl (bool enable)
bool	GetEnableControl ()
void	SetRadialMenuToControl (SCR_RadialMenu radialMenu)
SCR_RadialMenu	GetRadialMenu ()
SCR_SelectionMenuControllerInputs	GetControls ()
SCR_SelectionMenuData	GetData ()
bool	IsMenuOpen ()
void	CloseMenu ()
bool	HasControl ()
	Return true if cached menu is controlled by this owner entity.
void	SCR_RadialMenuController ()

Protected Member Functions
void	InvokeOnInputOpen (bool hasControl)
void	InvokeOnTakeControl ()
void	InvokeOnControllerChanged (bool hasControl)
void	OnMenuControllerChanged (SCR_SelectionMenu menu, SCR_SelectionMenuControllerInputs controller)

Protected Attributes
bool	m_sEnableControl
ref SCR_SelectionMenuControllerInputs	m_RMControls
ref SCR_SelectionMenuData	m_Data
ref SCR_RadialMenu	m_RadialMenuToControl
ref SCR_RadialMenu	m_RadialMenu
IEntity	m_Owner
ref ScriptInvoker< SCR_RadialMenuController, bool >	m_OnInputOpen
ref ScriptInvoker< SCR_RadialMenuController >	m_OnTakeControl
ref ScriptInvoker< SCR_RadialMenuController, bool >	m_OnControllerChanged

Detailed Description

Class created for quick application of radial menu into components It finds global menu, holds controller settings and data required for menu.

Constructor & Destructor Documentation

SCR_RadialMenuController()

void SCR_RadialMenuController.SCR_RadialMenuController

(

)

Member Function Documentation

CloseMenu()

void SCR_RadialMenuController.CloseMenu

(

)

Control()

void SCR_RadialMenuController.Control	(	IEntity	owner,
		SCR_RadialMenu	radialMenu = null )

Take control over selected menu Filling no menu will take control over the global radial menu.

GetControls()

SCR_SelectionMenuControllerInputs SCR_RadialMenuController.GetControls

(

)

GetData()

SCR_SelectionMenuData SCR_RadialMenuController.GetData

(

)

GetEnableControl()

bool SCR_RadialMenuController.GetEnableControl

(

)

GetOnControllerChanged()

ScriptInvoker SCR_RadialMenuController.GetOnControllerChanged

(

)

GetOnInputOpen()

ScriptInvoker SCR_RadialMenuController.GetOnInputOpen

(

)

GetOnTakeControl()

ScriptInvoker SCR_RadialMenuController.GetOnTakeControl

(

)

GetRadialMenu()

SCR_RadialMenu SCR_RadialMenuController.GetRadialMenu

(

)

HasControl()

bool SCR_RadialMenuController.HasControl

(

)

Return true if cached menu is controlled by this owner entity.

InvokeOnControllerChanged()

void SCR_RadialMenuController.InvokeOnControllerChanged ( bool hasControl )

protected

InvokeOnInputOpen()

void SCR_RadialMenuController.InvokeOnInputOpen ( bool hasControl )

protected

InvokeOnTakeControl()

void SCR_RadialMenuController.InvokeOnTakeControl ( )

protected

IsMenuOpen()

bool SCR_RadialMenuController.IsMenuOpen

(

)

OnInputOpen()

void SCR_RadialMenuController.OnInputOpen

(

)

OnMenuControllerChanged()

void SCR_RadialMenuController.OnMenuControllerChanged ( SCR_SelectionMenu menu, SCR_SelectionMenuControllerInputs controller )

protected

SetEnableControl()

void SCR_RadialMenuController.SetEnableControl

(

bool

enable

)

SetMenuDisplay()

void SCR_RadialMenuController.SetMenuDisplay

(

)

SetRadialMenuToControl()

void SCR_RadialMenuController.SetRadialMenuToControl

(

SCR_RadialMenu

radialMenu

)

StopControl()

void SCR_RadialMenuController.StopControl

(

bool

closeMenu = false

)

Stop opening controls of current menu.

UpdateMenuData()

void SCR_RadialMenuController.UpdateMenuData

(

)

Member Data Documentation

m_Data

ref SCR_SelectionMenuData SCR_RadialMenuController.m_Data

protected

m_OnControllerChanged

ref ScriptInvoker<SCR_RadialMenuController, bool> SCR_RadialMenuController.m_OnControllerChanged

protected

m_OnInputOpen

ref ScriptInvoker<SCR_RadialMenuController, bool> SCR_RadialMenuController.m_OnInputOpen

protected

m_OnTakeControl

ref ScriptInvoker<SCR_RadialMenuController> SCR_RadialMenuController.m_OnTakeControl

protected

m_Owner

IEntity SCR_RadialMenuController.m_Owner

protected

m_RadialMenu

ref SCR_RadialMenu SCR_RadialMenuController.m_RadialMenu

protected

m_RadialMenuToControl

ref SCR_RadialMenu SCR_RadialMenuController.m_RadialMenuToControl

protected

m_RMControls

ref SCR_SelectionMenuControllerInputs SCR_RadialMenuController.m_RMControls

protected

m_sEnableControl

bool SCR_RadialMenuController.m_sEnableControl

protected

---

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

• Game/UI/HUD/SelectionMenu/RadialMenu/SCR_RadialMenuController.c