Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_AdvancedKeybindDialogUI Interface Reference
Inheritance diagram for SCR_AdvancedKeybindDialogUI:
[legend]

Public Member Functions

override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
void SCR_AdvancedKeybindDialogUI (SCR_KeyBindingEntry entry, string displayName, string actionName, string actionPreset, SCR_EActionPrefixType prefixType)
 
- Public Member Functions inherited from SCR_ConfigurableDialogUi
Widget GetRootWidget ()
 
OverlayWidget GetDialogBaseOverlay ()
 Returns the base dialog overlay (the rectangle covered by the background). Useful for dialog wide darkening (e.g. by SCR_LoadingOverlay)
 
Widget GetContentLayoutRoot ()
 Returns the root of the content layout.
 
SCR_ConfigurableDialogUiPreset GetDialogPreset ()
 
void Close ()
 
void SetTitle (string text)
 
void SetMessage (string text)
 
void SetMessageColor (Color color)
 
TextWidget GetMessageWidget ()
 
string GetMessageStr ()
 
void SetTitleIcon (ResourceName image, string imageName)
 Set title icons with custom image.
 
void SetIconColor (Color color)
 Set title icons with custom image.
 
void SetStyle (EConfigurableDialogStyle type)
 Sets colors based on style.
 
void BindButtonConfirm (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnConfirm (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonCancel (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnCancel (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonGeneric (SCR_InputButtonComponent button, string tag=string.Empty)
 Allows to register a custom button to call OnButtonPressed (i.e. one not in the conf files but placed by hand in the layout). An empty tag will result in the widget's name being used instead.
 
SCR_InputButtonComponent FindButton (string tag)
 Returns a button with given tag.
 
string GetButtonTag (SCR_InputButtonComponent button)
 Returns a button's tag.
 
void OnMenuUpdate (float tDelta)
 
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuClose ()
 

Protected Member Functions

void ReselectRow ()
 
void ShowBindsForAction ()
 
void ShowBindsForCurrentAction ()
 
void SetSelectedKeybind (notnull SCR_ModularButtonComponent modularButtonComp)
 
void ResetBindings ()
 
void DeleteSelectedBind ()
 
void StartCapturingKeybind ()
 
void UnbindAction ()
 
void SetupCaptureButton ()
 
void SetupPrefixesCombo ()
 
void SetupBindsCombo ()
 
void SetupCombinationCombo ()
 
void OnPrefixesComboChanged (SCR_ComboBoxComponent component, int index)
 
void OnBindsComboChanged (SCR_ComboBoxComponent component, int index)
 
void OnCombinationComboChanged (SCR_ComboBoxComponent component, int index)
 
void OnSelectButton (SCR_InputButtonComponent button, string action)
 
void OnKeybindRowClick (notnull SCR_ModularButtonComponent modularButtonComp)
 
void OnKeybindRowFocus (SCR_ModularButtonComponent comp)
 
void OnKeybindRowFocusLost (SCR_ModularButtonComponent comp)
 
- Protected Member Functions inherited from SCR_KeybindDialogBase
void Setup (SCR_KeyBindingEntry entry, string displayName, string actionName, EInputDeviceType device)
 
- Protected Member Functions inherited from SCR_ConfigurableDialogUi
void OnConfirm ()
 
void OnCancel ()
 
void OnButtonPressed (SCR_InputButtonComponent button)
 
void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
void Init (Widget root, SCR_ConfigurableDialogUiPreset preset, MenuBase proxyMenu)
 
void InitWidgets ()
 
SCR_InputButtonComponent CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)
 
void Internal_Close ()
 
void InitAttributedVariables ()
 Verifies that all attributed variables are set up.
 

Protected Attributes

SCR_InputButtonComponent m_Select
 
string m_sActionPreset
 
SCR_EActionPrefixType m_eActionPrefixType
 
int m_iSelectedKeybind
 
SCR_ModularButtonComponent m_FocusedBindRowButton
 
ref array< SCR_ModularButtonComponentm_aBindRowButtons = {}
 
Widget m_wPrefixesCombo
 
- Protected Attributes inherited from SCR_KeybindDialogBase
SCR_KeyBindingEntry m_Entry
 
string m_sActionName
 
string m_sDisplayName
 
EInputDeviceType m_eDevice
 
SCR_SettingsManagerKeybindModule m_SettingsKeybindModule
 
- Protected Attributes inherited from SCR_ConfigurableDialogUi
float m_fFadeInTime
 
ResourceName m_sNavigationButtonLayout
 
string m_sWidgetNameButtonsLeft
 
string m_sWidgetNameButtonsRight
 
string m_sWidgetNameButtonsCenter
 
ImageWidget m_wImgTopLine
 
ImageWidget m_wImgTitleIcon
 
TextWidget m_wTitle
 
TextWidget m_wMessage
 
VerticalLayoutWidget m_wContentVerticalLayout
 
ref map< string, SCR_InputButtonComponentm_aButtonComponents = new map<string, SCR_InputButtonComponent>
 
Widget m_wRoot
 
OverlayWidget m_wDialogBase
 
SCR_DynamicFooterComponent m_DynamicFooter
 
MenuBase m_ProxyMenu
 
ref SCR_ConfigurableDialogUiPreset m_DialogPreset
 
string m_sLastPressedButtonTag
 
bool m_bIsClosing
 

Static Protected Attributes

const ResourceName KEYBIND_ROW_LAYOUT_PATH = "{25888355688EE402}UI/layouts/Menus/SettingsMenu/BindingMenu/AdvancedKeybindActionRow.layout"
 
- Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi m_CurrentDialog
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateFromPreset (ResourceName presetsResourceName, string tag, SCR_ConfigurableDialogUi customDialogObj=null)
 Creates a dialog from preset.
 
static SCR_ConfigurableDialogUi GetCurrentDialog ()
 
static string GetCurrentDialogTag ()
 
static bool IsPresetValid (ResourceName presetsResourceName, string tag)
 
- Public Attributes inherited from SCR_ConfigurableDialogUi
ref ScriptInvoker m_OnConfirm = new ScriptInvoker()
 
ref ScriptInvoker m_OnCancel = new ScriptInvoker()
 
ref ScriptInvoker m_OnClose = new ScriptInvoker()
 
ref ScriptInvoker m_OnCloseStart = new ScriptInvoker()
 
ref ScriptInvoker m_OnButtonPressed = new ScriptInvoker()
 
- Static Public Attributes inherited from SCR_ConfigurableDialogUi
static const ResourceName NAVIGATION_BUTTON_LAYOUT = "{87037226B1A2064B}UI/layouts/WidgetLibrary/Buttons/WLib_NavigationButtonSuperSmall.layout"
 
static const string BUTTON_CONFIRM = "confirm"
 
static const string BUTTON_CANCEL = "cancel"
 
- Static Protected Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateByPreset (SCR_ConfigurableDialogUiPreset preset, SCR_ConfigurableDialogUi customDialogObj=null)
 
static Widget GetContentWidget (Widget baseWidget)
 Returns the container in which to place the content layout. Container must be called ContentLayoutContainer.
 

Constructor & Destructor Documentation

◆ SCR_AdvancedKeybindDialogUI()

void SCR_AdvancedKeybindDialogUI.SCR_AdvancedKeybindDialogUI ( SCR_KeyBindingEntry  entry,
string  displayName,
string  actionName,
string  actionPreset,
SCR_EActionPrefixType  prefixType 
)

Member Function Documentation

◆ DeleteSelectedBind()

void SCR_AdvancedKeybindDialogUI.DeleteSelectedBind ( )
protected

◆ OnBindsComboChanged()

void SCR_AdvancedKeybindDialogUI.OnBindsComboChanged ( SCR_ComboBoxComponent  component,
int  index 
)
protected

◆ OnCombinationComboChanged()

void SCR_AdvancedKeybindDialogUI.OnCombinationComboChanged ( SCR_ComboBoxComponent  component,
int  index 
)
protected

◆ OnKeybindRowClick()

void SCR_AdvancedKeybindDialogUI.OnKeybindRowClick ( notnull SCR_ModularButtonComponent  modularButtonComp)
protected

◆ OnKeybindRowFocus()

void SCR_AdvancedKeybindDialogUI.OnKeybindRowFocus ( SCR_ModularButtonComponent  comp)
protected

◆ OnKeybindRowFocusLost()

void SCR_AdvancedKeybindDialogUI.OnKeybindRowFocusLost ( SCR_ModularButtonComponent  comp)
protected

◆ OnMenuOpen()

override void SCR_AdvancedKeybindDialogUI.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset)

Called last of all, after all the initialization of main element done.

Here you can perform custom initialization.

Implements SCR_ConfigurableDialogUi.

◆ OnPrefixesComboChanged()

void SCR_AdvancedKeybindDialogUI.OnPrefixesComboChanged ( SCR_ComboBoxComponent  component,
int  index 
)
protected

◆ OnSelectButton()

void SCR_AdvancedKeybindDialogUI.OnSelectButton ( SCR_InputButtonComponent  button,
string  action 
)
protected

◆ ReselectRow()

void SCR_AdvancedKeybindDialogUI.ReselectRow ( )
protected

◆ ResetBindings()

void SCR_AdvancedKeybindDialogUI.ResetBindings ( )
protected

◆ SetSelectedKeybind()

void SCR_AdvancedKeybindDialogUI.SetSelectedKeybind ( notnull SCR_ModularButtonComponent  modularButtonComp)
protected

◆ SetupBindsCombo()

void SCR_AdvancedKeybindDialogUI.SetupBindsCombo ( )
protected

◆ SetupCaptureButton()

void SCR_AdvancedKeybindDialogUI.SetupCaptureButton ( )
protected

◆ SetupCombinationCombo()

void SCR_AdvancedKeybindDialogUI.SetupCombinationCombo ( )
protected

◆ SetupPrefixesCombo()

void SCR_AdvancedKeybindDialogUI.SetupPrefixesCombo ( )
protected

◆ ShowBindsForAction()

void SCR_AdvancedKeybindDialogUI.ShowBindsForAction ( )
protected

◆ ShowBindsForCurrentAction()

void SCR_AdvancedKeybindDialogUI.ShowBindsForCurrentAction ( )
protected

◆ StartCapturingKeybind()

void SCR_AdvancedKeybindDialogUI.StartCapturingKeybind ( )
protected

◆ UnbindAction()

void SCR_AdvancedKeybindDialogUI.UnbindAction ( )
protected

Member Data Documentation

◆ KEYBIND_ROW_LAYOUT_PATH

const ResourceName SCR_AdvancedKeybindDialogUI.KEYBIND_ROW_LAYOUT_PATH = "{25888355688EE402}UI/layouts/Menus/SettingsMenu/BindingMenu/AdvancedKeybindActionRow.layout"
staticprotected

◆ m_aBindRowButtons

ref array<SCR_ModularButtonComponent> SCR_AdvancedKeybindDialogUI.m_aBindRowButtons = {}
protected

◆ m_eActionPrefixType

SCR_EActionPrefixType SCR_AdvancedKeybindDialogUI.m_eActionPrefixType
protected

◆ m_FocusedBindRowButton

SCR_ModularButtonComponent SCR_AdvancedKeybindDialogUI.m_FocusedBindRowButton
protected

◆ m_iSelectedKeybind

int SCR_AdvancedKeybindDialogUI.m_iSelectedKeybind
protected

◆ m_sActionPreset

string SCR_AdvancedKeybindDialogUI.m_sActionPreset
protected

◆ m_Select

SCR_InputButtonComponent SCR_AdvancedKeybindDialogUI.m_Select
protected

◆ m_wPrefixesCombo

Widget SCR_AdvancedKeybindDialogUI.m_wPrefixesCombo
protected

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