SCR_MapToolEntry Interface Reference

Map tool menu entry data class. More...

Inheritance diagram for SCR_MapToolEntry:

Public Member Functions
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.
string	GetImageSet ()
bool	IsExclusiveEntry ()
void	SCR_MapToolEntry (SCR_MapToolMenuUI menu, ResourceName imageset, string icon, int sortPriority=0, bool isExclusive=0)

Static Public Member Functions
static ScriptInvoker	GetOnEntryToggledInvoker ()

Public Attributes
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

Protected Member Functions
void	SetColor (notnull Color color)
	Set entry image color.
void	SetBorderColor (notnull Color color)
	Set border color.
void	SetBackgroundColor (notnull Color color)
	Set background color.
void	OnClick ()
	On click callback.

Protected Attributes
bool	m_bToolActive
bool	m_bIsEnabled = true
bool	m_bIsVisible = true
bool	m_bIsExclusiveEntry = false

Static Protected Attributes
static ref ScriptInvoker< SCR_MapToolEntry >	s_OnEntryToggled = new ScriptInvoker()

Detailed Description

Map tool menu entry data class.

Constructor & Destructor Documentation

SCR_MapToolEntry()

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

Parameters

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

Member Function Documentation

GetImageSet()

string SCR_MapToolEntry.GetImageSet

(

)

Returns

GetOnDisableMapUIInvoker()

ScriptInvokerVoid SCR_MapToolEntry.GetOnDisableMapUIInvoker

(

)

GetOnEntryToggledInvoker()

static ScriptInvoker SCR_MapToolEntry.GetOnEntryToggledInvoker ( )

static

Returns

IsEntryActive()

bool SCR_MapToolEntry.IsEntryActive

(

)

Returns

IsEntryEnabled()

bool SCR_MapToolEntry.IsEntryEnabled

(

)

Whether entry can be activated.

IsExclusiveEntry()

bool SCR_MapToolEntry.IsExclusiveEntry

(

)

OnClick()

void SCR_MapToolEntry.OnClick ( )

protected

On click callback.

OnDisableMapUIComponent()

void SCR_MapToolEntry.OnDisableMapUIComponent

(

)

SetActive()

void SCR_MapToolEntry.SetActive

(

bool

toolActive

)

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

SetBackgroundColor()

void SCR_MapToolEntry.SetBackgroundColor ( notnull Color color )

protected

Set background color.

Parameters

[in]

color

is target color

SetBorderColor()

void SCR_MapToolEntry.SetBorderColor ( notnull Color color )

protected

Set border color.

Parameters

[in]

color

is target color

SetButtonSoundsDisabled()

void SCR_MapToolEntry.SetButtonSoundsDisabled

(

bool

state

)

Enable button sounds.

SetColor()

void SCR_MapToolEntry.SetColor ( notnull Color color )

protected

Set entry image color.

Parameters

[in]

color

is target color

SetEnabled()

void SCR_MapToolEntry.SetEnabled

(

bool

isEnabled

)

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

SetVisible()

void SCR_MapToolEntry.SetVisible

(

bool

state

)

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

UpdateVisual()

void SCR_MapToolEntry.UpdateVisual

(

)

Update visual based on current state.

Member Data Documentation

m_bButtonSoundsDisabled

bool SCR_MapToolEntry.m_bButtonSoundsDisabled

m_bIsEnabled

bool SCR_MapToolEntry.m_bIsEnabled = true

protected

m_bIsExclusiveEntry

bool SCR_MapToolEntry.m_bIsExclusiveEntry = false

protected

m_bIsVisible

bool SCR_MapToolEntry.m_bIsVisible = true

protected

m_bToolActive

bool SCR_MapToolEntry.m_bToolActive

protected

m_ButtonComp

SCR_ToolMenuButtonComponent SCR_MapToolEntry.m_ButtonComp

m_iSortPriority

int SCR_MapToolEntry.m_iSortPriority

m_OnClick

ref ScriptInvoker SCR_MapToolEntry.m_OnClick = new ScriptInvoker()

m_OnDisableMapUIComponent

ref ScriptInvokerVoid SCR_MapToolEntry.m_OnDisableMapUIComponent

m_OwnerMenu

SCR_MapToolMenuUI SCR_MapToolEntry.m_OwnerMenu

m_sIconQuad

string SCR_MapToolEntry.m_sIconQuad

m_sImageSet

ResourceName SCR_MapToolEntry.m_sImageSet

s_OnEntryToggled

ref ScriptInvoker<SCR_MapToolEntry> SCR_MapToolEntry.s_OnEntryToggled = new ScriptInvoker()

staticprotected

---

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

• Game/Map/ComponentsUI/SCR_MapToolMenuUI.c