|
Arma Reforger Script API
|
Public Member Functions | |
| override void | OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index) |
| override void | OnTabShow () |
| override void | OnTabHide () |
| override void | OnTabRemove () |
| override void | OnMenuShow () |
| override void | OnMenuUpdate (float tDelta) |
| Called on each frame. | |
| override void | OnMenuFocusGained () |
| void | PackGetAssetListParams (SCR_ContentBrowser_GetAssetListParams p, bool defaultValues=false) |
| Called from OnPack of a Json API Struct. | |
| void | SetWorkshopItems (array< ref SCR_WorkshopItem > items) |
| Sets the item array on which this tab operates. Only possible in external item array mode. | |
Public Member Functions inherited from SCR_SubMenuBase | |
| void | OnMenuFocusLost () |
| void | OnMenuHide () |
| void | OnTabChange () |
| bool | GetShown () |
| int | GetIndex () |
| ScriptInvokerVoid | GetOnRequestCloseMenu () |
| ScriptInvokerInt2 | GetOnRequestTabChange () |
Public Member Functions inherited from SCR_ScriptedWidgetComponent | |
| override void | HandlerAttached (Widget w) |
| override bool | OnClick (Widget w, int x, int y, int button) |
| Widget | GetRootWidget () |
| bool | IsVisible () |
Protected Member Functions | |
| void | InitWidgets () |
| void | InitWidgetEventHandlers () |
| void | InitWorkshopApi () |
| void | RequestPage (int pageId) |
| void | RequestOnlinePageUnfiltered (int pageId) |
| Requests an unfiltered page from backend to get the total number of items. | |
| void | RequestOnlinePage (int pageId) |
| Requests a filtered page from backend to get the actual items to display. | |
| void | PageRequestCallbackCleanup (SCR_WorkshopApiCallback_RequestPage callback) |
| void | DisplayExternalItems (int pageId) |
| Selects items from the externally provided array and shows them on grid, only makes sense in external array mode. | |
| void | DisplayOfflineItems (int pageId) |
| void | GridScreen_Init () |
| void | GridScreen_Clear () |
| Tiles are cleared up here. They are not deleted, but hidden. | |
| void | GridScreen_DisplayItems (array< ref SCR_WorkshopItem > items) |
| void | SetPanelsMode (bool showEmptyPanel, bool forceFiltersList=false, string messagePresetTag=string.Empty, bool animateFiltersList=false) |
| void | UpdateItemsFoundMessage (int current, int total) |
| SCR_WorkshopItem | GetSelectedItem () |
| Returns currently selected workshop item. | |
| void | UpdatePagingWidgets () |
| Updates the widgets related to paging: buttons, text. | |
| void | UpdateNavigationButtons () |
| bool | IsWidgetUnderCursor (Widget w) |
| Returns true if cursor over a given widget. | |
| array< ref SCR_WorkshopItem > | SelectItemsAtPage (array< ref SCR_WorkshopItem > items, int pageId) |
| Returns array of items within specified page, page ID starting from 0. | |
| void | SwitchFocus (SCR_EListMenuWidgetFocus focus) |
| Switch focus. | |
| void | OnInputDeviceUserChanged (EInputDeviceType oldDevice, EInputDeviceType newDevice) |
| void | OnConnected () |
| void | OnTileClick (SCR_ScriptedWidgetComponent baseComp) |
| void | OnTileFocus (ScriptedWidgetComponent comp) |
| void | OnTileFocusLost (ScriptedWidgetComponent comp) |
| void | OnTileStateChange (ScriptedWidgetComponent comp) |
| void | OnFilterPanelToggled (bool shown) |
| void | OnInputAction (string name, float multiplier) |
| void | OnFilterButton (SCR_ButtonBaseComponent comp) |
| void | OnPrimaryButton (SCR_ButtonBaseComponent comp) |
| void | ExecuteItemPrimaryAction () |
| void | OnEnableButton (SCR_ButtonBaseComponent comp) |
| void | SetItemEnabled () |
| void | OnFavouriteButton (SCR_ButtonBaseComponent comp) |
| void | SetItemFavorite () |
| void | OnDetailsButton (SCR_ButtonBaseComponent comp) |
| void | OpenItemDetails () |
| void | Callback_OnRequestPageGetAllAssets (SCR_WorkshopApiCallback_RequestPage callback) |
| void | Callback_OnRequestPageGetAssets (SCR_WorkshopApiCallback_RequestPage callback) |
| void | Callback_OnRequestPageTimeout (SCR_WorkshopApiCallback_RequestPage callback) |
| void | Callback_OnRequestPageTimeout_OnCloseDialog () |
| void | Callback_OnRequestPageTimeout_OnDialogTryAgain () |
| void | Callback_OnAddonOfflineStateChanged (SCR_WorkshopItem item, bool newState) |
| Called by SCR_AddonManager when some addon is downloaded or uninstalled. | |
| void | Callback_OnAddonReportedStateChanged (SCR_WorkshopItem item, bool newReported) |
| Called by SCR_AddonManager when some addon is reported or unreported. | |
| void | OnPrevPageButton () |
| void | OnNextPageButton () |
| void | OnScrollPage (string name) |
| void | OnMouseWheelSoundCooldownEnd () |
| void | OnFilterChange (SCR_FilterEntry filter) |
| Called when filter listbox selection changes. | |
| void | OnFilterSearchConfirm (SCR_EditBoxComponent comp, string newValue) |
| Called when user confirms the value in the seacrh string. | |
| void | OnSortingHeaderChange (SCR_SortHeaderComponent sortHeader) |
| Called when sorting header changes. | |
| array< ref SCR_WorkshopItem > | SearchItems (array< ref SCR_WorkshopItem > items, string searchStr) |
| array< ref SCR_WorkshopItem > | Filter_OfflineFilterAndSearch (array< ref SCR_WorkshopItem > itemsIn) |
| Filters the array according to currently selected filters. | |
| array< ref SCR_WorkshopItem > | Filter_IntersectArrays (array< ref array< ref SCR_WorkshopItem > > arrays) |
| Returns intersection of all arrays (array of elements which are contained in all arrays) | |
| void | PackSortingData (SCR_ContentBrowser_GetAssetListParams params) |
| Pack filter sorting settings - order type, dirrection. | |
| void | PackQuickFilterData (SCR_ContentBrowser_GetAssetListParams params, bool defaultValues) |
| void | PackTagFilterData (SCR_ContentBrowser_GetAssetListParams params, bool defaultValues) |
Protected Member Functions inherited from SCR_SubMenuBase | |
| void | ShowNavigationButtons (bool show) |
| void | FlagNavigationButtonVisibility (SCR_InputButtonComponent button, bool show) |
| void | SetNavigationButtonVisibile (SCR_InputButtonComponent button, bool show, bool animate=false) |
| SCR_InputButtonComponent | CreateNavigationButton (string actionName, string label, bool rightFooter=false, bool show=true) |
| void | RequestCloseMenu () |
| void | RequestTabChange (int newTabIndex) |
Static Protected Attributes | |
| const int | GRID_N_COLUMNS = 4 |
| const int | GRID_N_ROWS = 3 |
| const int | LOAD_PAGE_DELAY = 500 |
| const ResourceName | LAYOUT_GRID_TILE = "{67B0EFBDF7EAFF27}UI/layouts/Menus/ContentBrowser/Tile/WorkshopTile.layout" |
| const string | TEXT_PAGE_INDICATOR = "#AR-Editor_ContentBrowser_PageIndex_Text" |
| const string | MESSAGE_TAG_NOTHING_FOUND = "nothing_found" |
| const string | MESSAGE_TAG_NOTHING_DOWNLOADED = "nothing_downloaded" |
| const string | MESSAGE_TAG_NOTHING_DOWNLOADED_2 = "nothing_downloaded2" |
| const string | MESSAGE_TAG_ERROR_CONNECTION = "error_connection" |
| const string | MESSAGE_TAG_LOADING = "loading" |
| const string | MESSAGE_TAG_NO_SAVES_FOUND = "no_saves_found" |
| const int | MOUSE_WHEEL_SOUND_COOLDOWN = 75 |
Additional Inherited Members | |
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent | |
| static SCR_ScriptedWidgetComponent | GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true) |
| Base method for component lookup through the widget library. | |
Public Attributes inherited from SCR_ScriptedWidgetComponent | |
| ref ScriptInvoker | m_OnClick = new ScriptInvoker |
|
protected |
Called by SCR_AddonManager when some addon is downloaded or uninstalled.
|
protected |
Called by SCR_AddonManager when some addon is reported or unreported.
|
protected |
|
protected |
Implemented in SCR_ContentBrowser_SavesSubMenu.
|
protected |
|
protected |
|
protected |
|
protected |
Selects items from the externally provided array and shows them on grid, only makes sense in external array mode.
|
protected |
Implemented in SCR_ContentBrowser_AddonsFilteredSubMenu.
|
protected |
|
protected |
Returns intersection of all arrays (array of elements which are contained in all arrays)
|
protected |
Filters the array according to currently selected filters.
!! Works only for offline configuration of filters!
|
protected |
Returns currently selected workshop item.
|
protected |
Tiles are cleared up here. They are not deleted, but hidden.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Implemented in SCR_ContentBrowser_SavesSubMenu.
|
protected |
Returns true if cursor over a given widget.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Called when filter listbox selection changes.
|
protected |
|
protected |
Called when user confirms the value in the seacrh string.
|
protected |
|
protected |
| override void SCR_ContentBrowser_AddonsSubMenu.OnMenuFocusGained | ( | ) |
Implements SCR_SubMenuBase.
| override void SCR_ContentBrowser_AddonsSubMenu.OnMenuShow | ( | ) |
Implements SCR_SubMenuBase.
| override void SCR_ContentBrowser_AddonsSubMenu.OnMenuUpdate | ( | float | tDelta | ) |
Called on each frame.
Implements SCR_SubMenuBase.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Called when sorting header changes.
| override void SCR_ContentBrowser_AddonsSubMenu.OnTabCreate | ( | Widget | menuRoot, |
| ResourceName | buttonsLayout, | ||
| int | index ) |
Implements SCR_SubMenuBase.
| override void SCR_ContentBrowser_AddonsSubMenu.OnTabHide | ( | ) |
Implements SCR_SubMenuBase.
| override void SCR_ContentBrowser_AddonsSubMenu.OnTabRemove | ( | ) |
Implements SCR_SubMenuBase.
| override void SCR_ContentBrowser_AddonsSubMenu.OnTabShow | ( | ) |
Implements SCR_SubMenuBase.
|
protected |
Implemented in SCR_ContentBrowser_SavesSubMenu.
|
protected |
|
protected |
|
protected |
|
protected |
| void SCR_ContentBrowser_AddonsSubMenu.PackGetAssetListParams | ( | SCR_ContentBrowser_GetAssetListParams | p, |
| bool | defaultValues = false ) |
Called from OnPack of a Json API Struct.
Here we pack the request data according to current filtering and sorging parameters.
Implemented in SCR_MANW_ContentBrowser_AddonsSubMenu.
|
protected |
|
protected |
Pack filter sorting settings - order type, dirrection.
|
protected |
Implemented in SCR_ContentBrowser_SavesSubMenu, and SCR_MANW_ContentBrowser_AddonsSubMenu.
|
protected |
|
protected |
Requests a filtered page from backend to get the actual items to display.
Implemented in SCR_ContentBrowser_AddonsFilteredSubMenu, and SCR_ContentBrowser_SavesSubMenu.
|
protected |
Requests an unfiltered page from backend to get the total number of items.
|
protected |
|
protected |
|
protected |
Returns array of items within specified page, page ID starting from 0.
|
protected |
|
protected |
|
protected |
| void SCR_ContentBrowser_AddonsSubMenu.SetWorkshopItems | ( | array< ref SCR_WorkshopItem > | items | ) |
Sets the item array on which this tab operates. Only possible in external item array mode.
|
protected |
Switch focus.
|
protected |
|
protected |
|
protected |
Updates the widgets related to paging: buttons, text.
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |