SCR_MapToolMenuUI.c File Reference

Go to the source code of this file.

Classes
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")] protected ResourceName m_sToolMenuIcons
	Map tool menu.
ScriptInvokerVoid	GetOnDisableMapUIInvoker ()
void	OnDisableMapUIComponent ()
void	SetActive (bool toolActive)
	Activation behavior, ON/OFF if entry is active (visual distinction).
bool	IsEntryActive ()
void	SetEnabled (bool isEnabled)
	Disabled behavior, ON/OFF determines whether can be activated (clicked).
bool	IsEntryEnabled ()
	Whether entry can be activated.
void	SetVisible (bool state)
	Visibility, determines whether the entry is visible with the menu.
void	SetButtonSoundsDisabled (bool state)
	Enable button sounds.
void	UpdateVisual ()
	Update visual based on current state.
void	SetColor (notnull Color color)
void	SetBorderColor (notnull Color color)
void	SetBackgroundColor (notnull Color color)
string	GetImageSet ()
void	OnClick ()
	On click callback.
bool	IsExclusiveEntry ()
void	SCR_MapToolEntry (SCR_MapToolMenuUI menu, ResourceName imageset, string icon, int sortPriority=0, bool isExclusive=0)
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)
void	RegisterEntryCustom (SCR_MapToolEntry customEntry)
void	DisableInactiveMapUIEntries (notnull SCR_MapToolEntry activeEntry)
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)
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)
bool	IsFocused ()
Widget	GetBackgroundWidget ()
void	SCR_MapToolMenuUI ()

Variables
bool	m_bToolActive
bool	m_bIsEnabled = true
bool	m_bIsVisible = true
bool	m_bIsExclusiveEntry = false
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()
ref ScriptInvokerVoid	m_OnDisableMapUIComponent
ResourceName	m_sButtonResource
string	m_sToolMenuRootName
string	m_sToolBarName
string	m_sButtonDefaultName
string	m_sBackgroundName
bool	m_bIsMenuFocused
Widget	m_wBackground
Widget	m_wToolMenuRoot
Widget	m_wToolMenuBar
SCR_MapCursorModule	m_CursorModule
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.

DisableInactiveMapUIEntries()

void DisableInactiveMapUIEntries ( notnull SCR_MapToolEntry activeEntry )

protected

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

Parameters

[in]

activeEntry

Definition at line 275 of file SCR_MapToolMenuUI.c.

GetBackgroundWidget()

Widget GetBackgroundWidget ( )

protected

Returns

menu background

Definition at line 471 of file SCR_MapToolMenuUI.c.

GetDefaultButtonName()

string GetDefaultButtonName ( )

protected

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

Definition at line 227 of file SCR_MapToolMenuUI.c.

GetImageSet()

string Attribute::GetImageSet ( )

protected

Returns

Definition at line 136 of file SCR_MapToolMenuUI.c.

GetMenuEntries()

array< ref SCR_MapToolEntry > GetMenuEntries ( )

protected

Returns

Definition at line 234 of file SCR_MapToolMenuUI.c.

GetOnDisableMapUIInvoker()

ScriptInvokerVoid Attribute::GetOnDisableMapUIInvoker ( )

protected

Definition at line 24 of file SCR_MapToolMenuUI.c.

IsEntryActive()

bool Attribute::IsEntryActive ( )

protected

Returns

Definition at line 49 of file SCR_MapToolMenuUI.c.

IsEntryEnabled()

bool Attribute::IsEntryEnabled ( )

protected

Whether entry can be activated.

Definition at line 64 of file SCR_MapToolMenuUI.c.

IsExclusiveEntry()

bool Attribute::IsExclusiveEntry ( )

protected

Definition at line 161 of file SCR_MapToolMenuUI.c.

IsFocused()

bool IsFocused ( )

protected

Definition at line 464 of file SCR_MapToolMenuUI.c.

OnClick()

void Attribute::OnClick ( )

protected

On click callback.

Definition at line 143 of file SCR_MapToolMenuUI.c.

OnDisableMapUIComponent()

void Attribute::OnDisableMapUIComponent ( )

protected

Definition at line 33 of file SCR_MapToolMenuUI.c.

OnFocusToolMenu()

void OnFocusToolMenu ( float value, EActionTrigger reason )

protected

Focus menu event when using controller.

Definition at line 337 of file SCR_MapToolMenuUI.c.

OnFreeCursor()

void OnFreeCursor ( float value, EActionTrigger reason )

protected

Definition at line 343 of file SCR_MapToolMenuUI.c.

OnMapClose()

override void OnMapClose ( MapConfiguration config )

protected

Definition at line 447 of file SCR_MapToolMenuUI.c.

OnMapOpen()

override void OnMapOpen ( MapConfiguration config )

protected

Definition at line 419 of file SCR_MapToolMenuUI.c.

OnMapPan()

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

protected

Definition at line 349 of file SCR_MapToolMenuUI.c.

OnMouseEnter()

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

protected

Definition at line 390 of file SCR_MapToolMenuUI.c.

OnMouseLeave()

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

protected

Definition at line 401 of file SCR_MapToolMenuUI.c.

PopulateToolMenu()

void PopulateToolMenu ( )

protected

Build entries.

Definition at line 293 of file SCR_MapToolMenuUI.c.

RegisterEntryCustom()

void RegisterEntryCustom ( SCR_MapToolEntry customEntry )

protected

Add custom inherited entry

Parameters

[in]

customEntry

is the subject

Definition at line 267 of file SCR_MapToolMenuUI.c.

RegisterToolMenuEntry()

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

protected

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

Definition at line 245 of file SCR_MapToolMenuUI.c.

SCR_MapToolEntry()

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

protected

Parameters

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

Definition at line 173 of file SCR_MapToolMenuUI.c.

SCR_MapToolMenuUI()

void SCR_MapToolMenuUI ( )

protected

Definition at line 484 of file SCR_MapToolMenuUI.c.

SetActive()

void Attribute::SetActive ( bool toolActive )

protected

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

Definition at line 41 of file SCR_MapToolMenuUI.c.

SetBackgroundColor()

void Attribute::SetBackgroundColor ( notnull Color color )

protected

Set background color

Parameters

[in]

color

is target color

Definition at line 129 of file SCR_MapToolMenuUI.c.

SetBorderColor()

void Attribute::SetBorderColor ( notnull Color color )

protected

Set border color

Parameters

[in]

color

is target color

Definition at line 121 of file SCR_MapToolMenuUI.c.

SetButtonSoundsDisabled()

void Attribute::SetButtonSoundsDisabled ( bool state )

protected

Enable button sounds.

Definition at line 79 of file SCR_MapToolMenuUI.c.

SetColor()

void Attribute::SetColor ( notnull Color color )

protected

Set entry image color

Parameters

[in]

color

is target color

Definition at line 113 of file SCR_MapToolMenuUI.c.

SetToolMenuFocused()

void SetToolMenuFocused ( bool state )

protected

Set focused state

Parameters

[in]

state

Definition at line 366 of file SCR_MapToolMenuUI.c.

SetUIVisible()

void SetUIVisible ( bool state )

protected

Set tool menu visibility

Parameters

[in]

state

is target visibility

Definition at line 357 of file SCR_MapToolMenuUI.c.

SetVisible()

void Attribute::SetVisible ( bool state )

protected

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

Definition at line 71 of file SCR_MapToolMenuUI.c.

UpdateVisual()

void Attribute::UpdateVisual ( )

protected

Update visual based on current state.

Definition at line 86 of file SCR_MapToolMenuUI.c.

Variable Documentation

m_aMenuEntries

ref array<ref SCR_MapToolEntry> m_aMenuEntries = {}

protected

Definition at line 223 of file SCR_MapToolMenuUI.c.

m_bButtonSoundsDisabled

bool m_bButtonSoundsDisabled

protected

Definition at line 5 of file SCR_MapToolMenuUI.c.

m_bIsEnabled

bool m_bIsEnabled = true

protected

Definition at line 1 of file SCR_MapToolMenuUI.c.

m_bIsExclusiveEntry

bool m_bIsExclusiveEntry = false

protected

Definition at line 3 of file SCR_MapToolMenuUI.c.

m_bIsMenuFocused

bool m_bIsMenuFocused

protected

Definition at line 217 of file SCR_MapToolMenuUI.c.

m_bIsVisible

bool m_bIsVisible = true

protected

Definition at line 2 of file SCR_MapToolMenuUI.c.

m_bToolActive

bool m_bToolActive

protected

Definition at line 0 of file SCR_MapToolMenuUI.c.

m_ButtonComp

SCR_ToolMenuButtonComponent m_ButtonComp

protected

Definition at line 9 of file SCR_MapToolMenuUI.c.

m_CursorModule

SCR_MapCursorModule m_CursorModule

protected

Definition at line 221 of file SCR_MapToolMenuUI.c.

m_iSortPriority

int m_iSortPriority

protected

Definition at line 6 of file SCR_MapToolMenuUI.c.

m_OnClick

ref ScriptInvoker m_OnClick = new ScriptInvoker()

protected

Definition at line 12 of file SCR_MapToolMenuUI.c.

m_OnDisableMapUIComponent

ref ScriptInvokerVoid m_OnDisableMapUIComponent

protected

Definition at line 13 of file SCR_MapToolMenuUI.c.

m_OwnerMenu

SCR_MapToolMenuUI m_OwnerMenu

protected

Definition at line 10 of file SCR_MapToolMenuUI.c.

m_sBackgroundName

string m_sBackgroundName

protected

Definition at line 212 of file SCR_MapToolMenuUI.c.

m_sButtonDefaultName

string m_sButtonDefaultName

protected

Definition at line 209 of file SCR_MapToolMenuUI.c.

m_sButtonResource

ResourceName m_sButtonResource

protected

Definition at line 200 of file SCR_MapToolMenuUI.c.

m_sIconQuad

string m_sIconQuad

protected

Definition at line 8 of file SCR_MapToolMenuUI.c.

m_sImageSet

ResourceName m_sImageSet

protected

Definition at line 7 of file SCR_MapToolMenuUI.c.

m_sToolBarName

string m_sToolBarName

protected

Definition at line 206 of file SCR_MapToolMenuUI.c.

m_sToolMenuRootName

string m_sToolMenuRootName

protected

Definition at line 203 of file SCR_MapToolMenuUI.c.

m_wBackground

Widget m_wBackground

protected

Definition at line 218 of file SCR_MapToolMenuUI.c.

m_wToolMenuBar

Widget m_wToolMenuBar

protected

Definition at line 220 of file SCR_MapToolMenuUI.c.

m_wToolMenuRoot

Widget m_wToolMenuRoot

protected

Definition at line 219 of file SCR_MapToolMenuUI.c.