Inheritance diagram for SCR_FieldManualUI:

[legend]

Public Member Functions
void	OnSubCategoryClicked (Widget w)

void	OnTileClicked (Widget w)

void	OpenEntry (EFieldManualEntryId entryId)
	Opens an entry "from outside", e.g a hint.

void	SCR_FieldManualUI ()

void	~SCR_FieldManualUI ()

Public Member Functions inherited from MenuRootBase
ScriptInvoker	GetOnMenuFocusGained ()

ScriptInvoker	GetOnMenuFocusLost ()

ScriptInvoker	GetOnMenuShow ()

ScriptInvoker	GetOnMenuHide ()

ScriptInvoker	GetOnMenuItem ()

ScriptInvoker	GetOnMenuUpdate ()

ScriptInvoker	GetOnMenuOpen ()

ScriptInvoker	GetOnMenuInit ()

ScriptInvoker	GetOnMenuClose ()

void	OnMenuClosed ()

void	InitChat ()

void	ShowChat ()

MenuRootComponent	GetRootComponent ()

SCR_DynamicFooterComponent	GetFooterComponent ()

override void	OnMenuFocusGained ()

override void	OnMenuFocusLost ()

override void	OnMenuShow ()

override void	OnMenuHide ()

override void	OnMenuItem (string menuItemName, bool changed, bool finished)

override void	OnMenuUpdate (float tDelta)

override void	OnMenuOpen ()

override void	OnMenuInit ()

override void	OnMenuClose ()

Public Member Functions inherited from ChimeraMenuBase
override void	OnMenuInit ()

override void	OnMenuUpdate (float tDelta)

override void	OnMenuOpen ()

override void	OnMenuOpened ()

override void	OnMenuClose ()

override void	OnMenuFocusGained ()

override void	OnMenuFocusLost ()

override void	OnMenuShow ()

override void	OnMenuHide ()

Static Public Member Functions
static SCR_FieldManualUI	Open (EFieldManualEntryId entryId)
	opens the first entry matching the EFieldManualEntryId enum value

Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase	CurrentChimeraMenu ()

static ChimeraMenuBase	GetOwnerMenu (Widget w)
	Returns parent menu of a widget.

Protected Member Functions
override void	OnMenuOpen ()

override void	OnMenuShow ()

override void	OnMenuClose ()

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	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	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 ()
	determines what happens when ESC is pressed

Static Protected Member Functions
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

SCR_FieldManualConfigEntry	m_CurrentEntry

ButtonWidget	m_wFirstSubCategoryButton

bool	m_bIsInEntryViewMode

bool	m_bIsInSearchMode

bool	m_bOpenedFromOutside

bool	m_bArmaWarning

Protected Attributes inherited from MenuRootBase
MenuRootComponent	m_MenuRootComponent

ref ScriptInvoker	m_EventOnMenuFocusGained

ref ScriptInvoker	m_EventOnMenuFocusLost

ref ScriptInvoker	m_EventOnMenuShow

ref ScriptInvoker	m_EventOnMenuHide

ref ScriptInvoker	m_EventOnMenuItem

ref ScriptInvoker	m_EventOnMenuUpdate

ref ScriptInvoker	m_EventOnMenuOpen

ref ScriptInvoker	m_EventOnMenuInit

ref ScriptInvoker	m_EventOnMenuClose

SCR_ChatPanel	m_ChatPanel

SCR_DynamicFooterComponent	m_DynamicFooter

Protected Attributes inherited from ChimeraMenuBase
bool	m_bTextEditActive = false

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

Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"

static ChimeraMenuBase	m_ThisMenu

Additional Inherited Members
Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker	m_OnTextEditContextChange = new ScriptInvoker

ref ScriptInvoker	m_OnUpdate = new ScriptInvoker

Constructor & Destructor Documentation

◆ SCR_FieldManualUI()

void SCR_FieldManualUI.SCR_FieldManualUI ( )

◆ ~SCR_FieldManualUI()

void SCR_FieldManualUI.~SCR_FieldManualUI ( )

Member Function Documentation

◆ ArrayJoin()

static string SCR_FieldManualUI.ArrayJoin ( notnull array< string > entries )

staticprotected

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

◆ CloseMenuOrReadingPanel()

void SCR_FieldManualUI.CloseMenuOrReadingPanel ( )

protected

determines what happens when ESC is pressed

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

◆ CloseReadingPanel()

void SCR_FieldManualUI.CloseReadingPanel ( )

protected

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

◆ CreateCategoryMenuWidgets()

void SCR_FieldManualUI.CreateCategoryMenuWidgets ( )

protected

Create main categories buttons list.

◆ CreateTileWidget()

Widget SCR_FieldManualUI.CreateTileWidget	(	notnull SCR_FieldManualConfigEntry	entry,
		notnull Widget	parent
	)

protected

creates a tile and sets its image, background & text

◆ FillEntry_Weapon()

void SCR_FieldManualUI.FillEntry_Weapon	(	notnull Widget	widget,
		notnull SCR_FieldManualConfigEntry_Weapon	entry
	)

protected

◆ FillEntry_Weapon_Render()

bool SCR_FieldManualUI.FillEntry_Weapon_Render	(	RenderTargetWidget	renderTarget,
		ResourceName	weaponResourceName
	)

protected

◆ FillEntry_Weapon_Statistics()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics	(	Widget	statsLayout,
		SCR_FieldManualConfigEntry_Weapon	entry
	)

protected

◆ FillEntry_Weapon_Statistics_DefaultSightAdjustment()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_DefaultSightAdjustment	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ FillEntry_Weapon_Statistics_FireModes()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_FireModes	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ FillEntry_Weapon_Statistics_Mass()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_Mass	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ FillEntry_Weapon_Statistics_MuzzleVelocity()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_MuzzleVelocity	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ FillEntry_Weapon_Statistics_RateOfFire()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_RateOfFire	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ FillEntry_Weapon_Statistics_SightAdjustments()

void SCR_FieldManualUI.FillEntry_Weapon_Statistics_SightAdjustments	(	notnull Widget	statsLayout,
		notnull SCR_FieldManualUI_WeaponStatsHelper	weaponStatsHelper
	)

protected

◆ OnMenuClose()

override void SCR_FieldManualUI.OnMenuClose ( )

protected

Implements MenuRootBase.

◆ OnMenuOpen()

override void SCR_FieldManualUI.OnMenuOpen ( )

protected

Implements MenuRootBase.

◆ OnMenuShow()

override void SCR_FieldManualUI.OnMenuShow ( )

protected

Implements MenuRootBase.

◆ OnSubCategoryClicked()

void SCR_FieldManualUI.OnSubCategoryClicked ( Widget w )

Parameters

[in] w

◆ OnTileClicked()

void SCR_FieldManualUI.OnTileClicked ( Widget w )

Parameters

[in] w

◆ Open()

static SCR_FieldManualUI SCR_FieldManualUI.Open ( EFieldManualEntryId entryId )

static

opens the first entry matching the EFieldManualEntryId enum value

◆ OpenEntry()

void SCR_FieldManualUI.OpenEntry ( EFieldManualEntryId entryId )

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

Parameters

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

◆ OpenFirstSubCategory()

void SCR_FieldManualUI.OpenFirstSubCategory ( )

protected

Open the first sub-category, showing its entries.

◆ ProcessSearch()

void SCR_FieldManualUI.ProcessSearch	(	SCR_EditBoxSearchComponent	searchbox,
		string	search
	)

protected

the search process itself - finds entries and set tiles

◆ QueueRefreshCurrentEntry()

void SCR_FieldManualUI.QueueRefreshCurrentEntry ( )

protected

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

◆ RefreshCurrentEntry()

void SCR_FieldManualUI.RefreshCurrentEntry ( )

protected

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

◆ ResetLastSearch()

void SCR_FieldManualUI.ResetLastSearch ( )

protected

resets last search value

◆ SetAllEntriesAndParents()

void SCR_FieldManualUI.SetAllEntriesAndParents ( )

protected

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

◆ SetCurrentEntry()

void SCR_FieldManualUI.SetCurrentEntry ( SCR_FieldManualConfigEntry entry )

protected

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

◆ SetCurrentEntryByWidget()

void SCR_FieldManualUI.SetCurrentEntryByWidget ( Widget widget )

protected

sets the read entry linked from that widget

◆ SetScrollAfterRefresh()

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

protected

◆ SetTiles()

void SCR_FieldManualUI.SetTiles ( array< ref SCR_FieldManualConfigEntry > entries )

protected

sets main Field Manual grid tiles from entries

◆ SetTilesByWidget()

void SCR_FieldManualUI.SetTilesByWidget ( Widget widget )

protected

sets entry tiles from a sub-category's widget

Member Data Documentation

◆ ENTRY_INPUT_REFRESH_DELAY

const int SCR_FieldManualUI.ENTRY_INPUT_REFRESH_DELAY = 500

staticprotected

◆ ENTRY_SCROLL_INPUT_REFRESH_DELAY

const int SCR_FieldManualUI.ENTRY_SCROLL_INPUT_REFRESH_DELAY = 1000 / 60

staticprotected

◆ m_aAllEntries

ref array<ref SCR_FieldManualConfigEntry> SCR_FieldManualUI.m_aAllEntries

protected

◆ m_bArmaWarning

bool SCR_FieldManualUI.m_bArmaWarning

protected

◆ m_bIsInEntryViewMode

bool SCR_FieldManualUI.m_bIsInEntryViewMode

protected

◆ m_bIsInSearchMode

bool SCR_FieldManualUI.m_bIsInSearchMode

protected

◆ m_bOpenedFromOutside

bool SCR_FieldManualUI.m_bOpenedFromOutside

protected

◆ m_BreadCrumbsComponent

SCR_BreadCrumbsComponent SCR_FieldManualUI.m_BreadCrumbsComponent

protected

◆ m_ConfigRoot

ref SCR_FieldManualConfigRoot SCR_FieldManualUI.m_ConfigRoot

protected

◆ m_CurrentEntry

SCR_FieldManualConfigEntry SCR_FieldManualUI.m_CurrentEntry

protected

◆ m_EntryButtonEventHandler

ref SCR_FieldManualEntryScriptedWidgetEventHandler SCR_FieldManualUI.m_EntryButtonEventHandler

protected

◆ m_MenuBtnBack

SCR_InputButtonComponent SCR_FieldManualUI.m_MenuBtnBack

protected

◆ m_MenuSearchbar

SCR_EditBoxSearchComponent SCR_FieldManualUI.m_MenuSearchbar

protected

◆ m_mWidgetEntryMap

ref map<Widget, ref SCR_FieldManualConfigEntry> SCR_FieldManualUI.m_mWidgetEntryMap

protected

◆ m_mWidgetSubCategoryMap

ref map<Widget, ref SCR_FieldManualConfigCategory> SCR_FieldManualUI.m_mWidgetSubCategoryMap

protected

◆ m_sLastSearch

string SCR_FieldManualUI.m_sLastSearch

protected

◆ m_SubCategoryButtonEventHandler

ref SCR_FieldManualSubCategoryScriptedWidgetEventHandler SCR_FieldManualUI.m_SubCategoryButtonEventHandler

protected

◆ m_wFirstSubCategoryButton

ButtonWidget SCR_FieldManualUI.m_wFirstSubCategoryButton

protected

◆ m_wGridScrollLayoutWidget

ScrollLayoutWidget SCR_FieldManualUI.m_wGridScrollLayoutWidget

protected

◆ m_wLastClickedSubCategory

Widget SCR_FieldManualUI.m_wLastClickedSubCategory

protected

◆ m_wMenuCategoryList

VerticalLayoutWidget SCR_FieldManualUI.m_wMenuCategoryList

protected

◆ m_wMenuGridLayout

GridLayoutWidget SCR_FieldManualUI.m_wMenuGridLayout

protected

◆ m_wMenuTitle

TextWidget SCR_FieldManualUI.m_wMenuTitle

protected

◆ m_wPageEntryTitle

TextWidget SCR_FieldManualUI.m_wPageEntryTitle

protected

◆ m_wPageFrame

Widget SCR_FieldManualUI.m_wPageFrame

protected

◆ m_wReadingWidget

Widget SCR_FieldManualUI.m_wReadingWidget

protected

◆ SCROLL_NAME

const string SCR_FieldManualUI.SCROLL_NAME = "mainScroll"

staticprotected

◆ SEARCH_NO_RESULT_KEY

const string SCR_FieldManualUI.SEARCH_NO_RESULT_KEY = "#AR-FieldManual_SearchResult_None"

staticprotected

◆ SEARCH_RESULT_KEY

const string SCR_FieldManualUI.SEARCH_RESULT_KEY = "#AR-FieldManual_SearchResult"

staticprotected

◆ TILES_GRID_WIDTH

const int SCR_FieldManualUI.TILES_GRID_WIDTH = 5

staticprotected

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

Game/UI/Menu/FieldManual/SCR_FieldManualUI.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SCR_FieldManualUI()

◆ ~SCR_FieldManualUI()

Member Function Documentation

◆ ArrayJoin()

◆ CloseMenuOrReadingPanel()

◆ CloseReadingPanel()

◆ CreateCategoryMenuWidgets()

◆ CreateTileWidget()

◆ FillEntry_Weapon()

◆ FillEntry_Weapon_Render()

◆ FillEntry_Weapon_Statistics()

◆ FillEntry_Weapon_Statistics_DefaultSightAdjustment()

◆ FillEntry_Weapon_Statistics_FireModes()

◆ FillEntry_Weapon_Statistics_Mass()

◆ FillEntry_Weapon_Statistics_MuzzleVelocity()

◆ FillEntry_Weapon_Statistics_RateOfFire()

◆ FillEntry_Weapon_Statistics_SightAdjustments()

◆ OnMenuClose()

◆ OnMenuOpen()

◆ OnMenuShow()

◆ OnSubCategoryClicked()

◆ OnTileClicked()

◆ Open()

◆ OpenEntry()

◆ OpenFirstSubCategory()

◆ ProcessSearch()

◆ QueueRefreshCurrentEntry()

◆ RefreshCurrentEntry()

◆ ResetLastSearch()

◆ SetAllEntriesAndParents()

◆ SetCurrentEntry()

◆ SetCurrentEntryByWidget()

◆ SetScrollAfterRefresh()

◆ SetTiles()

◆ SetTilesByWidget()

Member Data Documentation

◆ ENTRY_INPUT_REFRESH_DELAY

◆ ENTRY_SCROLL_INPUT_REFRESH_DELAY

◆ m_aAllEntries

◆ m_bArmaWarning

◆ m_bIsInEntryViewMode

◆ m_bIsInSearchMode

◆ m_bOpenedFromOutside

◆ m_BreadCrumbsComponent

◆ m_ConfigRoot

◆ m_CurrentEntry

◆ m_EntryButtonEventHandler

◆ m_MenuBtnBack

◆ m_MenuSearchbar

◆ m_mWidgetEntryMap

◆ m_mWidgetSubCategoryMap

◆ m_sLastSearch

◆ m_SubCategoryButtonEventHandler

◆ m_wFirstSubCategoryButton

◆ m_wGridScrollLayoutWidget

◆ m_wLastClickedSubCategory

◆ m_wMenuCategoryList

◆ m_wMenuGridLayout

◆ m_wMenuTitle

◆ m_wPageEntryTitle

◆ m_wPageFrame

◆ m_wReadingWidget

◆ SCROLL_NAME

◆ SEARCH_NO_RESULT_KEY

◆ SEARCH_RESULT_KEY

◆ TILES_GRID_WIDTH