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

Public Member Functions

void SCR_SettingsManagerKeybindModule ()
 
int GetActionBindCount (string actionName, string actionPreset=string.Empty, EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
InputBinding GetInputBindings ()
 
void DeleteActionBindByIndex (string actionName, int keybindIndex, string actionPreset="", EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
void StartCaptureForAction (string actionName, string actionPreset, EInputDeviceType device=EInputDeviceType.KEYBOARD, bool append=false)
 
void SetFilterForActionByIndex (string actionName, string actionPreset, int filterIndex, int keybindIndex, SCR_EActionPrefixType prefixType, EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
void AddKeybindToActionByIndex (string actionName, string preset, int bindIndex, string filterName=string.Empty)
 
array< ref SCR_KeyBindingFilter > GetFilters (SCR_EActionPrefixType filterType)
 
array< ref SCR_KeyBindingBind > GetCustomBinds ()
 
array< ref SCR_KeyBindingCombo > GetCustomComboKeys ()
 
bool IsActionConflicted (string actionName, notnull out array< SCR_KeyBindingEntry > confirmedConflicts, int bindIndex, string preset=string.Empty)
 returns false if the action has no conflicts (no other action in keybind settings with same bind), otherwise returns those actions in confirmedConflicts
 
void UnbindAction (string actionName, string preset="", EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
void AddComboToActionByIndex (string actionName, string preset, int comboIndex, int keybindIndex, string filterName=string.Empty, int comboPosition=0)
 
void ResetAction (string actionName, string preset="", EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
void ResetAllActions (EInputDeviceType device=EInputDeviceType.KEYBOARD)
 
string GetGamepadPresetPrefix ()
 
string GetPrimaryPresetPrefix ()
 
void GetControllerPresets (notnull out array< ref SCR_ControllerPreset > controllerPresets)
 Get all preset lists defined in this module.
 
void GetJoystickPresets (notnull out array< ref SCR_ControllerPreset > joystickPresets)
 Get all preset lists defined for joysticks.
 
void SelectControllerPresets (int presetIndex=-1)
 Combines selected presets and feeds it to SetCustomConfigs.
 
void SelectJoystickPreset (int presetIndex=-1)
 Combines selected presets and feeds it to SetCustomConfigs.
 
void SelectJoystickPresetPath (string path)
 Combines selected presets and feeds it to SetCustomConfigs.
 
int GetActivePresetIndex (notnull array< ref SCR_ControllerPreset > presets)
 Find index of active preset from provided controller preset list.
 
- Public Member Functions inherited from SCR_SettingsManagerModuleBase
ESettingManagerModuleType GetModuleType ()
 
void SetModuleType (ESettingManagerModuleType managerType)
 
void SCR_SettingsManagerModuleBase ()
 

Protected Attributes

ref InputBinding m_Binding
 
ref SCR_KeyBindingMenuConfig m_KeybindConfig
 
ref SCR_ControllerPresetsConfig m_ControllerPresetsConfig
 
ref SCR_ControllerPresetsConfig m_JoystickPresetsConfig
 
- Protected Attributes inherited from SCR_SettingsManagerModuleBase
ESettingManagerModuleType m_eModuleType
 

Static Protected Attributes

const string GAMEPAD_PRESET_PREFIX = "gamepad:"
 
const string PRIMARY_PRESET_PREFIX = ""
 
static const ResourceName KEY_BINDING_CONFIG = "{4EE7794C9A3F11EF}Configs/System/keyBindingMenu.conf"
 
static const ResourceName CONTROLLER_PRESETS_CONFIG = "{27780DD27C5E97CF}Configs/System/ControlSchemes/Gamepad/ControllerPresets.conf"
 
static const ResourceName JOYSTICK_0_PRESETS_CONFIG = "{2823E147630F55BF}Configs/System/ControlSchemes/Joystick/Joystick0Presets.conf"
 
static const ResourceName JOYSTICK_1_PRESETS_CONFIG = "{810AEDDD191484A0}Configs/System/ControlSchemes/Joystick/Joystick1Presets.conf"
 

Constructor & Destructor Documentation

◆ SCR_SettingsManagerKeybindModule()

void SCR_SettingsManagerKeybindModule.SCR_SettingsManagerKeybindModule ( )

Member Function Documentation

◆ AddComboToActionByIndex()

void SCR_SettingsManagerKeybindModule.AddComboToActionByIndex ( string actionName,
string preset,
int comboIndex,
int keybindIndex,
string filterName = string::Empty,
int comboPosition = 0 )

◆ AddKeybindToActionByIndex()

void SCR_SettingsManagerKeybindModule.AddKeybindToActionByIndex ( string actionName,
string preset,
int bindIndex,
string filterName = string::Empty )

◆ DeleteActionBindByIndex()

void SCR_SettingsManagerKeybindModule.DeleteActionBindByIndex ( string actionName,
int keybindIndex,
string actionPreset = "",
EInputDeviceType device = EInputDeviceType::KEYBOARD )

◆ GetActionBindCount()

int SCR_SettingsManagerKeybindModule.GetActionBindCount ( string actionName,
string actionPreset = string::Empty,
EInputDeviceType device = EInputDeviceType::KEYBOARD )

◆ GetActivePresetIndex()

int SCR_SettingsManagerKeybindModule.GetActivePresetIndex ( notnull array< ref SCR_ControllerPreset > presets)

Find index of active preset from provided controller preset list.

Parameters
[in]presets
Returns

◆ GetControllerPresets()

void SCR_SettingsManagerKeybindModule.GetControllerPresets ( notnull out array< ref SCR_ControllerPreset > controllerPresets)

Get all preset lists defined in this module.

Parameters
[out]controllerPresets
[out]joystick0Presets
[out]joystick1Presets

◆ GetCustomBinds()

array< ref SCR_KeyBindingBind > SCR_SettingsManagerKeybindModule.GetCustomBinds ( )

◆ GetCustomComboKeys()

array< ref SCR_KeyBindingCombo > SCR_SettingsManagerKeybindModule.GetCustomComboKeys ( )

◆ GetFilters()

array< ref SCR_KeyBindingFilter > SCR_SettingsManagerKeybindModule.GetFilters ( SCR_EActionPrefixType filterType)

◆ GetGamepadPresetPrefix()

string SCR_SettingsManagerKeybindModule.GetGamepadPresetPrefix ( )

◆ GetInputBindings()

InputBinding SCR_SettingsManagerKeybindModule.GetInputBindings ( )

◆ GetJoystickPresets()

void SCR_SettingsManagerKeybindModule.GetJoystickPresets ( notnull out array< ref SCR_ControllerPreset > joystickPresets)

Get all preset lists defined for joysticks.

◆ GetPrimaryPresetPrefix()

string SCR_SettingsManagerKeybindModule.GetPrimaryPresetPrefix ( )

◆ IsActionConflicted()

bool SCR_SettingsManagerKeybindModule.IsActionConflicted ( string actionName,
notnull out array< SCR_KeyBindingEntry > confirmedConflicts,
int bindIndex,
string preset = string::Empty )

returns false if the action has no conflicts (no other action in keybind settings with same bind), otherwise returns those actions in confirmedConflicts

◆ ResetAction()

void SCR_SettingsManagerKeybindModule.ResetAction ( string actionName,
string preset = "",
EInputDeviceType device = EInputDeviceType::KEYBOARD )

◆ ResetAllActions()

void SCR_SettingsManagerKeybindModule.ResetAllActions ( EInputDeviceType device = EInputDeviceType::KEYBOARD)

◆ SelectControllerPresets()

void SCR_SettingsManagerKeybindModule.SelectControllerPresets ( int presetIndex = -1)

Combines selected presets and feeds it to SetCustomConfigs.

Parameters
[in]presetIndex

◆ SelectJoystickPreset()

void SCR_SettingsManagerKeybindModule.SelectJoystickPreset ( int presetIndex = -1)

Combines selected presets and feeds it to SetCustomConfigs.

Parameters
[in]presetIndex

◆ SelectJoystickPresetPath()

void SCR_SettingsManagerKeybindModule.SelectJoystickPresetPath ( string path)

Combines selected presets and feeds it to SetCustomConfigs.

Parameters
[in]presetIndex

◆ SetFilterForActionByIndex()

void SCR_SettingsManagerKeybindModule.SetFilterForActionByIndex ( string actionName,
string actionPreset,
int filterIndex,
int keybindIndex,
SCR_EActionPrefixType prefixType,
EInputDeviceType device = EInputDeviceType::KEYBOARD )

◆ StartCaptureForAction()

void SCR_SettingsManagerKeybindModule.StartCaptureForAction ( string actionName,
string actionPreset,
EInputDeviceType device = EInputDeviceType::KEYBOARD,
bool append = false )

◆ UnbindAction()

void SCR_SettingsManagerKeybindModule.UnbindAction ( string actionName,
string preset = "",
EInputDeviceType device = EInputDeviceType::KEYBOARD )

Member Data Documentation

◆ CONTROLLER_PRESETS_CONFIG

const ResourceName SCR_SettingsManagerKeybindModule.CONTROLLER_PRESETS_CONFIG = "{27780DD27C5E97CF}Configs/System/ControlSchemes/Gamepad/ControllerPresets.conf"
staticprotected

◆ GAMEPAD_PRESET_PREFIX

const string SCR_SettingsManagerKeybindModule.GAMEPAD_PRESET_PREFIX = "gamepad:"
staticprotected

◆ JOYSTICK_0_PRESETS_CONFIG

const ResourceName SCR_SettingsManagerKeybindModule.JOYSTICK_0_PRESETS_CONFIG = "{2823E147630F55BF}Configs/System/ControlSchemes/Joystick/Joystick0Presets.conf"
staticprotected

◆ JOYSTICK_1_PRESETS_CONFIG

const ResourceName SCR_SettingsManagerKeybindModule.JOYSTICK_1_PRESETS_CONFIG = "{810AEDDD191484A0}Configs/System/ControlSchemes/Joystick/Joystick1Presets.conf"
staticprotected

◆ KEY_BINDING_CONFIG

const ResourceName SCR_SettingsManagerKeybindModule.KEY_BINDING_CONFIG = "{4EE7794C9A3F11EF}Configs/System/keyBindingMenu.conf"
staticprotected

◆ m_Binding

ref InputBinding SCR_SettingsManagerKeybindModule.m_Binding
protected

◆ m_ControllerPresetsConfig

ref SCR_ControllerPresetsConfig SCR_SettingsManagerKeybindModule.m_ControllerPresetsConfig
protected

◆ m_JoystickPresetsConfig

ref SCR_ControllerPresetsConfig SCR_SettingsManagerKeybindModule.m_JoystickPresetsConfig
protected

◆ m_KeybindConfig

ref SCR_KeyBindingMenuConfig SCR_SettingsManagerKeybindModule.m_KeybindConfig
protected

◆ PRIMARY_PRESET_PREFIX

const string SCR_SettingsManagerKeybindModule.PRIMARY_PRESET_PREFIX = ""
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.13.2