SCR_MapToolMenuUI.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_MapToolEntry
	Map tool menu entry data class. More...

Functions
SCR_MapToolEntry Managed	Attribute ("{2EFEA2AF1F38E7F0}UI/Textures/Icons/icons_wrapperUI-64.imageset", UIWidgets.ResourceNamePicker, "Menu icons imageset", "imageset")] ResourceName m_sToolMenuIcons
	Map tool menu. More...
void	SetActive (bool toolActive)
	Activation behavior, ON/OFF if entry is active (visual distinction) More...
bool	IsEntryActive ()
void	SetEnabled (bool isEnabled)
	Disabled behavior, ON/OFF determines whether can be activated (clicked) More...
bool	IsEntryEnabled ()
	Whether entry can be activated. More...
void	SetVisible (bool state)
	Visibility, determines whether the entry is visible with the menu. More...
void	SetButtonSoundsDisabled (bool state)
	Enable button sounds. More...
void	UpdateVisual ()
	Update visual based on current state. More...
protected void	SetColor (Color color)
protected void	SetBorderColor (Color color)
string	GetImageSet ()
protected void	OnClick ()
	On click callback. More...
void	SCR_MapToolEntry (SCR_MapToolMenuUI menu, ResourceName imageset, string icon, int sortPriority=0)
string	GetDefaultButtonName ()
	Returns default button name. Bear in mind that actual buttons have added index number to its end in PopulateToolMenu() More...
array< ref SCR_MapToolEntry >	GetMenuEntries ()
SCR_MapToolEntry	RegisterToolMenuEntry (ResourceName imageset, string icon, int sortPriority)
void	RegisterEntryCustom (SCR_MapToolEntry customEntry)
protected void	PopulateToolMenu ()
	Build entries. More...
protected void	OnFocusToolMenu (float value, EActionTrigger reason)
	Focus menu event when using controller. More...
protected void	OnFreeCursor (float value, EActionTrigger reason)
protected void	OnMapPan (float x, float y, bool adjusted)
protected void	SetUIVisible (bool state)
void	SetToolMenuFocused (bool state)
override event bool	OnMouseEnter (Widget w, int x, int y)
override event bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override void	OnMapOpen (MapConfiguration config)
override void	OnMapClose (MapConfiguration config)
void	SCR_MapToolMenuUI ()

Variables
protected bool	m_bToolActive
protected bool	m_bIsEnabled = true
protected bool	m_bIsVisible = true
bool	m_bButtonSoundsDisabled
int	m_iSortPriority
ResourceName	m_sImageSet
string	m_sIconQuad
SCR_ToolMenuButtonComponent	m_ButtonComp
SCR_MapToolMenuUI	m_OwnerMenu
ref ScriptInvoker	m_OnClick = new ScriptInvoker()
ResourceName	m_sButtonResource
string	m_sToolMenuRootName
string	m_sToolBarName
string	m_sButtonDefaultName
protected bool	m_bIsMenuFocused
protected Widget	m_wToolMenuRoot
protected Widget	m_wToolMenuBar
SCR_MapCursorModule	m_CursorModule
protected ref array< ref SCR_MapToolEntry >	m_aMenuEntries = {}

Function Documentation

Attribute()

SCR_MapToolEntry Managed Attribute	(	"{2EFEA2AF1F38E7F0}UI/Textures/Icons/icons_wrapperUI-64.imageset"	,
		UIWidgets.	ResourceNamePicker,
		"Menu icons imageset"	,
		"imageset"
	)

Map tool menu.

GetDefaultButtonName()

string GetDefaultButtonName

(

)

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

Definition at line 182 of file SCR_MapToolMenuUI.c.

GetImageSet()

string Attribute::GetImageSet

(

)

Returns

Definition at line 106 of file SCR_MapToolMenuUI.c.

GetMenuEntries()

array<ref SCR_MapToolEntry> GetMenuEntries

(

)

Returns

Definition at line 189 of file SCR_MapToolMenuUI.c.

IsEntryActive()

bool Attribute::IsEntryActive

(

)

Returns

Definition at line 33 of file SCR_MapToolMenuUI.c.

IsEntryEnabled()

bool Attribute::IsEntryEnabled

(

)

Whether entry can be activated.

Definition at line 48 of file SCR_MapToolMenuUI.c.

OnClick()

protected void Attribute::OnClick

(

)

On click callback.

Definition at line 113 of file SCR_MapToolMenuUI.c.

OnFocusToolMenu()

protected void OnFocusToolMenu	(	float	value,
		EActionTrigger	reason
	)

Focus menu event when using controller.

Definition at line 264 of file SCR_MapToolMenuUI.c.

OnFreeCursor()

protected void OnFreeCursor	(	float	value,
		EActionTrigger	reason
	)

Definition at line 270 of file SCR_MapToolMenuUI.c.

OnMapClose()

override void OnMapClose

(

MapConfiguration

config

)

Definition at line 371 of file SCR_MapToolMenuUI.c.

OnMapOpen()

override void OnMapOpen

(

MapConfiguration

config

)

Definition at line 345 of file SCR_MapToolMenuUI.c.

OnMapPan()

protected void OnMapPan	(	float	x,
		float	y,
		bool	adjusted
	)

Definition at line 276 of file SCR_MapToolMenuUI.c.

OnMouseEnter()

override event bool OnMouseEnter	(	Widget	w,
		int	x,
		int	y
	)

Definition at line 317 of file SCR_MapToolMenuUI.c.

OnMouseLeave()

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

Definition at line 331 of file SCR_MapToolMenuUI.c.

PopulateToolMenu()

protected void PopulateToolMenu

(

)

Build entries.

Definition at line 217 of file SCR_MapToolMenuUI.c.

RegisterEntryCustom()

void RegisterEntryCustom

(

SCR_MapToolEntry

customEntry

)

Add custom inherited entry

Parameters

[in]

customEntry

is the subject

Definition at line 210 of file SCR_MapToolMenuUI.c.

RegisterToolMenuEntry()

SCR_MapToolEntry RegisterToolMenuEntry	(	ResourceName	imageset,
		string	icon,
		int	sortPriority
	)

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

Definition at line 199 of file SCR_MapToolMenuUI.c.

SCR_MapToolEntry()

void Attribute::SCR_MapToolEntry	(	SCR_MapToolMenuUI	menu,
		ResourceName	imageset,
		string	icon,
		int	sortPriority = 0
	)

Parameters

[in]	menu
[in]	imageset
[in]	icon
[in]	sortPriority

Definition at line 135 of file SCR_MapToolMenuUI.c.

SCR_MapToolMenuUI()

void SCR_MapToolMenuUI

(

)

Definition at line 389 of file SCR_MapToolMenuUI.c.

SetActive()

void Attribute::SetActive

(

bool

toolActive

)

Activation behavior, ON/OFF if entry is active (visual distinction)

Definition at line 25 of file SCR_MapToolMenuUI.c.

SetBorderColor()

protected void Attribute::SetBorderColor

(

Color

color

)

Set border color

Parameters

[in]

color

is target color

Definition at line 99 of file SCR_MapToolMenuUI.c.

SetButtonSoundsDisabled()

void Attribute::SetButtonSoundsDisabled

(

bool

state

)

Enable button sounds.

Definition at line 63 of file SCR_MapToolMenuUI.c.

SetColor()

protected void Attribute::SetColor

(

Color

color

)

Set entry image color

Parameters

[in]

color

is target color

Definition at line 91 of file SCR_MapToolMenuUI.c.

SetEnabled()

void Attribute::SetEnabled

(

bool

isEnabled

)

Disabled behavior, ON/OFF determines whether can be activated (clicked)

Definition at line 40 of file SCR_MapToolMenuUI.c.

SetToolMenuFocused()

void SetToolMenuFocused

(

bool

state

)

Set focused state

Parameters

[in]

state

Definition at line 293 of file SCR_MapToolMenuUI.c.

SetUIVisible()

protected void SetUIVisible

(

bool

state

)

Set tool menu visibility

Parameters

[in]

state

is target visibility

Definition at line 284 of file SCR_MapToolMenuUI.c.

SetVisible()

void Attribute::SetVisible

(

bool

state

)

Visibility, determines whether the entry is visible with the menu.

Definition at line 55 of file SCR_MapToolMenuUI.c.

UpdateVisual()

void Attribute::UpdateVisual

(

)

Update visual based on current state.

Definition at line 70 of file SCR_MapToolMenuUI.c.

Variable Documentation

m_aMenuEntries

protected ref array<ref SCR_MapToolEntry> m_aMenuEntries = {}

Definition at line 178 of file SCR_MapToolMenuUI.c.

m_bButtonSoundsDisabled

bool m_bButtonSoundsDisabled

Definition at line 6 of file SCR_MapToolMenuUI.c.

m_bIsEnabled

protected bool m_bIsEnabled = true

Definition at line 3 of file SCR_MapToolMenuUI.c.

m_bIsMenuFocused

protected bool m_bIsMenuFocused

Definition at line 173 of file SCR_MapToolMenuUI.c.

m_bIsVisible

protected bool m_bIsVisible = true

Definition at line 4 of file SCR_MapToolMenuUI.c.

m_bToolActive

protected bool m_bToolActive

Definition at line 2 of file SCR_MapToolMenuUI.c.

m_ButtonComp

SCR_ToolMenuButtonComponent m_ButtonComp

Definition at line 10 of file SCR_MapToolMenuUI.c.

m_CursorModule

SCR_MapCursorModule m_CursorModule

Definition at line 176 of file SCR_MapToolMenuUI.c.

m_iSortPriority

int m_iSortPriority

Definition at line 7 of file SCR_MapToolMenuUI.c.

m_OnClick

ref ScriptInvoker m_OnClick = new ScriptInvoker()

Definition at line 13 of file SCR_MapToolMenuUI.c.

m_OwnerMenu

SCR_MapToolMenuUI m_OwnerMenu

Definition at line 11 of file SCR_MapToolMenuUI.c.

m_sButtonDefaultName

string m_sButtonDefaultName

Definition at line 168 of file SCR_MapToolMenuUI.c.

m_sButtonResource

ResourceName m_sButtonResource

Definition at line 159 of file SCR_MapToolMenuUI.c.

m_sIconQuad

string m_sIconQuad

Definition at line 9 of file SCR_MapToolMenuUI.c.

m_sImageSet

ResourceName m_sImageSet

Definition at line 8 of file SCR_MapToolMenuUI.c.

m_sToolBarName

string m_sToolBarName

Definition at line 165 of file SCR_MapToolMenuUI.c.

m_sToolMenuRootName

string m_sToolMenuRootName

Definition at line 162 of file SCR_MapToolMenuUI.c.

m_wToolMenuBar

protected Widget m_wToolMenuBar

Definition at line 175 of file SCR_MapToolMenuUI.c.

m_wToolMenuRoot

protected Widget m_wToolMenuRoot

Definition at line 174 of file SCR_MapToolMenuUI.c.