SCR_MapRadialUI Interface Reference

2D map radial menu UI More...

Inheritance diagram for SCR_MapRadialUI:

Public Member Functions
ScriptInvokerVoid	GetOnMenuInitInvoker ()
ScriptInvokerMenuEntrySelected	GetOnEntrySelectedInvoker ()
ScriptInvokerMenuEntryPerformed	GetOnEntryPerformedInvoker ()
SCR_RadialMenuController	GetRadialController ()
SCR_MapRadialDisplay	GetRadialDisplay ()
vector	GetMenuWorldPosition ()
bool	OpenMenu ()
	SCR_RadialMenu event.
void	CloseMenu ()
	SCR_RadialMenu event.
void	OnEntrySelected (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry, int entryID)
	SCR_RadialMenu event.
void	OnEntryPerformed (SCR_SelectionMenu menu, SCR_SelectionMenuEntry entry)
	SCR_RadialMenu event.
void	InsertCustomRadialEntry (SCR_SelectionMenuEntry entry, SCR_SelectionMenuCategoryEntry category=null)
	Insert own entry into the menu.
void	InsertCustomRadialCategory (SCR_SelectionMenuCategoryEntry entry, SCR_SelectionMenuCategoryEntry parent=null)
	Insert own category into the menu.
SCR_SelectionMenuEntry	AddRadialEntry (string name, SCR_SelectionMenuCategoryEntry category=null)
	Add simple entry.
SCR_SelectionMenuCategoryEntry	AddRadialCategory (string name, SCR_SelectionMenuCategoryEntry parent=null)
	Add simple category.
void	RemoveRadialEntry (SCR_SelectionMenuEntry entry)
	Remove entry.
override void	Update (float timeSlice)
	Update method for frame operations.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
void	SCR_MapRadialUI ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
void	Update (float timeSlice)
	Update method for frame operations.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Static Public Member Functions
static SCR_MapRadialUI	GetInstance ()

Protected Member Functions
void	OnInputMenuOpen (float value, EActionTrigger reason)
	Listener callback.
void	InputOpenMenu (SCR_RadialMenuController controller, bool hasControl)
	SCR_RadialMenuController event.
void	OnControllerTakeControl (SCR_RadialMenuController controller)
	SCR_RadialMenuController event.
void	OnControllerChanged (SCR_RadialMenuController controller)
	SCR_RadialMenuController event.
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
ref SCR_RadialMenuController	m_RadialController
ref SCR_RadialMenu	m_RadialMenu
SCR_MapCursorModule	m_CursorModule
SCR_MapRadialDisplay	m_Display
bool	m_bRefresh
bool	m_bEntriesUpdate = false
vector	m_vMenuWorldPos
ref ScriptInvokerVoid	m_OnMenuInit = new ScriptInvokerVoid()
ref ScriptInvokerMenuEntrySelected	m_OnEntrySelected = new ScriptInvokerMenuEntrySelected()
ref ScriptInvokerMenuEntryPerformed	m_OnEntryPerformed = new ScriptInvokerMenuEntryPerformed()
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

2D map radial menu UI

Constructor & Destructor Documentation

SCR_MapRadialUI()

void SCR_MapRadialUI.SCR_MapRadialUI

(

)

Member Function Documentation

AddRadialCategory()

SCR_SelectionMenuCategoryEntry SCR_MapRadialUI.AddRadialCategory	(	string	name,
		SCR_SelectionMenuCategoryEntry	parent = null
	)

Add simple category.

Parameters

[in]	name
[in]	parent

Returns

AddRadialEntry()

SCR_SelectionMenuEntry SCR_MapRadialUI.AddRadialEntry	(	string	name,
		SCR_SelectionMenuCategoryEntry	category = null
	)

Add simple entry.

Parameters

[in]	name
[in]	category

Returns

CloseMenu()

void SCR_MapRadialUI.CloseMenu

(

)

SCR_RadialMenu event.

GetInstance()

static SCR_MapRadialUI SCR_MapRadialUI.GetInstance ( )

static

Returns

GetMenuWorldPosition()

vector SCR_MapRadialUI.GetMenuWorldPosition

(

)

Returns

GetOnEntryPerformedInvoker()

ScriptInvokerMenuEntryPerformed SCR_MapRadialUI.GetOnEntryPerformedInvoker

(

)

Returns

GetOnEntrySelectedInvoker()

ScriptInvokerMenuEntrySelected SCR_MapRadialUI.GetOnEntrySelectedInvoker

(

)

Returns

GetOnMenuInitInvoker()

ScriptInvokerVoid SCR_MapRadialUI.GetOnMenuInitInvoker

(

)

Returns

GetRadialController()

SCR_RadialMenuController SCR_MapRadialUI.GetRadialController

(

)

Returns

GetRadialDisplay()

SCR_MapRadialDisplay SCR_MapRadialUI.GetRadialDisplay

(

)

Returns

InputOpenMenu()

void SCR_MapRadialUI.InputOpenMenu ( SCR_RadialMenuController  controller, bool  hasControl  )

protected

SCR_RadialMenuController event.

Parameters

[in]	controller
[in]	hasControl

InsertCustomRadialCategory()

void SCR_MapRadialUI.InsertCustomRadialCategory	(	SCR_SelectionMenuCategoryEntry	entry,
		SCR_SelectionMenuCategoryEntry	parent = null
	)

Insert own category into the menu.

Parameters

[in]	entry
[in]	parent

InsertCustomRadialEntry()

void SCR_MapRadialUI.InsertCustomRadialEntry	(	SCR_SelectionMenuEntry	entry,
		SCR_SelectionMenuCategoryEntry	category = null
	)

Insert own entry into the menu.

Parameters

[in]	entry
[in]	category

OnControllerChanged()

void SCR_MapRadialUI.OnControllerChanged ( SCR_RadialMenuController  controller )

protected

SCR_RadialMenuController event.

Parameters

[in]

controller

OnControllerTakeControl()

void SCR_MapRadialUI.OnControllerTakeControl ( SCR_RadialMenuController  controller )

protected

SCR_RadialMenuController event.

Parameters

[in]

controller

OnEntryPerformed()

void SCR_MapRadialUI.OnEntryPerformed	(	SCR_SelectionMenu	menu,
		SCR_SelectionMenuEntry	entry
	)

SCR_RadialMenu event.

Parameters

[in]	menu
[in]	entry

OnEntrySelected()

void SCR_MapRadialUI.OnEntrySelected	(	SCR_SelectionMenu	menu,
		SCR_SelectionMenuEntry	entry,
		int	entryID
	)

SCR_RadialMenu event.

Parameters

[in]	menu
[in]	entry
[in]	entryID

OnInputMenuOpen()

void SCR_MapRadialUI.OnInputMenuOpen ( float  value, EActionTrigger  reason  )

protected

Listener callback.

Parameters

[in]	value
[in]	reason

OnMapClose()

override void SCR_MapRadialUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapRadialUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OpenMenu()

bool SCR_MapRadialUI.OpenMenu

(

)

SCR_RadialMenu event.

Returns

false if cannot open due to not having any entries

RemoveRadialEntry()

void SCR_MapRadialUI.RemoveRadialEntry

(

SCR_SelectionMenuEntry

entry

)

Remove entry.

Parameters

[in]

entry

Update()

override void SCR_MapRadialUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

Member Data Documentation

m_bEntriesUpdate

bool SCR_MapRadialUI.m_bEntriesUpdate = false

protected

m_bRefresh

bool SCR_MapRadialUI.m_bRefresh

protected

m_CursorModule

SCR_MapCursorModule SCR_MapRadialUI.m_CursorModule

protected

m_Display

SCR_MapRadialDisplay SCR_MapRadialUI.m_Display

protected

m_OnEntryPerformed

ref ScriptInvokerMenuEntryPerformed SCR_MapRadialUI.m_OnEntryPerformed = new ScriptInvokerMenuEntryPerformed()

protected

m_OnEntrySelected

ref ScriptInvokerMenuEntrySelected SCR_MapRadialUI.m_OnEntrySelected = new ScriptInvokerMenuEntrySelected()

protected

m_OnMenuInit

ref ScriptInvokerVoid SCR_MapRadialUI.m_OnMenuInit = new ScriptInvokerVoid()

protected

m_RadialController

ref SCR_RadialMenuController SCR_MapRadialUI.m_RadialController

protected

m_RadialMenu

ref SCR_RadialMenu SCR_MapRadialUI.m_RadialMenu

protected

m_vMenuWorldPos

vector SCR_MapRadialUI.m_vMenuWorldPos

protected

---

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

• Game/Map/ComponentsUI/SCR_MapRadialUI.c