Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_MapToolEntry Class Reference

Map tool menu entry data class. More...

Inheritance diagram for SCR_MapToolEntry:

Protected 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.
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)

Static Protected Member Functions

static ScriptInvoker GetOnEntryToggledInvoker ()

Protected Attributes

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

Static Protected Attributes

ref ScriptInvoker< SCR_MapToolEntry > s_OnEntryToggled = new ScriptInvoker()

Detailed Description

Map tool menu entry data class.

Definition at line 2 of file SCR_MapToolMenuUI.c.

Constructor & Destructor Documentation

◆ SCR_MapToolEntry()

void SCR_MapToolEntry::SCR_MapToolEntry ( SCR_MapToolMenuUI menu,
ResourceName imageset,
string icon,
int sortPriority = 0,
bool isExclusive = 0 )
inlineprotected
Parameters
[in]menu
[in]imageset
[in]icon
[in]sortPriority
[in]isExclusive

Definition at line 177 of file SCR_MapToolMenuUI.c.

Member Function Documentation

◆ GetImageSet()

string SCR_MapToolEntry::GetImageSet ( )
inlineprotected
Returns

Definition at line 140 of file SCR_MapToolMenuUI.c.

◆ GetOnDisableMapUIInvoker()

ScriptInvokerVoid SCR_MapToolEntry::GetOnDisableMapUIInvoker ( )
inlineprotected

Definition at line 28 of file SCR_MapToolMenuUI.c.

◆ GetOnEntryToggledInvoker()

ScriptInvoker SCR_MapToolEntry::GetOnEntryToggledInvoker ( )
inlinestaticprotected
Returns

Definition at line 22 of file SCR_MapToolMenuUI.c.

◆ IsEntryActive()

bool SCR_MapToolEntry::IsEntryActive ( )
inlineprotected
Returns

Definition at line 53 of file SCR_MapToolMenuUI.c.

◆ IsEntryEnabled()

bool SCR_MapToolEntry::IsEntryEnabled ( )
inlineprotected

Whether entry can be activated.

Definition at line 68 of file SCR_MapToolMenuUI.c.

◆ IsExclusiveEntry()

bool SCR_MapToolEntry::IsExclusiveEntry ( )
inlineprotected

Definition at line 165 of file SCR_MapToolMenuUI.c.

◆ OnClick()

void SCR_MapToolEntry::OnClick ( )
inlineprotected

On click callback.

Definition at line 147 of file SCR_MapToolMenuUI.c.

◆ OnDisableMapUIComponent()

void SCR_MapToolEntry::OnDisableMapUIComponent ( )
inlineprotected

Definition at line 37 of file SCR_MapToolMenuUI.c.

◆ SetActive()

void SCR_MapToolEntry::SetActive ( bool toolActive)
inlineprotected

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

Definition at line 45 of file SCR_MapToolMenuUI.c.

◆ SetBackgroundColor()

void SCR_MapToolEntry::SetBackgroundColor ( notnull Color color)
inlineprotected

Set background color

Parameters
[in]coloris target color

Definition at line 133 of file SCR_MapToolMenuUI.c.

◆ SetBorderColor()

void SCR_MapToolEntry::SetBorderColor ( notnull Color color)
inlineprotected

Set border color

Parameters
[in]coloris target color

Definition at line 125 of file SCR_MapToolMenuUI.c.

◆ SetButtonSoundsDisabled()

void SCR_MapToolEntry::SetButtonSoundsDisabled ( bool state)
inlineprotected

Enable button sounds.

Definition at line 83 of file SCR_MapToolMenuUI.c.

◆ SetColor()

void SCR_MapToolEntry::SetColor ( notnull Color color)
inlineprotected

Set entry image color

Parameters
[in]coloris target color

Definition at line 117 of file SCR_MapToolMenuUI.c.

◆ SetEnabled()

void SCR_MapToolEntry::SetEnabled ( bool isEnabled)
inlineprotected

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

Definition at line 60 of file SCR_MapToolMenuUI.c.

◆ SetVisible()

void SCR_MapToolEntry::SetVisible ( bool state)
inlineprotected

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

Definition at line 75 of file SCR_MapToolMenuUI.c.

◆ UpdateVisual()

void SCR_MapToolEntry::UpdateVisual ( )
inlineprotected

Update visual based on current state.

Definition at line 90 of file SCR_MapToolMenuUI.c.

Member Data Documentation

◆ m_bButtonSoundsDisabled

bool SCR_MapToolEntry::m_bButtonSoundsDisabled
protected

Definition at line 9 of file SCR_MapToolMenuUI.c.

◆ m_bIsEnabled

bool SCR_MapToolEntry::m_bIsEnabled = true
protected

Definition at line 5 of file SCR_MapToolMenuUI.c.

◆ m_bIsExclusiveEntry

bool SCR_MapToolEntry::m_bIsExclusiveEntry = false
protected

Definition at line 7 of file SCR_MapToolMenuUI.c.

◆ m_bIsVisible

bool SCR_MapToolEntry::m_bIsVisible = true
protected

Definition at line 6 of file SCR_MapToolMenuUI.c.

◆ m_bToolActive

bool SCR_MapToolEntry::m_bToolActive
protected

Definition at line 4 of file SCR_MapToolMenuUI.c.

◆ m_ButtonComp

SCR_ToolMenuButtonComponent SCR_MapToolEntry::m_ButtonComp
protected

Definition at line 13 of file SCR_MapToolMenuUI.c.

◆ m_iSortPriority

int SCR_MapToolEntry::m_iSortPriority
protected

Definition at line 10 of file SCR_MapToolMenuUI.c.

◆ m_OnClick

ref ScriptInvoker SCR_MapToolEntry::m_OnClick = new ScriptInvoker()
protected

Definition at line 16 of file SCR_MapToolMenuUI.c.

◆ m_OnDisableMapUIComponent

ref ScriptInvokerVoid SCR_MapToolEntry::m_OnDisableMapUIComponent
protected

Definition at line 17 of file SCR_MapToolMenuUI.c.

◆ m_OwnerMenu

SCR_MapToolMenuUI SCR_MapToolEntry::m_OwnerMenu
protected

Definition at line 14 of file SCR_MapToolMenuUI.c.

◆ m_sIconQuad

string SCR_MapToolEntry::m_sIconQuad
protected

Definition at line 12 of file SCR_MapToolMenuUI.c.

◆ m_sImageSet

ResourceName SCR_MapToolEntry::m_sImageSet
protected

Definition at line 11 of file SCR_MapToolMenuUI.c.

◆ s_OnEntryToggled

ref ScriptInvoker<SCR_MapToolEntry> SCR_MapToolEntry::s_OnEntryToggled = new ScriptInvoker()
staticprotected

Definition at line 18 of file SCR_MapToolMenuUI.c.

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