Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_SelectionMenu Class Reference
Inheritance diagram for SCR_SelectionMenu:
SCR_RadialMenu

Protected Member Functions

void InvokeOnBeforeOpen ()
ScriptInvoker GetOnBeforeOpen ()
void InvokeOnOpen ()
ScriptInvoker GetOnOpen ()
void InvokeOnClose ()
ScriptInvoker GetOnClose ()
void InvokeOnSelect (SCR_SelectionMenuEntry entry, int id)
ScriptInvoker GetOnSelect ()
ScriptInvoker GetOnOpenFailed ()
void InvokeOnPerform (SCR_SelectionMenuEntry entry)
ScriptInvoker GetOnPerform ()
void InvokeOnOpenCategory (SCR_SelectionMenuCategoryEntry entry, int level)
ScriptInvoker GetOnOpenCategory ()
void InvokeOnAddEntry (SCR_SelectionMenuEntry entry)
ScriptInvoker GetOnAddEntry ()
void InvokeOnRemoveEntry (SCR_SelectionMenuEntry entry)
ScriptInvoker GetOnRemoveEntry ()
void InvokeOnUpdateEntries (array< ref SCR_SelectionMenuEntry > entries)
ScriptInvoker GetOnUpdateEntries ()
void InvokeOnControllerChanged (SCR_SelectionMenuControllerInputs inputs)
ScriptInvoker GetOnControllerChanged ()
void Open ()
void AllowClosing ()
 Allow closing after some time in order to have alternative toggle action with double press.
void OnOpen ()
 Empty method called on open ready for override.
void Close ()
 Callback when close is requested.
void OnClose ()
 Empty method called on close ready for override.
void Update (float timeSlice)
void OnUpdate (float timeSlice)
 Empty method called on update ready for override.
void Init ()
void PlaySound (string sound)
void SelectEntry ()
 Generic method for custom entry selection based on used interface.
void PerformEntry (notnull SCR_SelectionMenuEntry entry)
void OpenCategoryEntry (notnull SCR_SelectionMenuCategoryEntry category)
 Specific peform action for category to change menu content.
void LeaveCategory ()
void OpenInRoot ()
 Clear open categories and use entries from root.
void AddEntry (SCR_SelectionMenuEntry entry=null)
void AddCategoryEntry (SCR_SelectionMenuCategoryEntry category=null)
 Add empty or custom category entry.
void AddEntries (notnull array< ref SCR_SelectionMenuEntry > entries, bool replace=false)
void UpdateEntries ()
 Invoke data update for all entries.
void UpdateSelectedEntries (notnull array< ref SCR_SelectionMenuEntry > entries)
 Invoke data update for selected entries.
void RemoveEntry (notnull SCR_SelectionMenuEntry entry)
 Remove selected entry and invoke data update.
void ClearEntries ()
 Clear all entries and invoke data update.
SCR_SelectionMenuCategoryEntry CurrentCategory ()
void SetMenuDisplay (SCR_SelectionMenuDisplay display=null)
 Find and setup display used for menu.
void AddActionListeners ()
 Add all action listeners for basic menu control.
void RemoveActionListeners ()
 Remove all action listeners for basic menu control.
void OnOpenInputRelease (float value, EActionTrigger reason)
 On open input handle menu closing.
void OnPerformInput ()
 On select input handle entry selection and moving into layers.
void OnBackInput ()
void OnAlternativeToggleInput ()
bool IsOpened ()
void SetController (IEntity owner, SCR_SelectionMenuControllerInputs controls)
 Set controller entity and controls.
SCR_SelectionMenuControllerInputs GetControllerInputs ()
SCR_SelectionMenuEntry GetSelectionEntry ()
int GetSelectedEntryId ()
bool GetEntryPerformed ()
array< ref SCR_SelectionMenuEntryGetEntries ()
int GetEntryCount ()
bool HasDisplay ()
void DebugPrint (string method, string msg)

Protected Attributes

const int OPEN_DELAY = 200
ref SCR_SelectionMenuInputs m_Inputs
string m_sOpenSound
string m_sCloseSound
string m_sSelectionSound
string m_sPerformSound
string m_sEnterCategorySound
string m_sLeaveCategorySound
SCR_SelectionMenuDisplay m_Display
ref array< ref SCR_SelectionMenuEntrym_aRootEntries = {}
ref array< ref SCR_SelectionMenuEntrym_aEntries = {}
SCR_SelectionMenuEntry m_SelectedEntry
int m_iSelectedEntryId
ref SCR_SelectionMenuControllerInputs m_ControllerInputs
bool m_bOpened
bool m_bEntryPerformed
bool m_bUsingAlternativeToggle
bool m_bClosingMenu
bool m_bOpenedForTime
ref array< SCR_SelectionMenuCategoryEntrym_aSelectedCategories = {}
ref ScriptInvoker< SCR_SelectionMenum_OnBeforeOpen
ref ScriptInvoker< SCR_SelectionMenum_OnOpen
ref ScriptInvoker< SCR_SelectionMenum_OnClose
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuEntry, intm_OnSelect
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuEntrym_OnPerform
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuCategoryEntry, intm_OnOpenCategory
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuEntrym_OnAddEntry
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuEntrym_OnRemoveEntry
ref ScriptInvoker< SCR_SelectionMenu, array< ref SCR_SelectionMenuEntry > > m_OnUpdateEntries
ref ScriptInvoker< SCR_SelectionMenu, SCR_SelectionMenuControllerInputsm_OnControllerChanged
ref ScriptInvoker< SCR_SelectionMenu, SelectionMenuFailReason > m_OnOpenFailed

Detailed Description

Scripted base for selection menu used in HUD

Definition at line 6 of file SCR_SelectionMenu.c.

Member Function Documentation

◆ AddActionListeners()

void SCR_SelectionMenu::AddActionListeners ( )
inlineprotected

Add all action listeners for basic menu control.

Definition at line 628 of file SCR_SelectionMenu.c.

◆ AddCategoryEntry()

void SCR_SelectionMenu::AddCategoryEntry ( SCR_SelectionMenuCategoryEntry category = null)
inlineprotected

Add empty or custom category entry.

Definition at line 511 of file SCR_SelectionMenu.c.

◆ AddEntries()

void SCR_SelectionMenu::AddEntries ( notnull array< ref SCR_SelectionMenuEntry > entries,
bool replace = false )
inlineprotected

Add multiple entries in array Replace true will clear menu and use given entries

Definition at line 524 of file SCR_SelectionMenu.c.

◆ AddEntry()

void SCR_SelectionMenu::AddEntry ( SCR_SelectionMenuEntry entry = null)
inlineprotected

Add new entry into menu root Entries update is notified only if menu is opened in root level

Definition at line 489 of file SCR_SelectionMenu.c.

◆ AllowClosing()

void SCR_SelectionMenu::AllowClosing ( )
inlineprotected

Allow closing after some time in order to have alternative toggle action with double press.

Definition at line 286 of file SCR_SelectionMenu.c.

◆ ClearEntries()

void SCR_SelectionMenu::ClearEntries ( )
inlineprotected

Clear all entries and invoke data update.

Definition at line 589 of file SCR_SelectionMenu.c.

◆ Close()

void SCR_SelectionMenu::Close ( )
inlineprotected

Callback when close is requested.

Definition at line 307 of file SCR_SelectionMenu.c.

◆ CurrentCategory()

SCR_SelectionMenuCategoryEntry SCR_SelectionMenu::CurrentCategory ( )
inlineprotected

Return current opened category entry Null means menu is in root

Definition at line 604 of file SCR_SelectionMenu.c.

◆ DebugPrint()

void SCR_SelectionMenu::DebugPrint ( string method,
string msg )
inlineprotected

Definition at line 778 of file SCR_SelectionMenu.c.

◆ GetControllerInputs()

SCR_SelectionMenuControllerInputs SCR_SelectionMenu::GetControllerInputs ( )
inlineprotected

Definition at line 722 of file SCR_SelectionMenu.c.

◆ GetEntries()

array< ref SCR_SelectionMenuEntry > SCR_SelectionMenu::GetEntries ( )
inlineprotected

Definition at line 746 of file SCR_SelectionMenu.c.

◆ GetEntryCount()

int SCR_SelectionMenu::GetEntryCount ( )
inlineprotected

Definition at line 759 of file SCR_SelectionMenu.c.

◆ GetEntryPerformed()

bool SCR_SelectionMenu::GetEntryPerformed ( )
inlineprotected

Definition at line 740 of file SCR_SelectionMenu.c.

◆ GetOnAddEntry()

ScriptInvoker SCR_SelectionMenu::GetOnAddEntry ( )
inlineprotected

Definition at line 178 of file SCR_SelectionMenu.c.

◆ GetOnBeforeOpen()

ScriptInvoker SCR_SelectionMenu::GetOnBeforeOpen ( )
inlineprotected

Definition at line 73 of file SCR_SelectionMenu.c.

◆ GetOnClose()

ScriptInvoker SCR_SelectionMenu::GetOnClose ( )
inlineprotected

Definition at line 105 of file SCR_SelectionMenu.c.

◆ GetOnControllerChanged()

ScriptInvoker SCR_SelectionMenu::GetOnControllerChanged ( )
inlineprotected

Definition at line 226 of file SCR_SelectionMenu.c.

◆ GetOnOpen()

ScriptInvoker SCR_SelectionMenu::GetOnOpen ( )
inlineprotected

Definition at line 89 of file SCR_SelectionMenu.c.

◆ GetOnOpenCategory()

ScriptInvoker SCR_SelectionMenu::GetOnOpenCategory ( )
inlineprotected

Definition at line 162 of file SCR_SelectionMenu.c.

◆ GetOnOpenFailed()

ScriptInvoker SCR_SelectionMenu::GetOnOpenFailed ( )
inlineprotected

Definition at line 130 of file SCR_SelectionMenu.c.

◆ GetOnPerform()

ScriptInvoker SCR_SelectionMenu::GetOnPerform ( )
inlineprotected

Definition at line 146 of file SCR_SelectionMenu.c.

◆ GetOnRemoveEntry()

ScriptInvoker SCR_SelectionMenu::GetOnRemoveEntry ( )
inlineprotected

Definition at line 194 of file SCR_SelectionMenu.c.

◆ GetOnSelect()

ScriptInvoker SCR_SelectionMenu::GetOnSelect ( )
inlineprotected

Definition at line 121 of file SCR_SelectionMenu.c.

◆ GetOnUpdateEntries()

ScriptInvoker SCR_SelectionMenu::GetOnUpdateEntries ( )
inlineprotected

Definition at line 210 of file SCR_SelectionMenu.c.

◆ GetSelectedEntryId()

int SCR_SelectionMenu::GetSelectedEntryId ( )
inlineprotected

Definition at line 734 of file SCR_SelectionMenu.c.

◆ GetSelectionEntry()

SCR_SelectionMenuEntry SCR_SelectionMenu::GetSelectionEntry ( )
inlineprotected

Definition at line 728 of file SCR_SelectionMenu.c.

◆ HasDisplay()

bool SCR_SelectionMenu::HasDisplay ( )
inlineprotected

Definition at line 768 of file SCR_SelectionMenu.c.

◆ Init()

void SCR_SelectionMenu::Init ( )
inlineprotected

Definition at line 350 of file SCR_SelectionMenu.c.

◆ InvokeOnAddEntry()

void SCR_SelectionMenu::InvokeOnAddEntry ( SCR_SelectionMenuEntry entry)
inlineprotected

Definition at line 171 of file SCR_SelectionMenu.c.

◆ InvokeOnBeforeOpen()

void SCR_SelectionMenu::InvokeOnBeforeOpen ( )
inlineprotected

Definition at line 66 of file SCR_SelectionMenu.c.

◆ InvokeOnClose()

void SCR_SelectionMenu::InvokeOnClose ( )
inlineprotected

Definition at line 98 of file SCR_SelectionMenu.c.

◆ InvokeOnControllerChanged()

void SCR_SelectionMenu::InvokeOnControllerChanged ( SCR_SelectionMenuControllerInputs inputs)
inlineprotected

Definition at line 219 of file SCR_SelectionMenu.c.

◆ InvokeOnOpen()

void SCR_SelectionMenu::InvokeOnOpen ( )
inlineprotected

Definition at line 82 of file SCR_SelectionMenu.c.

◆ InvokeOnOpenCategory()

void SCR_SelectionMenu::InvokeOnOpenCategory ( SCR_SelectionMenuCategoryEntry entry,
int level )
inlineprotected

Definition at line 155 of file SCR_SelectionMenu.c.

◆ InvokeOnPerform()

void SCR_SelectionMenu::InvokeOnPerform ( SCR_SelectionMenuEntry entry)
inlineprotected

Definition at line 139 of file SCR_SelectionMenu.c.

◆ InvokeOnRemoveEntry()

void SCR_SelectionMenu::InvokeOnRemoveEntry ( SCR_SelectionMenuEntry entry)
inlineprotected

Definition at line 187 of file SCR_SelectionMenu.c.

◆ InvokeOnSelect()

void SCR_SelectionMenu::InvokeOnSelect ( SCR_SelectionMenuEntry entry,
int id )
inlineprotected

Definition at line 114 of file SCR_SelectionMenu.c.

◆ InvokeOnUpdateEntries()

void SCR_SelectionMenu::InvokeOnUpdateEntries ( array< ref SCR_SelectionMenuEntry > entries)
inlineprotected

Definition at line 203 of file SCR_SelectionMenu.c.

◆ IsOpened()

bool SCR_SelectionMenu::IsOpened ( )
inlineprotected

Definition at line 703 of file SCR_SelectionMenu.c.

◆ LeaveCategory()

void SCR_SelectionMenu::LeaveCategory ( )
inlineprotected

Definition at line 432 of file SCR_SelectionMenu.c.

◆ OnAlternativeToggleInput()

void SCR_SelectionMenu::OnAlternativeToggleInput ( )
inlineprotected

Definition at line 693 of file SCR_SelectionMenu.c.

◆ OnBackInput()

void SCR_SelectionMenu::OnBackInput ( )
inlineprotected

Definition at line 675 of file SCR_SelectionMenu.c.

◆ OnClose()

void SCR_SelectionMenu::OnClose ( )
inlineprotected

Empty method called on close ready for override.

Definition at line 330 of file SCR_SelectionMenu.c.

◆ OnOpen()

void SCR_SelectionMenu::OnOpen ( )
inlineprotected

Empty method called on open ready for override.

Definition at line 303 of file SCR_SelectionMenu.c.

◆ OnOpenInputRelease()

void SCR_SelectionMenu::OnOpenInputRelease ( float value,
EActionTrigger reason )
inlineprotected

On open input handle menu closing.

Definition at line 658 of file SCR_SelectionMenu.c.

◆ OnPerformInput()

void SCR_SelectionMenu::OnPerformInput ( )
inlineprotected

On select input handle entry selection and moving into layers.

Definition at line 668 of file SCR_SelectionMenu.c.

◆ OnUpdate()

void SCR_SelectionMenu::OnUpdate ( float timeSlice)
inlineprotected

Empty method called on update ready for override.

Definition at line 347 of file SCR_SelectionMenu.c.

◆ Open()

void SCR_SelectionMenu::Open ( )
inlineprotected

Definition at line 239 of file SCR_SelectionMenu.c.

◆ OpenCategoryEntry()

void SCR_SelectionMenu::OpenCategoryEntry ( notnull SCR_SelectionMenuCategoryEntry category)
inlineprotected

Specific peform action for category to change menu content.

Definition at line 410 of file SCR_SelectionMenu.c.

◆ OpenInRoot()

void SCR_SelectionMenu::OpenInRoot ( )
inlineprotected

Clear open categories and use entries from root.

Definition at line 472 of file SCR_SelectionMenu.c.

◆ PerformEntry()

void SCR_SelectionMenu::PerformEntry ( notnull SCR_SelectionMenuEntry entry)
inlineprotected

Definition at line 371 of file SCR_SelectionMenu.c.

◆ PlaySound()

void SCR_SelectionMenu::PlaySound ( string sound)
inlineprotected

Definition at line 356 of file SCR_SelectionMenu.c.

◆ RemoveActionListeners()

void SCR_SelectionMenu::RemoveActionListeners ( )
inlineprotected

Remove all action listeners for basic menu control.

Definition at line 645 of file SCR_SelectionMenu.c.

◆ RemoveEntry()

void SCR_SelectionMenu::RemoveEntry ( notnull SCR_SelectionMenuEntry entry)
inlineprotected

Remove selected entry and invoke data update.

Definition at line 575 of file SCR_SelectionMenu.c.

◆ SelectEntry()

void SCR_SelectionMenu::SelectEntry ( )
inlineprotected

Generic method for custom entry selection based on used interface.

Definition at line 368 of file SCR_SelectionMenu.c.

◆ SetController()

void SCR_SelectionMenu::SetController ( IEntity owner,
SCR_SelectionMenuControllerInputs controls )
inlineprotected

Set controller entity and controls.

Definition at line 710 of file SCR_SelectionMenu.c.

◆ SetMenuDisplay()

void SCR_SelectionMenu::SetMenuDisplay ( SCR_SelectionMenuDisplay display = null)
inlineprotected

Find and setup display used for menu.

Definition at line 614 of file SCR_SelectionMenu.c.

◆ Update()

void SCR_SelectionMenu::Update ( float timeSlice)
inlineprotected

Definition at line 333 of file SCR_SelectionMenu.c.

◆ UpdateEntries()

void SCR_SelectionMenu::UpdateEntries ( )
inlineprotected

Invoke data update for all entries.

Definition at line 549 of file SCR_SelectionMenu.c.

◆ UpdateSelectedEntries()

void SCR_SelectionMenu::UpdateSelectedEntries ( notnull array< ref SCR_SelectionMenuEntry > entries)
inlineprotected

Invoke data update for selected entries.

Definition at line 562 of file SCR_SelectionMenu.c.

Member Data Documentation

◆ m_aEntries

ref array<ref SCR_SelectionMenuEntry> SCR_SelectionMenu::m_aEntries = {}
protected

Definition at line 36 of file SCR_SelectionMenu.c.

◆ m_aRootEntries

ref array<ref SCR_SelectionMenuEntry> SCR_SelectionMenu::m_aRootEntries = {}
protected

Definition at line 35 of file SCR_SelectionMenu.c.

◆ m_aSelectedCategories

ref array<SCR_SelectionMenuCategoryEntry> SCR_SelectionMenu::m_aSelectedCategories = {}
protected

Definition at line 48 of file SCR_SelectionMenu.c.

◆ m_bClosingMenu

bool SCR_SelectionMenu::m_bClosingMenu
protected

Definition at line 44 of file SCR_SelectionMenu.c.

◆ m_bEntryPerformed

bool SCR_SelectionMenu::m_bEntryPerformed
protected

Definition at line 42 of file SCR_SelectionMenu.c.

◆ m_bOpened

bool SCR_SelectionMenu::m_bOpened
protected

Definition at line 41 of file SCR_SelectionMenu.c.

◆ m_bOpenedForTime

bool SCR_SelectionMenu::m_bOpenedForTime
protected

Definition at line 45 of file SCR_SelectionMenu.c.

◆ m_bUsingAlternativeToggle

bool SCR_SelectionMenu::m_bUsingAlternativeToggle
protected

Definition at line 43 of file SCR_SelectionMenu.c.

◆ m_ControllerInputs

ref SCR_SelectionMenuControllerInputs SCR_SelectionMenu::m_ControllerInputs
protected

Definition at line 40 of file SCR_SelectionMenu.c.

◆ m_Display

SCR_SelectionMenuDisplay SCR_SelectionMenu::m_Display
protected

Definition at line 33 of file SCR_SelectionMenu.c.

◆ m_Inputs

ref SCR_SelectionMenuInputs SCR_SelectionMenu::m_Inputs
protected

Definition at line 12 of file SCR_SelectionMenu.c.

◆ m_iSelectedEntryId

int SCR_SelectionMenu::m_iSelectedEntryId
protected

Definition at line 38 of file SCR_SelectionMenu.c.

◆ m_OnAddEntry

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuEntry> SCR_SelectionMenu::m_OnAddEntry
protected

Definition at line 58 of file SCR_SelectionMenu.c.

◆ m_OnBeforeOpen

ref ScriptInvoker<SCR_SelectionMenu> SCR_SelectionMenu::m_OnBeforeOpen
protected

Definition at line 51 of file SCR_SelectionMenu.c.

◆ m_OnClose

ref ScriptInvoker<SCR_SelectionMenu> SCR_SelectionMenu::m_OnClose
protected

Definition at line 53 of file SCR_SelectionMenu.c.

◆ m_OnControllerChanged

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuControllerInputs> SCR_SelectionMenu::m_OnControllerChanged
protected

Definition at line 62 of file SCR_SelectionMenu.c.

◆ m_OnOpen

ref ScriptInvoker<SCR_SelectionMenu> SCR_SelectionMenu::m_OnOpen
protected

Definition at line 52 of file SCR_SelectionMenu.c.

◆ m_OnOpenCategory

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuCategoryEntry, int> SCR_SelectionMenu::m_OnOpenCategory
protected

Definition at line 56 of file SCR_SelectionMenu.c.

◆ m_OnOpenFailed

ref ScriptInvoker<SCR_SelectionMenu, SelectionMenuFailReason> SCR_SelectionMenu::m_OnOpenFailed
protected

Definition at line 63 of file SCR_SelectionMenu.c.

◆ m_OnPerform

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuEntry> SCR_SelectionMenu::m_OnPerform
protected

Definition at line 55 of file SCR_SelectionMenu.c.

◆ m_OnRemoveEntry

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuEntry> SCR_SelectionMenu::m_OnRemoveEntry
protected

Definition at line 59 of file SCR_SelectionMenu.c.

◆ m_OnSelect

ref ScriptInvoker<SCR_SelectionMenu, SCR_SelectionMenuEntry, int> SCR_SelectionMenu::m_OnSelect
protected

Definition at line 54 of file SCR_SelectionMenu.c.

◆ m_OnUpdateEntries

ref ScriptInvoker<SCR_SelectionMenu, array<ref SCR_SelectionMenuEntry> > SCR_SelectionMenu::m_OnUpdateEntries
protected

Definition at line 60 of file SCR_SelectionMenu.c.

◆ m_sCloseSound

string SCR_SelectionMenu::m_sCloseSound
protected

Definition at line 18 of file SCR_SelectionMenu.c.

◆ m_SelectedEntry

SCR_SelectionMenuEntry SCR_SelectionMenu::m_SelectedEntry
protected

Definition at line 37 of file SCR_SelectionMenu.c.

◆ m_sEnterCategorySound

string SCR_SelectionMenu::m_sEnterCategorySound
protected

Definition at line 27 of file SCR_SelectionMenu.c.

◆ m_sLeaveCategorySound

string SCR_SelectionMenu::m_sLeaveCategorySound
protected

Definition at line 30 of file SCR_SelectionMenu.c.

◆ m_sOpenSound

string SCR_SelectionMenu::m_sOpenSound
protected

Definition at line 15 of file SCR_SelectionMenu.c.

◆ m_sPerformSound

string SCR_SelectionMenu::m_sPerformSound
protected

Definition at line 24 of file SCR_SelectionMenu.c.

◆ m_sSelectionSound

string SCR_SelectionMenu::m_sSelectionSound
protected

Definition at line 21 of file SCR_SelectionMenu.c.

◆ OPEN_DELAY

const int SCR_SelectionMenu::OPEN_DELAY = 200
protected

Definition at line 8 of file SCR_SelectionMenu.c.


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