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

Protected Member Functions

override void OnMenuOpen ()
override void OnMenuShow ()
override void OnMenuHide ()
void OnSubCategoryClicked (Widget w)
bool FlipButtonState (Widget w, bool state)
void OnTileClicked (Widget w)
Widget CreateTileWidget (notnull SCR_FieldManualConfigEntry entry, notnull Widget parent)
 creates a tile and sets its image, background & text
void SetTilesByWidget (Widget widget)
 sets entry tiles from a sub-category's widget
void SetTiles (array< ref SCR_FieldManualConfigEntry > entries)
 sets main Field Manual grid tiles from entries
void SetCurrentEntry (SCR_FieldManualConfigEntry entry)
 Sets the current entry to read - can be null (leave reading mode) or any SCR_FieldManualConfigEntry.
void QueueRefreshCurrentEntry ()
 Add current entry's refresh to callqueue (used by KBM/Gamepad switching event).
void RefreshCurrentEntry ()
 Re-creates the current entry (called by callqueue added in QueueRefreshCurrentEntry).
void SetScrollAfterRefresh (notnull ScrollLayoutWidget scroll, float x, float y)
void OpenEntry (EFieldManualEntryId entryId)
void SetCurrentEntryByWidget (Widget widget)
 sets the read entry linked from that widget
void FillEntry_Weapon (notnull Widget widget, notnull SCR_FieldManualConfigEntry_Weapon entry)
bool FillEntry_Weapon_Render (RenderTargetWidget renderTarget, ResourceName weaponResourceName)
void FillEntry_Weapon_Statistics (Widget statsLayout, SCR_FieldManualConfigEntry_Weapon entry)
void FillEntry_Weapon_Statistics_Mass (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void FillEntry_Weapon_Statistics_SightAdjustments (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void FillEntry_Weapon_Statistics_DefaultSightAdjustment (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void FillEntry_Weapon_Statistics_RateOfFire (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void FillEntry_Weapon_Statistics_MuzzleVelocity (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void FillEntry_Weapon_Statistics_FireModes (notnull Widget statsLayout, notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper)
void SetAllEntriesAndParents ()
 one-time call that goes through all categories and entries and adds enabled entries to a one-level array
void CreateCategoryMenuWidgets ()
 Create main categories buttons list.
void OpenFirstSubCategory ()
 Open the first sub-category, showing its entries.
void OpenLastSelectedSubCategory ()
 Open the last selected Sub Category and selected it.
void FocusLastSelectedEntry (Widget w=null)
 Focus the last selected valid widget.
void ResetLastSearch ()
 resets last search value
void ProcessSearch (SCR_EditBoxSearchComponent searchbox, string search)
 the search process itself - finds entries and set tiles
void CloseReadingPanel ()
 closes the reading panel (sets the current entry to null)
void CloseMenuOrReadingPanel ()
void ShowQueueMessage ()
 Show the Server Queue.
void HideQueueMessage ()
 Hide the Server Queue.
void SCR_FieldManualUI ()
void ~SCR_FieldManualUI ()

Static Protected Member Functions

static SCR_FieldManualUI Open (EFieldManualEntryId entryId)
 opens the first entry matching the EFieldManualEntryId enum value
static string ArrayJoin (notnull array< string > entries)
 joins strings with a stringtable separator - from 0 to 5 entries

Protected Attributes

TextWidget m_wMenuTitle
VerticalLayoutWidget m_wMenuCategoryList
SCR_EditBoxSearchComponent m_MenuSearchbar
SCR_InputButtonComponent m_MenuBtnBack
Widget m_wReadingWidget
SCR_BreadCrumbsComponent m_BreadCrumbsComponent
TextWidget m_wPageEntryTitle
Widget m_wPageFrame
ScrollLayoutWidget m_wGridScrollLayoutWidget
GridLayoutWidget m_wMenuGridLayout
string m_sLastSearch
ref SCR_FieldManualConfigRoot m_ConfigRoot
ref array< ref SCR_FieldManualConfigEntry > m_aAllEntries
ref map< Widget, ref SCR_FieldManualConfigEntry > m_mWidgetEntryMap
ref map< Widget, ref SCR_FieldManualConfigCategory > m_mWidgetSubCategoryMap
ref SCR_FieldManualSubCategoryScriptedWidgetEventHandler m_SubCategoryButtonEventHandler
ref SCR_FieldManualEntryScriptedWidgetEventHandler m_EntryButtonEventHandler
Widget m_wLastClickedSubCategory
Widget m_wLoadingServerQueue
SCR_FieldManualConfigEntry m_CurrentEntry
ButtonWidget m_wFirstSubCategoryButton
Widget m_wLastSelectedWidget
bool m_bIsInEntryViewMode
bool m_bIsInSearchMode
bool m_bOpenedFromOutside
bool m_bArmaWarning
float m_fSliderYPos

Static Protected Attributes

static const int TILES_GRID_WIDTH = 5
static const string SEARCH_RESULT_KEY = "#AR-FieldManual_SearchResult"
static const string SEARCH_NO_RESULT_KEY = "#AR-FieldManual_SearchResult_None"
static const string SCROLL_NAME = "mainScroll"
static const int ENTRY_INPUT_REFRESH_DELAY = 500
static const int ENTRY_SCROLL_INPUT_REFRESH_DELAY = 1000 / 60

Detailed Description

Definition at line 1 of file SCR_FieldManualUI.c.

Constructor & Destructor Documentation

◆ SCR_FieldManualUI()

void SCR_FieldManualUI::SCR_FieldManualUI ( )
inlineprotected

Definition at line 894 of file SCR_FieldManualUI.c.

◆ ~SCR_FieldManualUI()

void SCR_FieldManualUI::~SCR_FieldManualUI ( )
inlineprotected

Definition at line 907 of file SCR_FieldManualUI.c.

Member Function Documentation

◆ ArrayJoin()

string SCR_FieldManualUI::ArrayJoin ( notnull array< string > entries)
inlinestaticprotected

joins strings with a stringtable separator - from 0 to 5 entries

Definition at line 872 of file SCR_FieldManualUI.c.

◆ CloseMenuOrReadingPanel()

void SCR_FieldManualUI::CloseMenuOrReadingPanel ( )
inlineprotected

determines what happens when ESC is pressed

  • if in reading mode, closes the reading panel
  • if in main view, closes the Field Manual

Definition at line 831 of file SCR_FieldManualUI.c.

◆ CloseReadingPanel()

void SCR_FieldManualUI::CloseReadingPanel ( )
inlineprotected

closes the reading panel (sets the current entry to null)

Definition at line 822 of file SCR_FieldManualUI.c.

◆ CreateCategoryMenuWidgets()

void SCR_FieldManualUI::CreateCategoryMenuWidgets ( )
inlineprotected

Create main categories buttons list.

Definition at line 667 of file SCR_FieldManualUI.c.

◆ CreateTileWidget()

Widget SCR_FieldManualUI::CreateTileWidget ( notnull SCR_FieldManualConfigEntry entry,
notnull Widget parent )
inlineprotected

creates a tile and sets its image, background & text

Definition at line 240 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon()

void SCR_FieldManualUI::FillEntry_Weapon ( notnull Widget widget,
notnull SCR_FieldManualConfigEntry_Weapon entry )
inlineprotected

Definition at line 448 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Render()

bool SCR_FieldManualUI::FillEntry_Weapon_Render ( RenderTargetWidget renderTarget,
ResourceName weaponResourceName )
inlineprotected

Definition at line 459 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics ( Widget statsLayout,
SCR_FieldManualConfigEntry_Weapon entry )
inlineprotected

Definition at line 486 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_DefaultSightAdjustment()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_DefaultSightAdjustment ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 544 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_FireModes()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_FireModes ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 584 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_Mass()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_Mass ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 507 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_MuzzleVelocity()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_MuzzleVelocity ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 571 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_RateOfFire()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_RateOfFire ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 558 of file SCR_FieldManualUI.c.

◆ FillEntry_Weapon_Statistics_SightAdjustments()

void SCR_FieldManualUI::FillEntry_Weapon_Statistics_SightAdjustments ( notnull Widget statsLayout,
notnull SCR_FieldManualUI_WeaponStatsHelper weaponStatsHelper )
inlineprotected

Definition at line 521 of file SCR_FieldManualUI.c.

◆ FlipButtonState()

bool SCR_FieldManualUI::FlipButtonState ( Widget w,
bool state )
inlineprotected
Parameters
[in]widgetsub category button
[in]booltoggle state

Definition at line 210 of file SCR_FieldManualUI.c.

◆ FocusLastSelectedEntry()

void SCR_FieldManualUI::FocusLastSelectedEntry ( Widget w = null)
inlineprotected

Focus the last selected valid widget.

Definition at line 719 of file SCR_FieldManualUI.c.

◆ HideQueueMessage()

void SCR_FieldManualUI::HideQueueMessage ( )
inlineprotected

Hide the Server Queue.

Definition at line 849 of file SCR_FieldManualUI.c.

◆ OnMenuHide()

override void SCR_FieldManualUI::OnMenuHide ( )
inlineprotected

Definition at line 165 of file SCR_FieldManualUI.c.

◆ OnMenuOpen()

override void SCR_FieldManualUI::OnMenuOpen ( )
inlineprotected

Definition at line 48 of file SCR_FieldManualUI.c.

◆ OnMenuShow()

override void SCR_FieldManualUI::OnMenuShow ( )
inlineprotected

Definition at line 153 of file SCR_FieldManualUI.c.

◆ OnSubCategoryClicked()

void SCR_FieldManualUI::OnSubCategoryClicked ( Widget w)
inlineprotected
Parameters
[in]w

Definition at line 189 of file SCR_FieldManualUI.c.

◆ OnTileClicked()

void SCR_FieldManualUI::OnTileClicked ( Widget w)
inlineprotected

Open the clicked tile card

Parameters
[in]w

Definition at line 228 of file SCR_FieldManualUI.c.

◆ Open()

SCR_FieldManualUI SCR_FieldManualUI::Open ( EFieldManualEntryId entryId)
inlinestaticprotected

opens the first entry matching the EFieldManualEntryId enum value

Definition at line 861 of file SCR_FieldManualUI.c.

◆ OpenEntry()

void SCR_FieldManualUI::OpenEntry ( EFieldManualEntryId entryId)
inlineprotected

Opens an entry "from outside", e.g a hint

Parameters
[in]entryIdif EFieldManualEntryId.NONE is used or if the entry is not found, the Field Manual is normally opened

Definition at line 415 of file SCR_FieldManualUI.c.

◆ OpenFirstSubCategory()

void SCR_FieldManualUI::OpenFirstSubCategory ( )
inlineprotected

Open the first sub-category, showing its entries.

Definition at line 703 of file SCR_FieldManualUI.c.

◆ OpenLastSelectedSubCategory()

void SCR_FieldManualUI::OpenLastSelectedSubCategory ( )
inlineprotected

Open the last selected Sub Category and selected it.

Definition at line 711 of file SCR_FieldManualUI.c.

◆ ProcessSearch()

void SCR_FieldManualUI::ProcessSearch ( SCR_EditBoxSearchComponent searchbox,
string search )
inlineprotected

the search process itself - finds entries and set tiles

Definition at line 738 of file SCR_FieldManualUI.c.

◆ QueueRefreshCurrentEntry()

void SCR_FieldManualUI::QueueRefreshCurrentEntry ( )
inlineprotected

Add current entry's refresh to callqueue (used by KBM/Gamepad switching event).

Definition at line 364 of file SCR_FieldManualUI.c.

◆ RefreshCurrentEntry()

void SCR_FieldManualUI::RefreshCurrentEntry ( )
inlineprotected

Re-creates the current entry (called by callqueue added in QueueRefreshCurrentEntry).

Definition at line 376 of file SCR_FieldManualUI.c.

◆ ResetLastSearch()

void SCR_FieldManualUI::ResetLastSearch ( )
inlineprotected

resets last search value

Definition at line 731 of file SCR_FieldManualUI.c.

◆ SetAllEntriesAndParents()

void SCR_FieldManualUI::SetAllEntriesAndParents ( )
inlineprotected

one-time call that goes through all categories and entries and adds enabled entries to a one-level array

Definition at line 600 of file SCR_FieldManualUI.c.

◆ SetCurrentEntry()

void SCR_FieldManualUI::SetCurrentEntry ( SCR_FieldManualConfigEntry entry)
inlineprotected

Sets the current entry to read - can be null (leave reading mode) or any SCR_FieldManualConfigEntry.

Definition at line 323 of file SCR_FieldManualUI.c.

◆ SetCurrentEntryByWidget()

void SCR_FieldManualUI::SetCurrentEntryByWidget ( Widget widget)
inlineprotected

sets the read entry linked from that widget

Definition at line 438 of file SCR_FieldManualUI.c.

◆ SetScrollAfterRefresh()

void SCR_FieldManualUI::SetScrollAfterRefresh ( notnull ScrollLayoutWidget scroll,
float x,
float y )
inlineprotected

Definition at line 397 of file SCR_FieldManualUI.c.

◆ SetTiles()

void SCR_FieldManualUI::SetTiles ( array< ref SCR_FieldManualConfigEntry > entries)
inlineprotected

sets main Field Manual grid tiles from entries

Definition at line 278 of file SCR_FieldManualUI.c.

◆ SetTilesByWidget()

void SCR_FieldManualUI::SetTilesByWidget ( Widget widget)
inlineprotected

sets entry tiles from a sub-category's widget

Definition at line 263 of file SCR_FieldManualUI.c.

◆ ShowQueueMessage()

void SCR_FieldManualUI::ShowQueueMessage ( )
inlineprotected

Show the Server Queue.

Definition at line 841 of file SCR_FieldManualUI.c.

Member Data Documentation

◆ ENTRY_INPUT_REFRESH_DELAY

const int SCR_FieldManualUI::ENTRY_INPUT_REFRESH_DELAY = 500
staticprotected

Definition at line 44 of file SCR_FieldManualUI.c.

◆ ENTRY_SCROLL_INPUT_REFRESH_DELAY

const int SCR_FieldManualUI::ENTRY_SCROLL_INPUT_REFRESH_DELAY = 1000 / 60
staticprotected

Definition at line 45 of file SCR_FieldManualUI.c.

◆ m_aAllEntries

ref array<ref SCR_FieldManualConfigEntry> SCR_FieldManualUI::m_aAllEntries
protected

Definition at line 18 of file SCR_FieldManualUI.c.

◆ m_bArmaWarning

bool SCR_FieldManualUI::m_bArmaWarning
protected

Definition at line 36 of file SCR_FieldManualUI.c.

◆ m_bIsInEntryViewMode

bool SCR_FieldManualUI::m_bIsInEntryViewMode
protected

Definition at line 32 of file SCR_FieldManualUI.c.

◆ m_bIsInSearchMode

bool SCR_FieldManualUI::m_bIsInSearchMode
protected

Definition at line 33 of file SCR_FieldManualUI.c.

◆ m_bOpenedFromOutside

bool SCR_FieldManualUI::m_bOpenedFromOutside
protected

Definition at line 34 of file SCR_FieldManualUI.c.

◆ m_BreadCrumbsComponent

SCR_BreadCrumbsComponent SCR_FieldManualUI::m_BreadCrumbsComponent
protected

Definition at line 9 of file SCR_FieldManualUI.c.

◆ m_ConfigRoot

ref SCR_FieldManualConfigRoot SCR_FieldManualUI::m_ConfigRoot
protected

Definition at line 17 of file SCR_FieldManualUI.c.

◆ m_CurrentEntry

SCR_FieldManualConfigEntry SCR_FieldManualUI::m_CurrentEntry
protected

Definition at line 27 of file SCR_FieldManualUI.c.

◆ m_EntryButtonEventHandler

ref SCR_FieldManualEntryScriptedWidgetEventHandler SCR_FieldManualUI::m_EntryButtonEventHandler
protected

Definition at line 22 of file SCR_FieldManualUI.c.

◆ m_fSliderYPos

float SCR_FieldManualUI::m_fSliderYPos
protected

Definition at line 38 of file SCR_FieldManualUI.c.

◆ m_MenuBtnBack

SCR_InputButtonComponent SCR_FieldManualUI::m_MenuBtnBack
protected

Definition at line 6 of file SCR_FieldManualUI.c.

◆ m_MenuSearchbar

SCR_EditBoxSearchComponent SCR_FieldManualUI::m_MenuSearchbar
protected

Definition at line 5 of file SCR_FieldManualUI.c.

◆ m_mWidgetEntryMap

ref map<Widget, ref SCR_FieldManualConfigEntry> SCR_FieldManualUI::m_mWidgetEntryMap
protected

Definition at line 19 of file SCR_FieldManualUI.c.

◆ m_mWidgetSubCategoryMap

ref map<Widget, ref SCR_FieldManualConfigCategory> SCR_FieldManualUI::m_mWidgetSubCategoryMap
protected

Definition at line 20 of file SCR_FieldManualUI.c.

◆ m_sLastSearch

string SCR_FieldManualUI::m_sLastSearch
protected

Definition at line 15 of file SCR_FieldManualUI.c.

◆ m_SubCategoryButtonEventHandler

ref SCR_FieldManualSubCategoryScriptedWidgetEventHandler SCR_FieldManualUI::m_SubCategoryButtonEventHandler
protected

Definition at line 21 of file SCR_FieldManualUI.c.

◆ m_wFirstSubCategoryButton

ButtonWidget SCR_FieldManualUI::m_wFirstSubCategoryButton
protected

Definition at line 29 of file SCR_FieldManualUI.c.

◆ m_wGridScrollLayoutWidget

ScrollLayoutWidget SCR_FieldManualUI::m_wGridScrollLayoutWidget
protected

Definition at line 12 of file SCR_FieldManualUI.c.

◆ m_wLastClickedSubCategory

Widget SCR_FieldManualUI::m_wLastClickedSubCategory
protected

Definition at line 23 of file SCR_FieldManualUI.c.

◆ m_wLastSelectedWidget

Widget SCR_FieldManualUI::m_wLastSelectedWidget
protected

Definition at line 30 of file SCR_FieldManualUI.c.

◆ m_wLoadingServerQueue

Widget SCR_FieldManualUI::m_wLoadingServerQueue
protected

Definition at line 25 of file SCR_FieldManualUI.c.

◆ m_wMenuCategoryList

VerticalLayoutWidget SCR_FieldManualUI::m_wMenuCategoryList
protected

Definition at line 4 of file SCR_FieldManualUI.c.

◆ m_wMenuGridLayout

GridLayoutWidget SCR_FieldManualUI::m_wMenuGridLayout
protected

Definition at line 13 of file SCR_FieldManualUI.c.

◆ m_wMenuTitle

TextWidget SCR_FieldManualUI::m_wMenuTitle
protected

Definition at line 3 of file SCR_FieldManualUI.c.

◆ m_wPageEntryTitle

TextWidget SCR_FieldManualUI::m_wPageEntryTitle
protected

Definition at line 10 of file SCR_FieldManualUI.c.

◆ m_wPageFrame

Widget SCR_FieldManualUI::m_wPageFrame
protected

Definition at line 11 of file SCR_FieldManualUI.c.

◆ m_wReadingWidget

Widget SCR_FieldManualUI::m_wReadingWidget
protected

Definition at line 8 of file SCR_FieldManualUI.c.

◆ SCROLL_NAME

const string SCR_FieldManualUI::SCROLL_NAME = "mainScroll"
staticprotected

Definition at line 43 of file SCR_FieldManualUI.c.

◆ SEARCH_NO_RESULT_KEY

const string SCR_FieldManualUI::SEARCH_NO_RESULT_KEY = "#AR-FieldManual_SearchResult_None"
staticprotected

Definition at line 42 of file SCR_FieldManualUI.c.

◆ SEARCH_RESULT_KEY

const string SCR_FieldManualUI::SEARCH_RESULT_KEY = "#AR-FieldManual_SearchResult"
staticprotected

Definition at line 41 of file SCR_FieldManualUI.c.

◆ TILES_GRID_WIDTH

const int SCR_FieldManualUI::TILES_GRID_WIDTH = 5
staticprotected

Definition at line 40 of file SCR_FieldManualUI.c.

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