Inheritance diagram for SCR_SettingsManagerKeybindModule:

Protected 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)
void	GetJoystickPresets (notnull out array< ref SCR_ControllerPreset > joystickPresets)
	Get all preset lists defined for joysticks.
void	SelectControllerPresets (int presetIndex=-1)
void	SelectJoystickPreset (int presetIndex=-1)
void	SelectJoystickPresetPath (string path)
int	GetActivePresetIndex (notnull array< ref SCR_ControllerPreset > presets)

Protected Attributes
const string	GAMEPAD_PRESET_PREFIX = "gamepad:"
const string	PRIMARY_PRESET_PREFIX = ""
ref InputBinding	m_Binding
ref SCR_KeyBindingMenuConfig	m_KeybindConfig
ref SCR_ControllerPresetsConfig	m_ControllerPresetsConfig
ref SCR_ControllerPresetsConfig	m_JoystickPresetsConfig

Static Protected Attributes
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"

Detailed Description

Definition at line 2 of file SCR_SettingsManagerKeybindModule.c.

Constructor & Destructor Documentation

◆ SCR_SettingsManagerKeybindModule()

void SCR_SettingsManagerKeybindModule::SCR_SettingsManagerKeybindModule ( )

inlineprotected

Definition at line 23 of file SCR_SettingsManagerKeybindModule.c.

Member Function Documentation

◆ AddComboToActionByIndex()

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

inlineprotected

Definition at line 205 of file SCR_SettingsManagerKeybindModule.c.

◆ AddKeybindToActionByIndex()

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

inlineprotected

Definition at line 102 of file SCR_SettingsManagerKeybindModule.c.

◆ DeleteActionBindByIndex()

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

inlineprotected

Definition at line 51 of file SCR_SettingsManagerKeybindModule.c.

◆ GetActionBindCount()

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

inlineprotected

Definition at line 36 of file SCR_SettingsManagerKeybindModule.c.

◆ GetActivePresetIndex()

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

inlineprotected

Find index of active preset from provided controller preset list

Parameters

[in] presets

Returns

Definition at line 426 of file SCR_SettingsManagerKeybindModule.c.

◆ GetControllerPresets()

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

inlineprotected

Get all preset lists defined in this module

Parameters

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

Definition at line 319 of file SCR_SettingsManagerKeybindModule.c.

◆ GetCustomBinds()

array< ref SCR_KeyBindingBind > SCR_SettingsManagerKeybindModule::GetCustomBinds ( )

inlineprotected

Definition at line 136 of file SCR_SettingsManagerKeybindModule.c.

◆ GetCustomComboKeys()

array< ref SCR_KeyBindingCombo > SCR_SettingsManagerKeybindModule::GetCustomComboKeys ( )

inlineprotected

Definition at line 145 of file SCR_SettingsManagerKeybindModule.c.

◆ GetFilters()

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

inlineprotected

Definition at line 120 of file SCR_SettingsManagerKeybindModule.c.

◆ GetGamepadPresetPrefix()

string SCR_SettingsManagerKeybindModule::GetGamepadPresetPrefix ( )

inlineprotected

Definition at line 303 of file SCR_SettingsManagerKeybindModule.c.

◆ GetInputBindings()

InputBinding SCR_SettingsManagerKeybindModule::GetInputBindings ( )

inlineprotected

Definition at line 45 of file SCR_SettingsManagerKeybindModule.c.

◆ GetJoystickPresets()

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

inlineprotected

Get all preset lists defined for joysticks.

Definition at line 330 of file SCR_SettingsManagerKeybindModule.c.

◆ GetPrimaryPresetPrefix()

string SCR_SettingsManagerKeybindModule::GetPrimaryPresetPrefix ( )

inlineprotected

Definition at line 309 of file SCR_SettingsManagerKeybindModule.c.

◆ IsActionConflicted()

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

inlineprotected

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

Definition at line 155 of file SCR_SettingsManagerKeybindModule.c.

◆ ResetAction()

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

inlineprotected

Definition at line 223 of file SCR_SettingsManagerKeybindModule.c.

◆ ResetAllActions()

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

inlineprotected

Definition at line 267 of file SCR_SettingsManagerKeybindModule.c.

◆ SelectControllerPresets()

void SCR_SettingsManagerKeybindModule::SelectControllerPresets ( int presetIndex = -1 )

inlineprotected

Combines selected presets and feeds it to SetCustomConfigs

Parameters

[in] presetIndex

Definition at line 339 of file SCR_SettingsManagerKeybindModule.c.

◆ SelectJoystickPreset()

void SCR_SettingsManagerKeybindModule::SelectJoystickPreset ( int presetIndex = -1 )

inlineprotected

Combines selected presets and feeds it to SetCustomConfigs

Parameters

[in] presetIndex

Definition at line 372 of file SCR_SettingsManagerKeybindModule.c.

◆ SelectJoystickPresetPath()

void SCR_SettingsManagerKeybindModule::SelectJoystickPresetPath ( string path )

inlineprotected

Combines selected presets and feeds it to SetCustomConfigs

Parameters

[in] presetIndex

Definition at line 406 of file SCR_SettingsManagerKeybindModule.c.

◆ SetFilterForActionByIndex()

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

inlineprotected

Definition at line 77 of file SCR_SettingsManagerKeybindModule.c.

◆ StartCaptureForAction()

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

inlineprotected

Definition at line 68 of file SCR_SettingsManagerKeybindModule.c.

◆ UnbindAction()

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

inlineprotected

Definition at line 196 of file SCR_SettingsManagerKeybindModule.c.

Member Data Documentation

◆ CONTROLLER_PRESETS_CONFIG

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

staticprotected

Definition at line 17 of file SCR_SettingsManagerKeybindModule.c.

◆ GAMEPAD_PRESET_PREFIX

const string SCR_SettingsManagerKeybindModule::GAMEPAD_PRESET_PREFIX = "gamepad:"

protected

Definition at line 4 of file SCR_SettingsManagerKeybindModule.c.

◆ JOYSTICK_0_PRESETS_CONFIG

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

staticprotected

Definition at line 18 of file SCR_SettingsManagerKeybindModule.c.

◆ JOYSTICK_1_PRESETS_CONFIG

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

staticprotected

Definition at line 19 of file SCR_SettingsManagerKeybindModule.c.

◆ KEY_BINDING_CONFIG

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

staticprotected

Definition at line 16 of file SCR_SettingsManagerKeybindModule.c.

◆ m_Binding

ref InputBinding SCR_SettingsManagerKeybindModule::m_Binding

protected

Definition at line 7 of file SCR_SettingsManagerKeybindModule.c.

◆ m_ControllerPresetsConfig

ref SCR_ControllerPresetsConfig SCR_SettingsManagerKeybindModule::m_ControllerPresetsConfig

protected

Definition at line 13 of file SCR_SettingsManagerKeybindModule.c.

◆ m_JoystickPresetsConfig

ref SCR_ControllerPresetsConfig SCR_SettingsManagerKeybindModule::m_JoystickPresetsConfig

protected

Definition at line 14 of file SCR_SettingsManagerKeybindModule.c.

◆ m_KeybindConfig

ref SCR_KeyBindingMenuConfig SCR_SettingsManagerKeybindModule::m_KeybindConfig

protected

Definition at line 9 of file SCR_SettingsManagerKeybindModule.c.

◆ PRIMARY_PRESET_PREFIX

const string SCR_SettingsManagerKeybindModule::PRIMARY_PRESET_PREFIX = ""

protected

Definition at line 5 of file SCR_SettingsManagerKeybindModule.c.

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

scripts/Game/UI/Menu/SettingsMenu/SCR_SettingsManagerKeybindModule.c

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_SettingsManagerKeybindModule()

Member Function Documentation

◆ AddComboToActionByIndex()

◆ AddKeybindToActionByIndex()

◆ DeleteActionBindByIndex()

◆ GetActionBindCount()

◆ GetActivePresetIndex()

◆ GetControllerPresets()

◆ GetCustomBinds()

◆ GetCustomComboKeys()

◆ GetFilters()

◆ GetGamepadPresetPrefix()

◆ GetInputBindings()

◆ GetJoystickPresets()

◆ GetPrimaryPresetPrefix()

◆ IsActionConflicted()

◆ ResetAction()

◆ ResetAllActions()

◆ SelectControllerPresets()

◆ SelectJoystickPreset()

◆ SelectJoystickPresetPath()

◆ SetFilterForActionByIndex()

◆ StartCaptureForAction()

◆ UnbindAction()

Member Data Documentation

◆ CONTROLLER_PRESETS_CONFIG

◆ GAMEPAD_PRESET_PREFIX

◆ JOYSTICK_0_PRESETS_CONFIG

◆ JOYSTICK_1_PRESETS_CONFIG

◆ KEY_BINDING_CONFIG

◆ m_Binding

◆ m_ControllerPresetsConfig

◆ m_JoystickPresetsConfig

◆ m_KeybindConfig

◆ PRIMARY_PRESET_PREFIX