Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_ContentBrowserEditorUIComponent Interface Reference

The Content Browser Window in the Content Browser Dialog. More...

Inheritance diagram for SCR_ContentBrowserEditorUIComponent:
[legend]

Public Member Functions

void OnCardLMB (Widget assetWidget)
 On Card click.
 
void CloseContentBrowser ()
 Close content browser menu from handler, helper function for e.g.
 
override void ShowEntries (Widget contentWidget, int indexStart, int indexEnd)
 Function called when the page is refreshed.
 
override int GetEntryCount ()
 Return total number of entries.
 
- Public Member Functions inherited from SCR_BasePaginationUIComponent
int GetEntryCount ()
 Return total number of entries.
 
int GetRows ()
 
int GetColumns ()
 
int GetCurrentPage ()
 
int GetEntryIndex (Widget w)
 
ScriptInvoker GetOnPageChanged ()
 
sealed bool SetPage (int page, bool isRefresh=false)
 Set current page.
 
sealed bool RefreshPage ()
 Refresh the current page.
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
- Public Member Functions inherited from MenuRootSubComponent
Widget GetWidget ()
 Get widget to which the component belongs to.
 
MenuRootBase GetMenu ()
 Get menu of which the widget is part of.
 
MenuRootComponent GetRootComponent ()
 Get root component of this subcomponent,.
 
void HandlerAttachedScripted (Widget w)
 Event called when subcomponent is initialized.
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 

Protected Member Functions

void AnimateCardFadeIn (Widget cardWidget)
 
void ToggleBetweenCardsAndFilters ()
 
void SwitchToAssetCards ()
 
void GamepadToggleSelectButtonSwap ()
 
void SwitchToFilters ()
 
void GamePadSwitchToggleSearch ()
 
void GamePadToggleSearch (bool toggle, bool forceToggle=true)
 
void ResetSearch ()
 
void FilterEntries (bool resetPage=true, bool resetSearch=true, bool animateEntries=false)
 
void OnInputDeviceIsGamepadScripted (bool isGamepad)
 
void OnCardHover (Widget card, int prefabIndex, bool hover)
 
void OnCardFocus (Widget card, int prefabIndex, bool focus)
 
void OnSearchFocusChanged (SCR_EditBoxComponent editBoxComponent, EditBoxWidget editBoxWidget, bool focus)
 
void OnSearchConfirmed (SCR_EditBoxComponent editBox, string text)
 
void OnBrowserEntriesFiltered ()
 
void OnMenuClosed ()
 
void OnResetClicked ()
 
void OnShowLoadingCircle (bool state=true)
 
void OnApplyLabelChanges ()
 
void InitializeLabels ()
 
SCR_UIInfo GetHighestOrderedLabelUIInfo (notnull array< EEditableEntityLabel > labels)
 
override bool IsUnique ()
 Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
 
override void OnButtonPrev ()
 
override void OnButtonNext ()
 
override void HandlerAttachedScripted (Widget w)
 Event called when subcomponent is initialized.
 
override void HandlerDeattached (Widget w)
 
- Protected Member Functions inherited from SCR_BasePaginationUIComponent
void DisableArrowsSinglePage ()
 Disable page change button if flag is true and number of pages is 1.
 
void ShowEntries (Widget contentWidget, int indexStart, int indexEnd)
 Function called when the page is refreshed.
 
void IterateIndex (out int row, out int column)
 
void EnablePageButton (Widget w, bool enable)
 
void OnButtonPrev ()
 
void OnButtonNext ()
 
void SetUnderCursor (bool newUnderCursor)
 
void OnInputDeviceIsGamepad (bool isGamepad)
 
override bool IsUnique ()
 Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
 
bool IsUnique ()
 Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
 

Protected Attributes

ref array< ref SCR_ContentBrowserEditorCardm_aCardPrefabs
 
string m_sHeaderWidgetName
 
string m_sNoFilterResultsWidgetName
 
string m_sResetFiltersButtonName
 
string m_sToggleCardFilterButton
 
string m_sToggleSearchButton
 
string m_sActiveFiltersName
 
string m_sSelectCardButtonName
 
string m_sToggleFilterdButtonName
 
string m_sSfxOnOpenDialog
 
Widget m_wFocusedCard
 
int m_iCardFocusIndex
 
bool m_bBudgetPreviewUpdateEnabled
 
bool m_bUsingGamePad
 
bool m_bFocusingAssetCard
 
bool m_bSearchIsToggled
 
bool m_bContentLoadingWidgetActive
 
bool m_bAnimateEntries
 
SCR_InputButtonComponent m_wToggleCardFilterButton
 
Widget m_wToggleSearchButton
 
Widget m_LastSelectedOnSearch
 
Widget m_NoFilterResultsWidget
 
Widget m_SelectCardButton
 
Widget m_ToggleFilterdButton
 
Widget m_ContentLoadingVisual
 
SCR_EditBoxComponent m_SearchEditBox
 
ScrollLayoutWidget m_ScrollLayout
 
ref array< string > m_aLocalizationKeys = {}
 
bool m_bCardSelected
 
- Protected Attributes inherited from SCR_BasePaginationUIComponent
int m_iRows
 
int m_iColumns
 
int m_iMinRows
 
int m_iMinColumns
 
string m_sContentName
 
string m_sButtonPrevName
 
string m_sButtonNextName
 
string m_sButtonPrevName_NoScrolling
 
string m_sButtonNextName_NoScrolling
 
string m_sFocusPrevName
 
string m_sFocusNextName
 
string m_sPageIndexVisualName
 
string m_sPageIndexVisualText
 
bool m_bMustHoverOverContent
 
ref array< ResourceName > m_aEmptyItemLayouts
 
bool m_bLoop
 
bool m_bHideArrowsIfDisabled
 
bool m_bIgnoreGamePadInput
 
bool m_bPlayAudioOnPageChange
 
bool m_bShowEmptyEntries
 
string m_sOnNextPageSfx
 
string m_sOnPrevPageSfx
 
bool m_bDisableArrowsSinglePage
 
int m_iCurrentPage
 
bool m_bUnderCursor
 
Widget m_ContentWidget
 
Widget m_ButtonPrevWidget
 
Widget m_ButtonNextWidget
 
Widget m_FocusPrevWidget
 
Widget m_FocusNextWidget
 
Widget m_ButtonPrevNoScrollWidget
 
Widget m_ButtonNextNoScrollWidget
 
TextWidget m_PageNumberWidget
 
ref ScriptInvoker m_OnPageChanged = new ScriptInvoker()
 
int m_FocusedIndex [2]
 

Detailed Description

The Content Browser Window in the Content Browser Dialog.

Member Function Documentation

◆ AnimateCardFadeIn()

void SCR_ContentBrowserEditorUIComponent.AnimateCardFadeIn ( Widget  cardWidget)
protected

◆ CloseContentBrowser()

void SCR_ContentBrowserEditorUIComponent.CloseContentBrowser ( )

Close content browser menu from handler, helper function for e.g.

autotests

◆ FilterEntries()

void SCR_ContentBrowserEditorUIComponent.FilterEntries ( bool  resetPage = true,
bool  resetSearch = true,
bool  animateEntries = false 
)
protected

◆ GamePadSwitchToggleSearch()

void SCR_ContentBrowserEditorUIComponent.GamePadSwitchToggleSearch ( )
protected

◆ GamePadToggleSearch()

void SCR_ContentBrowserEditorUIComponent.GamePadToggleSearch ( bool  toggle,
bool  forceToggle = true 
)
protected

◆ GamepadToggleSelectButtonSwap()

void SCR_ContentBrowserEditorUIComponent.GamepadToggleSelectButtonSwap ( )
protected

◆ GetEntryCount()

override int SCR_ContentBrowserEditorUIComponent.GetEntryCount ( )

Return total number of entries.

To be overridden by inherited classes.

Returns
Number of entries

Implements SCR_BasePaginationUIComponent.

◆ GetHighestOrderedLabelUIInfo()

SCR_UIInfo SCR_ContentBrowserEditorUIComponent.GetHighestOrderedLabelUIInfo ( notnull array< EEditableEntityLabel >  labels)
protected

◆ HandlerAttachedScripted()

override void SCR_ContentBrowserEditorUIComponent.HandlerAttachedScripted ( Widget  w)
protected

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters
Widget

Implements MenuRootSubComponent.

◆ HandlerDeattached()

override void SCR_ContentBrowserEditorUIComponent.HandlerDeattached ( Widget  w)
protected

◆ InitializeLabels()

void SCR_ContentBrowserEditorUIComponent.InitializeLabels ( )
protected

◆ IsUnique()

override bool SCR_ContentBrowserEditorUIComponent.IsUnique ( )
protected

Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

To be overwritten by inherited classes.

Returns
True if unique

Implements SCR_BasePaginationUIComponent.

◆ OnApplyLabelChanges()

void SCR_ContentBrowserEditorUIComponent.OnApplyLabelChanges ( )
protected

◆ OnBrowserEntriesFiltered()

void SCR_ContentBrowserEditorUIComponent.OnBrowserEntriesFiltered ( )
protected

◆ OnButtonNext()

override void SCR_ContentBrowserEditorUIComponent.OnButtonNext ( )
protected

◆ OnButtonPrev()

override void SCR_ContentBrowserEditorUIComponent.OnButtonPrev ( )
protected

◆ OnCardFocus()

void SCR_ContentBrowserEditorUIComponent.OnCardFocus ( Widget  card,
int  prefabIndex,
bool  focus 
)
protected

◆ OnCardHover()

void SCR_ContentBrowserEditorUIComponent.OnCardHover ( Widget  card,
int  prefabIndex,
bool  hover 
)
protected

◆ OnCardLMB()

void SCR_ContentBrowserEditorUIComponent.OnCardLMB ( Widget  assetWidget)

On Card click.

◆ OnInputDeviceIsGamepadScripted()

void SCR_ContentBrowserEditorUIComponent.OnInputDeviceIsGamepadScripted ( bool  isGamepad)
protected

◆ OnMenuClosed()

void SCR_ContentBrowserEditorUIComponent.OnMenuClosed ( )
protected

◆ OnResetClicked()

void SCR_ContentBrowserEditorUIComponent.OnResetClicked ( )
protected

◆ OnSearchConfirmed()

void SCR_ContentBrowserEditorUIComponent.OnSearchConfirmed ( SCR_EditBoxComponent  editBox,
string  text 
)
protected

◆ OnSearchFocusChanged()

void SCR_ContentBrowserEditorUIComponent.OnSearchFocusChanged ( SCR_EditBoxComponent  editBoxComponent,
EditBoxWidget  editBoxWidget,
bool  focus 
)
protected

◆ OnShowLoadingCircle()

void SCR_ContentBrowserEditorUIComponent.OnShowLoadingCircle ( bool  state = true)
protected

◆ ResetSearch()

void SCR_ContentBrowserEditorUIComponent.ResetSearch ( )
protected

◆ ShowEntries()

override void SCR_ContentBrowserEditorUIComponent.ShowEntries ( Widget  contentWidget,
int  indexStart,
int  indexEnd 
)

Function called when the page is refreshed.

To be overridden by inherited classes.

Parameters
contentWidgetContent widget
indexStartIndex of the first displayed item
indexEndIndex of the last displayed item

Implements SCR_BasePaginationUIComponent.

◆ SwitchToAssetCards()

void SCR_ContentBrowserEditorUIComponent.SwitchToAssetCards ( )
protected

◆ SwitchToFilters()

void SCR_ContentBrowserEditorUIComponent.SwitchToFilters ( )
protected

◆ ToggleBetweenCardsAndFilters()

void SCR_ContentBrowserEditorUIComponent.ToggleBetweenCardsAndFilters ( )
protected

Member Data Documentation

◆ m_aCardPrefabs

ref array<ref SCR_ContentBrowserEditorCard> SCR_ContentBrowserEditorUIComponent.m_aCardPrefabs
protected

◆ m_aLocalizationKeys

ref array<string> SCR_ContentBrowserEditorUIComponent.m_aLocalizationKeys = {}
protected

◆ m_bAnimateEntries

bool SCR_ContentBrowserEditorUIComponent.m_bAnimateEntries
protected

◆ m_bBudgetPreviewUpdateEnabled

bool SCR_ContentBrowserEditorUIComponent.m_bBudgetPreviewUpdateEnabled
protected

◆ m_bCardSelected

bool SCR_ContentBrowserEditorUIComponent.m_bCardSelected
protected

◆ m_bContentLoadingWidgetActive

bool SCR_ContentBrowserEditorUIComponent.m_bContentLoadingWidgetActive
protected

◆ m_bFocusingAssetCard

bool SCR_ContentBrowserEditorUIComponent.m_bFocusingAssetCard
protected

◆ m_bSearchIsToggled

bool SCR_ContentBrowserEditorUIComponent.m_bSearchIsToggled
protected

◆ m_bUsingGamePad

bool SCR_ContentBrowserEditorUIComponent.m_bUsingGamePad
protected

◆ m_ContentLoadingVisual

Widget SCR_ContentBrowserEditorUIComponent.m_ContentLoadingVisual
protected

◆ m_iCardFocusIndex

int SCR_ContentBrowserEditorUIComponent.m_iCardFocusIndex
protected

◆ m_LastSelectedOnSearch

Widget SCR_ContentBrowserEditorUIComponent.m_LastSelectedOnSearch
protected

◆ m_NoFilterResultsWidget

Widget SCR_ContentBrowserEditorUIComponent.m_NoFilterResultsWidget
protected

◆ m_sActiveFiltersName

string SCR_ContentBrowserEditorUIComponent.m_sActiveFiltersName
protected

◆ m_ScrollLayout

ScrollLayoutWidget SCR_ContentBrowserEditorUIComponent.m_ScrollLayout
protected

◆ m_SearchEditBox

SCR_EditBoxComponent SCR_ContentBrowserEditorUIComponent.m_SearchEditBox
protected

◆ m_SelectCardButton

Widget SCR_ContentBrowserEditorUIComponent.m_SelectCardButton
protected

◆ m_sHeaderWidgetName

string SCR_ContentBrowserEditorUIComponent.m_sHeaderWidgetName
protected

◆ m_sNoFilterResultsWidgetName

string SCR_ContentBrowserEditorUIComponent.m_sNoFilterResultsWidgetName
protected

◆ m_sResetFiltersButtonName

string SCR_ContentBrowserEditorUIComponent.m_sResetFiltersButtonName
protected

◆ m_sSelectCardButtonName

string SCR_ContentBrowserEditorUIComponent.m_sSelectCardButtonName
protected

◆ m_sSfxOnOpenDialog

string SCR_ContentBrowserEditorUIComponent.m_sSfxOnOpenDialog
protected

◆ m_sToggleCardFilterButton

string SCR_ContentBrowserEditorUIComponent.m_sToggleCardFilterButton
protected

◆ m_sToggleFilterdButtonName

string SCR_ContentBrowserEditorUIComponent.m_sToggleFilterdButtonName
protected

◆ m_sToggleSearchButton

string SCR_ContentBrowserEditorUIComponent.m_sToggleSearchButton
protected

◆ m_ToggleFilterdButton

Widget SCR_ContentBrowserEditorUIComponent.m_ToggleFilterdButton
protected

◆ m_wFocusedCard

Widget SCR_ContentBrowserEditorUIComponent.m_wFocusedCard
protected

◆ m_wToggleCardFilterButton

SCR_InputButtonComponent SCR_ContentBrowserEditorUIComponent.m_wToggleCardFilterButton
protected

◆ m_wToggleSearchButton

Widget SCR_ContentBrowserEditorUIComponent.m_wToggleSearchButton
protected

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