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

Component for addons presets submenu behavior. More...

Inheritance diagram for SCR_AddonsPresetsSubMenuComponent:
[legend]

Public Member Functions

override void OnMenuFocusGained ()
 
override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
override void OnTabShow ()
 
override void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
- Public Member Functions inherited from SCR_SubMenuBase
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuUpdate (float tDelta)
 
void OnTabCreate (Widget menuRoot, ResourceName buttonsLayout, int index)
 
void OnTabShow ()
 
void OnTabHide ()
 
void OnTabRemove ()
 
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 UpdatePresetListbox ()
 Display list of current addon presets.
 
bool HasAllPresetAddons (SCR_AddonLinePresetComponent line)
 Return true if all mods are available offline.
 
bool CanCreatePreset (SCR_WorkshopAddonPreset preset)
 Show error if preset can't be created.
 
bool IsPresetAddonsListEmpty (SCR_WorkshopAddonPreset preset)
 Show no mods enabled error is no mods is selected for preset.
 
bool IsAddonsListEmpty (array< ref SCR_WorkshopItem > items)
 Show no mods enabled error is no mods is selected for preset.
 
bool IsNameValid (string name)
 Show invalid name error dialog.
 
void OnUsedPresetChanged (string name)
 
bool IsNameUnique (SCR_WorkshopAddonPreset preset, string name)
 Show override dialog if name is reapeted in addon preset list.
 
void CreateNewPreset ()
 Create new preset with curent mods.
 
void Callback_OnNameNewPreset (SCR_AddonLinePresetComponent line, string name)
 
void Callback_OnNewPresetFocusLost (SCR_AddonLinePresetComponent line)
 
void SetupLineCreationState (SCR_AddonLinePresetComponent line)
 
void ClearLineCreationState (SCR_AddonLinePresetComponent line)
 
void SetExistingLinesEnabled (bool enabled)
 
void LoadPreset (SCR_AddonLinePresetComponent line)
 Activate mods of given preset.
 
void OverridePreset (SCR_AddonLinePresetComponent line)
 Change mod setup of given preset.
 
void Callback_OnConfirmOverride (SCR_WorkshopPresetConfirmDialog dlg)
 
void DeletePreset (SCR_AddonLinePresetComponent line)
 Delete given preset.
 
void Callback_OnConfirmDelete (SCR_WorkshopPresetConfirmDialog dlg)
 
void RenamePreset (SCR_AddonLinePresetComponent line, string name)
 Change name of given preset.
 
void OnNameEditStart (SCR_AddonLinePresetComponent line)
 
void OnLineFocus (SCR_AddonLinePresetComponent line)
 
void OnLineButtonClick (SCR_AddonLinePresetComponent line)
 Call this when any inner buttons is clicked.
 
SCR_AddonLinePresetComponent FocusedPresetLine ()
 Return addon preset line component of currently focused widget if has any.
 
void OnNewPresetFocus ()
 
void OnNewPresetFocusLost ()
 
void OnLoadButton ()
 
void OnOverrideButton ()
 
void OnRenameButton ()
 
void OnDeleteButton ()
 
void SetToFocusPreset (SCR_AddonLinePresetComponent line, bool maintainIndex=false)
 
void HandleFocus ()
 
- 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)
 

Protected Attributes

ref SCR_AddonsPresetSubMenuWidgets m_Widgets = new SCR_AddonsPresetSubMenuWidgets()
 
ref array< ref SCR_WorkshopAddonPresetm_aPresets = {}
 
int m_iToFocusPreset
 
ref array< SCR_AddonLinePresetComponentm_aPresetLines = {}
 
ref SCR_WorkshopAddonPreset m_InteractivePreset
 
SCR_ListBoxElementComponent m_CreatedElement
 
SCR_WorkshopAddonPreset m_CreatedPreset
 
SCR_InputButtonComponent m_NavLoad
 
SCR_InputButtonComponent m_NavOverride
 
SCR_InputButtonComponent m_NavDelete
 
SCR_InputButtonComponent m_NavRename
 
string m_sNameOverride
 
- Protected Attributes inherited from SCR_SubMenuBase
ResourceName m_sNavigationButtonLayout
 
SCR_DynamicFooterComponent m_DynamicFooter
 
ref array< SCR_InputButtonComponentm_aNavigationButtons = {}
 
ref map< SCR_InputButtonComponent, bool > m_aNavigationButtonsVisibilityFlags = new map<SCR_InputButtonComponent, bool>()
 
Widget m_wMenuRoot
 
int m_iIndex
 
bool m_bShown
 
bool m_bFocused
 
ref ScriptInvokerVoid m_OnRequestCloseMenu
 
ref ScriptInvokerInt2 m_OnRequestTabChange
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

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
 

Detailed Description

Component for addons presets submenu behavior.

Player can display, save, override and delete mod presets (setups). This component can be use later on in addons manager tool dialog.

Member Function Documentation

◆ Callback_OnConfirmDelete()

void SCR_AddonsPresetsSubMenuComponent.Callback_OnConfirmDelete ( SCR_WorkshopPresetConfirmDialog  dlg)
protected

◆ Callback_OnConfirmOverride()

void SCR_AddonsPresetsSubMenuComponent.Callback_OnConfirmOverride ( SCR_WorkshopPresetConfirmDialog  dlg)
protected

◆ Callback_OnNameNewPreset()

void SCR_AddonsPresetsSubMenuComponent.Callback_OnNameNewPreset ( SCR_AddonLinePresetComponent  line,
string  name 
)
protected

◆ Callback_OnNewPresetFocusLost()

void SCR_AddonsPresetsSubMenuComponent.Callback_OnNewPresetFocusLost ( SCR_AddonLinePresetComponent  line)
protected

◆ CanCreatePreset()

bool SCR_AddonsPresetsSubMenuComponent.CanCreatePreset ( SCR_WorkshopAddonPreset  preset)
protected

Show error if preset can't be created.

◆ ClearLineCreationState()

void SCR_AddonsPresetsSubMenuComponent.ClearLineCreationState ( SCR_AddonLinePresetComponent  line)
protected

◆ CreateNewPreset()

void SCR_AddonsPresetsSubMenuComponent.CreateNewPreset ( )
protected

Create new preset with curent mods.

◆ DeletePreset()

void SCR_AddonsPresetsSubMenuComponent.DeletePreset ( SCR_AddonLinePresetComponent  line)
protected

Delete given preset.

◆ FocusedPresetLine()

SCR_AddonLinePresetComponent SCR_AddonsPresetsSubMenuComponent.FocusedPresetLine ( )
protected

Return addon preset line component of currently focused widget if has any.

◆ HandleFocus()

void SCR_AddonsPresetsSubMenuComponent.HandleFocus ( )
protected

◆ HandlerAttached()

override void SCR_AddonsPresetsSubMenuComponent.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_AddonsPresetsSubMenuComponent.HandlerDeattached ( Widget  w)

◆ HasAllPresetAddons()

bool SCR_AddonsPresetsSubMenuComponent.HasAllPresetAddons ( SCR_AddonLinePresetComponent  line)
protected

Return true if all mods are available offline.

◆ IsAddonsListEmpty()

bool SCR_AddonsPresetsSubMenuComponent.IsAddonsListEmpty ( array< ref SCR_WorkshopItem items)
protected

Show no mods enabled error is no mods is selected for preset.

◆ IsNameUnique()

bool SCR_AddonsPresetsSubMenuComponent.IsNameUnique ( SCR_WorkshopAddonPreset  preset,
string  name 
)
protected

Show override dialog if name is reapeted in addon preset list.

◆ IsNameValid()

bool SCR_AddonsPresetsSubMenuComponent.IsNameValid ( string  name)
protected

Show invalid name error dialog.

◆ IsPresetAddonsListEmpty()

bool SCR_AddonsPresetsSubMenuComponent.IsPresetAddonsListEmpty ( SCR_WorkshopAddonPreset  preset)
protected

Show no mods enabled error is no mods is selected for preset.

◆ LoadPreset()

void SCR_AddonsPresetsSubMenuComponent.LoadPreset ( SCR_AddonLinePresetComponent  line)
protected

Activate mods of given preset.

◆ OnDeleteButton()

void SCR_AddonsPresetsSubMenuComponent.OnDeleteButton ( )
protected

◆ OnLineButtonClick()

void SCR_AddonsPresetsSubMenuComponent.OnLineButtonClick ( SCR_AddonLinePresetComponent  line)
protected

Call this when any inner buttons is clicked.

◆ OnLineFocus()

void SCR_AddonsPresetsSubMenuComponent.OnLineFocus ( SCR_AddonLinePresetComponent  line)
protected

◆ OnLoadButton()

void SCR_AddonsPresetsSubMenuComponent.OnLoadButton ( )
protected

◆ OnMenuFocusGained()

override void SCR_AddonsPresetsSubMenuComponent.OnMenuFocusGained ( )

Implements SCR_SubMenuBase.

◆ OnNameEditStart()

void SCR_AddonsPresetsSubMenuComponent.OnNameEditStart ( SCR_AddonLinePresetComponent  line)
protected

◆ OnNewPresetFocus()

void SCR_AddonsPresetsSubMenuComponent.OnNewPresetFocus ( )
protected

◆ OnNewPresetFocusLost()

void SCR_AddonsPresetsSubMenuComponent.OnNewPresetFocusLost ( )
protected

◆ OnOverrideButton()

void SCR_AddonsPresetsSubMenuComponent.OnOverrideButton ( )
protected

◆ OnRenameButton()

void SCR_AddonsPresetsSubMenuComponent.OnRenameButton ( )
protected

◆ OnTabCreate()

override void SCR_AddonsPresetsSubMenuComponent.OnTabCreate ( Widget  menuRoot,
ResourceName  buttonsLayout,
int  index 
)

Implements SCR_SubMenuBase.

◆ OnTabShow()

override void SCR_AddonsPresetsSubMenuComponent.OnTabShow ( )

Implements SCR_SubMenuBase.

◆ OnUsedPresetChanged()

void SCR_AddonsPresetsSubMenuComponent.OnUsedPresetChanged ( string  name)
protected

◆ OverridePreset()

void SCR_AddonsPresetsSubMenuComponent.OverridePreset ( SCR_AddonLinePresetComponent  line)
protected

Change mod setup of given preset.

◆ RenamePreset()

void SCR_AddonsPresetsSubMenuComponent.RenamePreset ( SCR_AddonLinePresetComponent  line,
string  name 
)
protected

Change name of given preset.

◆ SetExistingLinesEnabled()

void SCR_AddonsPresetsSubMenuComponent.SetExistingLinesEnabled ( bool  enabled)
protected

◆ SetToFocusPreset()

void SCR_AddonsPresetsSubMenuComponent.SetToFocusPreset ( SCR_AddonLinePresetComponent  line,
bool  maintainIndex = false 
)
protected

◆ SetupLineCreationState()

void SCR_AddonsPresetsSubMenuComponent.SetupLineCreationState ( SCR_AddonLinePresetComponent  line)
protected

◆ UpdatePresetListbox()

void SCR_AddonsPresetsSubMenuComponent.UpdatePresetListbox ( )
protected

Display list of current addon presets.

Member Data Documentation

◆ m_aPresetLines

ref array<SCR_AddonLinePresetComponent> SCR_AddonsPresetsSubMenuComponent.m_aPresetLines = {}
protected

◆ m_aPresets

ref array<ref SCR_WorkshopAddonPreset> SCR_AddonsPresetsSubMenuComponent.m_aPresets = {}
protected

◆ m_CreatedElement

SCR_ListBoxElementComponent SCR_AddonsPresetsSubMenuComponent.m_CreatedElement
protected

◆ m_CreatedPreset

SCR_WorkshopAddonPreset SCR_AddonsPresetsSubMenuComponent.m_CreatedPreset
protected

◆ m_InteractivePreset

ref SCR_WorkshopAddonPreset SCR_AddonsPresetsSubMenuComponent.m_InteractivePreset
protected

◆ m_iToFocusPreset

int SCR_AddonsPresetsSubMenuComponent.m_iToFocusPreset
protected

◆ m_NavDelete

SCR_InputButtonComponent SCR_AddonsPresetsSubMenuComponent.m_NavDelete
protected

◆ m_NavLoad

SCR_InputButtonComponent SCR_AddonsPresetsSubMenuComponent.m_NavLoad
protected

◆ m_NavOverride

SCR_InputButtonComponent SCR_AddonsPresetsSubMenuComponent.m_NavOverride
protected

◆ m_NavRename

SCR_InputButtonComponent SCR_AddonsPresetsSubMenuComponent.m_NavRename
protected

◆ m_sNameOverride

string SCR_AddonsPresetsSubMenuComponent.m_sNameOverride
protected

◆ m_Widgets

ref SCR_AddonsPresetSubMenuWidgets SCR_AddonsPresetsSubMenuComponent.m_Widgets = new SCR_AddonsPresetSubMenuWidgets()
protected

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