SCR_MapToolMenuUI Interface Reference

Map tool menu. More...

Inheritance diagram for SCR_MapToolMenuUI:

Public Member Functions
string	GetDefaultButtonName ()
	Returns default button name. Bear in mind that actual buttons have added index number to its end in PopulateToolMenu()
array< ref SCR_MapToolEntry >	GetMenuEntries ()
SCR_MapToolEntry	RegisterToolMenuEntry (ResourceName imageset, string icon, int sortPriority, bool isExclusive=false)
	Register menu entry.
void	RegisterEntryCustom (SCR_MapToolEntry customEntry)
	Add custom inherited entry.
void	DisableInactiveMapUIEntries (notnull SCR_MapToolEntry activeEntry)
	Disables all other exclusive map ui entries if activeEntry is also exclusive.
void	SetToolMenuFocused (bool state)
	Set focused state.
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
bool	IsFocused ()
Widget	GetBackgroundWidget ()
void	SCR_MapToolMenuUI ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
bool	IsExclusive ()
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 Attributes
static ResourceName	s_sToolMenuIcons

Protected Member Functions
void	PopulateToolMenu ()
	Build entries.
void	OnFocusToolMenu (float value, EActionTrigger reason)
	Focus menu event when using controller.
void	OnFreeCursor (float value, EActionTrigger reason)
void	OnMapPan (float x, float y, bool adjusted)
void	SetUIVisible (bool state)
	Set tool menu visibility.

Protected Attributes
ResourceName	m_sToolMenuIcons
ResourceName	m_sButtonResource
string	m_sToolMenuRootName
string	m_sToolBarName
string	m_sButtonDefaultName
string	m_sBackgroundName
bool	m_bIsVisible
bool	m_bIsMenuFocused
Widget	m_wBackground
Widget	m_wToolMenuRoot
Widget	m_wToolMenuBar
SCR_MapCursorModule	m_CursorModule
ref array< ref SCR_MapToolEntry >	m_aMenuEntries = {}
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Detailed Description

Map tool menu.

Constructor & Destructor Documentation

SCR_MapToolMenuUI()

void SCR_MapToolMenuUI.SCR_MapToolMenuUI

(

)

Member Function Documentation

DisableInactiveMapUIEntries()

void SCR_MapToolMenuUI.DisableInactiveMapUIEntries

(

notnull SCR_MapToolEntry

activeEntry

)

Disables all other exclusive map ui entries if activeEntry is also exclusive.

Parameters

[in]

activeEntry

GetBackgroundWidget()

Widget SCR_MapToolMenuUI.GetBackgroundWidget

(

)

Returns

menu background

GetDefaultButtonName()

string SCR_MapToolMenuUI.GetDefaultButtonName

(

)

Returns default button name. Bear in mind that actual buttons have added index number to its end in PopulateToolMenu()

GetMenuEntries()

array< ref SCR_MapToolEntry > SCR_MapToolMenuUI.GetMenuEntries

(

)

Returns

IsFocused()

bool SCR_MapToolMenuUI.IsFocused

(

)

OnFocusToolMenu()

void SCR_MapToolMenuUI.OnFocusToolMenu ( float value, EActionTrigger reason )

protected

Focus menu event when using controller.

OnFreeCursor()

void SCR_MapToolMenuUI.OnFreeCursor ( float value, EActionTrigger reason )

protected

OnMapClose()

override void SCR_MapToolMenuUI.OnMapClose

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapOpen()

override void SCR_MapToolMenuUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnMapPan()

void SCR_MapToolMenuUI.OnMapPan ( float x, float y, bool adjusted )

protected

OnMouseEnter()

override bool SCR_MapToolMenuUI.OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

OnMouseLeave()

override bool SCR_MapToolMenuUI.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

PopulateToolMenu()

void SCR_MapToolMenuUI.PopulateToolMenu ( )

protected

Build entries.

RegisterEntryCustom()

void SCR_MapToolMenuUI.RegisterEntryCustom

(

SCR_MapToolEntry

customEntry

)

Add custom inherited entry.

Parameters

[in]

customEntry

is the subject

RegisterToolMenuEntry()

SCR_MapToolEntry SCR_MapToolMenuUI.RegisterToolMenuEntry	(	ResourceName	imageset,
		string	icon,
		int	sortPriority,
		bool	isExclusive = false )

Register menu entry.

Parameters

[in]	imageset	is source imageset
[in]	icon	is quad from the provided imageset
[in]	sortPriority	is disply priority of the icon within the menu, lower value means higher priority
[in]	isExclusive

SetToolMenuFocused()

void SCR_MapToolMenuUI.SetToolMenuFocused

(

bool

state

)

Set focused state.

Parameters

[in]

state

SetUIVisible()

void SCR_MapToolMenuUI.SetUIVisible ( bool state )

protected

Set tool menu visibility.

Parameters

[in]

state

is target visibility

Member Data Documentation

m_aMenuEntries

ref array<ref SCR_MapToolEntry> SCR_MapToolMenuUI.m_aMenuEntries = {}

protected

m_bIsMenuFocused

bool SCR_MapToolMenuUI.m_bIsMenuFocused

protected

m_bIsVisible

bool SCR_MapToolMenuUI.m_bIsVisible

protected

m_CursorModule

SCR_MapCursorModule SCR_MapToolMenuUI.m_CursorModule

protected

m_sBackgroundName

string SCR_MapToolMenuUI.m_sBackgroundName

protected

m_sButtonDefaultName

string SCR_MapToolMenuUI.m_sButtonDefaultName

protected

m_sButtonResource

ResourceName SCR_MapToolMenuUI.m_sButtonResource

protected

m_sToolBarName

string SCR_MapToolMenuUI.m_sToolBarName

protected

m_sToolMenuIcons

ResourceName SCR_MapToolMenuUI.m_sToolMenuIcons

protected

m_sToolMenuRootName

string SCR_MapToolMenuUI.m_sToolMenuRootName

protected

m_wBackground

Widget SCR_MapToolMenuUI.m_wBackground

protected

m_wToolMenuBar

Widget SCR_MapToolMenuUI.m_wToolMenuBar

protected

m_wToolMenuRoot

Widget SCR_MapToolMenuUI.m_wToolMenuRoot

protected

s_sToolMenuIcons

ResourceName SCR_MapToolMenuUI.s_sToolMenuIcons

static

---

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

• Game/Map/ComponentsUI/SCR_MapToolMenuUI.c