Arma 3: Modded Keybinding - Revision history

Lou Montana: Add link to DIK KeyCodes and explanatory table

2024-04-03T19:34:02Z

Add link to DIK KeyCodes and explanatory table

← Older revision		Revision as of 21:34, 3 April 2024
Line 141:		Line 141:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
	{{Feature\|warning\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{Link\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}		{{Feature\|warning\|
			If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{Link\|Number#Floating-point Precision}}).
			As such, it is recommended to do the calculation manually and use that value instead.
			}}

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===
Line 152:		Line 155:
	name = "Mod Section"; // Display name of your category.		name = "Mod Section"; // Display name of your category.
	isAddon = 1;		isAddon = 1;
	group[] = {"TAG_MyActionName"}; // List of all actions inside this category.		group[] = { "TAG_MyActionName" }; // List of all actions inside this category.
	};		};
	};		};
Line 165:		Line 168:
	class ActionGroups		class ActionGroups
	{		{
	TAG_MyActionGroup[] = {"TAG_MyActionName"};		TAG_MyActionGroup[] = { "TAG_MyActionName" };
	};		};

Line 171:		Line 174:
	{		{
	// Add your group to an existing collision group:		// Add your group to an existing collision group:
	carMove[] += {"TAG_MyActionGroup"};		carMove[] += { "TAG_MyActionGroup" };

	// Or alternatively add your own collision group (which is usually preferrable):		// Or alternatively add your own collision group (which is usually preferrable):
	TAG_MyActionGroupCollisions[] = {"basic", "vehBasic", "HeadMove", "TAG_MyActionGroup"};		TAG_MyActionGroupCollisions[] = { "basic", "vehBasic", "HeadMove", "TAG_MyActionGroup" };
	};		};
	};		};
Line 197:		Line 200:

	== Additional documentation on key bitflags (CfgDefaultKeysPresets) ==		== Additional documentation on key bitflags (CfgDefaultKeysPresets) ==

			{{Feature\|informative\|
			* See also [[DIK KeyCodes]]
			* The format is as follows (here for {{Controls\|Ctrl\|W}} with a value of {{hl\|487784465}}, hexadecimal {{hl\|0x1D130011}}):
			: {{{!}} class{{=}}"wikitable align-center"
			! Value
			{{!}} 0x
			{{!}} 1D
			{{!}} 13
			{{!}} 00
			{{!}} 11
			{{!}}-
			! Title
			{{!}} hexPrefix
			{{!}} comboKB
			{{!}} deviceType
			{{!}} doubleTapInfo
			{{!}} keyId
			{{!}}-
			! Translated
			{{!}} rowspan{{=}}"2" {{n/a}}
			{{!}} {{hl\|DIK_LCONTROL}}
			{{!}} {{hl\|INPUT_DEVICE_COMBO_KB}} + {{hl\|INPUT_DEVICE_MAIN_KB}}
			{{!}} 0
			{{!}} DIK_W
			{{!}}-
			! Details
			{{!}} combo keyboard key (second key of a combo is always keyboard)
			{{!}} device type of first key (joystick, mouse, KB, ...)<br>or in case of combo, first half secondary combo type, second half main combo type
			{{!}} offset for joysticks or double tap info for keyboard
			{{!}} key/button/axis identification
			{{!}}}
			}}

	<sqf>		<sqf>
	// dik = ~~0xaaBBccDD~~		// dik = 0xAABBCCDD
	// ~~aa = combo KB key (second key of combo always keyboard)~~		// BBCCDD = whole info about first key
	~~// BB = device type of first key (joy, mouse, KB,...) (or in case of combo, first half secondary combo type, second half main combo type)~~		// CCDD = button info (doubleTap or joyID + btnID)
	~~// cc = offset for joys or double tap info for KB~~
	~~// DD = key/button/axis identification~~

	~~// BBccDD~~ = whole info about first key
	// ~~ccDD~~ = button info (doubleTap or joyID + btnID)
	// DD = button local ID		// DD = button local ID
	</sqf>		</sqf>

Lou Montana: Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

2024-02-01T23:25:14Z

Text replacement - "{{Feature|Warning|" to "{{Feature|warning|"

← Older revision		Revision as of 01:25, 2 February 2024
Line 141:		Line 141:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
	{{Feature\|~~Warning~~\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{Link\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}		{{Feature\|warning\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{Link\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===

Lou Montana: Text replacement - "XBox" to "Xbox"

2023-06-20T06:47:23Z

Text replacement - "XBox" to "Xbox"

← Older revision		Revision as of 08:47, 20 June 2023
Line 27:		Line 27:
	#define INPUT_DEVICE_COMBO_JB 0x00500000 // Joystick button		#define INPUT_DEVICE_COMBO_JB 0x00500000 // Joystick button
	#define INPUT_DEVICE_COMBO_JP 0x00600000 // Joystick POV		#define INPUT_DEVICE_COMBO_JP 0x00600000 // Joystick POV
	#define INPUT_DEVICE_COMBO_XI 0x00900000 // ~~XBox~~ controller (XInput)		#define INPUT_DEVICE_COMBO_XI 0x00900000 // Xbox controller (XInput)

	// Main combo types:		// Main combo types:
Line 36:		Line 36:
	#define INPUT_DEVICE_MAIN_JA 0x00050000 // Joystick axis		#define INPUT_DEVICE_MAIN_JA 0x00050000 // Joystick axis
	#define INPUT_DEVICE_MAIN_JP 0x00060000 // Joystick POV		#define INPUT_DEVICE_MAIN_JP 0x00060000 // Joystick POV
	#define INPUT_DEVICE_MAIN_XI 0x00070000 // ~~XBox~~ controller (XInput)		#define INPUT_DEVICE_MAIN_XI 0x00070000 // Xbox controller (XInput)
	#define INPUT_DEVICE_MAIN_TR 0x00080000 // Movement tracking device		#define INPUT_DEVICE_MAIN_TR 0x00080000 // Movement tracking device

Lou Montana: Some wiki formatting

2023-01-30T22:14:01Z

Some wiki formatting

← Older revision		Revision as of 00:14, 31 January 2023
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}

	As of {{GVI\|arma3\|2.06}}, mods are able to define keys that can be bound by the user in the keybindings.		As of {{GVI\|arma3\|2.06}}, mods are able to define keys that can be bound by the user in the keybindings.

Line 64:		Line 63:
	};		};

	#define INPUT_DOUBLE_TAP_OFFSET 0x100 // Offset for double click (used as mask)		#define INPUT_DOUBLE_TAP_OFFSET 0x100 // Offset for double click (used as mask)
	#define MOUSE_CLICK_OFFSET 0x80 // Offset for mouse button click (compared to hold)		#define MOUSE_CLICK_OFFSET 0x80 // Offset for mouse button click (compared to hold)
	</syntaxhighlight>		</syntaxhighlight>

Line 89:		Line 88:
	TRACK_X = 3, // Left / right move		TRACK_X = 3, // Left / right move
	TRACK_Y = 4, // Up / down move		TRACK_Y = 4, // Up / down move
	TRACK_Z = 5 // Forward / backward move		TRACK_Z = 5 // Forward / backward move
	};		};
	</syntaxhighlight>		</syntaxhighlight>
Line 229:		Line 228:
	MOUSE_BUTTONS_LEFT = 0, MOUSE_BUTTONS_MIDDLE = 2		MOUSE_BUTTONS_LEFT = 0, MOUSE_BUTTONS_MIDDLE = 2
	Combined code 0x02310000		Combined code 0x02310000
	Combo key is MOUSE_BUTTONS_MIDDLE (2), combo key device type is INPUT_DEVICE_COMBO_MB (3), main key device is INPUT_DEVICE_MAIN_MB (1), no double tap (00), main key is MOUSE_BUTTONS_LEFT (0)		Combo key is MOUSE_BUTTONS_MIDDLE (2), combo key device type is INPUT_DEVICE_COMBO_MB (3), main key device is INPUT_DEVICE_MAIN_MB (1), no double tap (00), main key is MOUSE_BUTTONS_LEFT (0)


	{{GameCategory\|arma3\|Editing}}		{{GameCategory\|arma3\|Editing}}
	[[Category:Introduced with Arma 3 version 2.06]]		[[Category:Introduced with Arma 3 version 2.06]]

Dedmen: Note about modifierBlocking property

2023-01-11T15:31:55Z

Note about modifierBlocking property

← Older revision		Revision as of 17:31, 11 January 2023
Line 14:		Line 14:
	onAnalog = "['TAG_MyActionName', _this] call TAG_fnc_MyAnalogHandler"; // _this is the scalar analog value.		onAnalog = "['TAG_MyActionName', _this] call TAG_fnc_MyAnalogHandler"; // _this is the scalar analog value.
	analogChangeThreshold = 0.01; // Minimum change required to trigger the onAnalog EH (default: 0.01).		analogChangeThreshold = 0.01; // Minimum change required to trigger the onAnalog EH (default: 0.01).
			modifierBlocking = 1; // Whether this action would block other actions if the assigned key has modifier keys on it. (Since Arma 2.12)
	};		};
	};		};

Lou Montana: Text replacement - "{{HashLink" to "{{Link"

2023-01-04T16:43:45Z

Text replacement - "{{HashLink" to "{{Link"

← Older revision		Revision as of 18:43, 4 January 2023
Line 141:		Line 141:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
	{{Feature\|Warning\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{~~HashLink~~\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}		{{Feature\|Warning\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{Link\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===

Lou Montana: Some wiki formatting

2022-07-27T12:03:34Z

Some wiki formatting

← Older revision		Revision as of 14:03, 27 July 2022
Line 141:		Line 141:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
	{{Feature\|Warning\|If the key code is large enough, for example {{ic\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{HashLink\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}		{{Feature\|Warning\|If the key code is large enough, for example {{hl\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{HashLink\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===
Line 232:		Line 232:

	{{GameCategory\|arma3\|Editing}}		{{GameCategory\|arma3\|Editing}}
	[[Category:Introduced with ~~{{arma3}}~~ version 2.06]]		[[Category:Introduced with Arma 3 version 2.06]]

Lou Montana: Some wiki formatting

2022-05-05T16:39:31Z

Some wiki formatting

← Older revision		Revision as of 18:39, 5 May 2022
Line 17:		Line 17:
	};		};
	</syntaxhighlight>		</syntaxhighlight>


	== Key Combination Enumerations ==		== Key Combination Enumerations ==

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	// Secondary combo types:		// Secondary combo types:
Line 101:		Line 103:
	};		};
	</syntaxhighlight>		</syntaxhighlight>


	== Adding a new key ==		== Adding a new key ==

	=== Defining a new action in CfgUserActions ===		=== Defining a new action in CfgUserActions ===

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	class CfgUserActions		class CfgUserActions
Line 139:		Line 144:

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===

	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
	class UserActionGroups		class UserActionGroups
Line 152:		Line 158:

	=== Setting up a collision group (optional) ===		=== Setting up a collision group (optional) ===

	Class UserActionsConflictGroups provides the ability to configure checks for keybinding collisions. The following example demonstrates how to ensure that the input does not conflict with car movement keybindings:		Class UserActionsConflictGroups provides the ability to configure checks for keybinding collisions. The following example demonstrates how to ensure that the input does not conflict with car movement keybindings:
	<syntaxhighlight lang="cpp">		<syntaxhighlight lang="cpp">
Line 174:		Line 181:

	== Scripted Event Handlers ==		== Scripted Event Handlers ==
	<~~code~~>[[addUserActionEventHandler]] ["ReloadMagazine", "Activate", {
	[[systemChat]] "Reloading!";		<sqf>
	[[removeUserActionEventHandler]] ["ReloadMagazine", "Activate", ~~[[Magic Variables#thisEventHandler\|~~_thisEventHandler]]];		addUserActionEventHandler ["ReloadMagazine", "Activate", {
	}];</~~code~~>		systemChat "Reloading!";
			removeUserActionEventHandler ["ReloadMagazine", "Activate", _thisEventHandler];
			}];
			</sqf>
	The persistence of these EHs is the same as that of [[Arma 3: Mission Event Handlers\|Mission Event Handlers]] - they are scoped per mission and get removed when the mission ends.		The persistence of these EHs is the same as that of [[Arma 3: Mission Event Handlers\|Mission Event Handlers]] - they are scoped per mission and get removed when the mission ends.

Line 187:		Line 197:

	== Additional documentation on key bitflags (CfgDefaultKeysPresets) ==		== Additional documentation on key bitflags (CfgDefaultKeysPresets) ==
	~~<code>{{cc\|dik {{=}} 0xaaBBccDD}}~~
	~~{{cc\|aa {{=}} combo KB key (second key of combo always keyboard)}}~~
	~~{{cc\|BB {{=}} device type of first key (joy, mouse, KB,...) (or in case of combo, first half secondary combo type, second half main combo type)}}~~
	~~{{cc\|cc {{=}} offset for joys or double tap info for KB}}~~
	~~{{cc\|DD {{=}} key/button/axis identification}}~~

	{{cc\|BBccDD {{=}} whole info about first key}}		<sqf>
	~~{{cc\|~~ccDD {{=}} button info (doubleTap or joyID+btnID)}}		// dik = 0xaaBBccDD
	~~{{cc\|~~DD {{=}} button local ID}}</~~code~~>		// aa = combo KB key (second key of combo always keyboard)
			// BB = device type of first key (joy, mouse, KB,...) (or in case of combo, first half secondary combo type, second half main combo type)
			// cc = offset for joys or double tap info for KB
			// DD = key/button/axis identification

			// BBccDD = whole info about first key
			// ccDD = button info (doubleTap or joyID + btnID)
			// DD = button local ID
			</sqf>

	; Example for {{Controls\|A\|2×B}}		; Example for {{Controls\|A\|2×B}}

Lou Montana: Text replacement - "{{KeyboardShortcut" to "{{Controls"

2021-12-20T10:48:19Z

Text replacement - "{{KeyboardShortcut" to "{{Controls"

← Older revision		Revision as of 12:48, 20 December 2021
Line 136:		Line 136:
	};		};
	</syntaxhighlight>		</syntaxhighlight>
	{{Feature\|Warning\|If the key code is large enough, for example {{ic\|0x1D130023}} ({{~~KeyboardShortcut~~\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{HashLink\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}		{{Feature\|Warning\|If the key code is large enough, for example {{ic\|0x1D130023}} ({{Controls\|Ctrl\|H}}), then adding values may lead to a wrong result due to rounding errors (see {{HashLink\|Number#Floating-point Precision}}). As such, it is recommended to do the calculation manually and use that value instead.}}

	=== Adding a keybind to the keybind options dialog ===		=== Adding a keybind to the keybind options dialog ===
Line 197:		Line 197:
	{{cc\|DD {{=}} button local ID}}</code>		{{cc\|DD {{=}} button local ID}}</code>

	; Example for {{~~KeyboardShortcut~~\|A\|2×B}}		; Example for {{Controls\|A\|2×B}}
	DIK_A = 0x1E, DIK_B = 0x30		DIK_A = 0x1E, DIK_B = 0x30
	Combined code = 0x1E130130		Combined code = 0x1E130130
	combo key is DIK_A (1E), combo key device type is INPUT_DEVICE_COMBO_KB (1), main key device type is INPUT_DEVICE_MAIN_KB (3), doubletap (01), main key is IDK_B (30)		combo key is DIK_A (1E), combo key device type is INPUT_DEVICE_COMBO_KB (1), main key device type is INPUT_DEVICE_MAIN_KB (3), doubletap (01), main key is IDK_B (30)

	; Example for {{~~KeyboardShortcut~~\|A\|MMB}}		; Example for {{Controls\|A\|MMB}}
	DIK_A = 0x1E, middle mouse hold = 0x2		DIK_A = 0x1E, middle mouse hold = 0x2
	Combined code 0x1E110002		Combined code 0x1E110002
Line 212:		Line 212:
	Combo key is DIK_A (1E), combo key device type is INPUT_DEVICE_COMBO_KB (1), main key device is INPUT_DEVICE_MAIN_MA (2), no double tap (00), main key is MOUSE_AXIS_RIGHT (1)		Combo key is DIK_A (1E), combo key device type is INPUT_DEVICE_COMBO_KB (1), main key device is INPUT_DEVICE_MAIN_MA (2), no double tap (00), main key is MOUSE_AXIS_RIGHT (1)

	; Example for {{~~KeyboardShortcut~~\|LMB\|MMB}}		; Example for {{Controls\|LMB\|MMB}}
	MOUSE_BUTTONS_LEFT = 0, MOUSE_BUTTONS_MIDDLE = 2		MOUSE_BUTTONS_LEFT = 0, MOUSE_BUTTONS_MIDDLE = 2
	Combined code 0x02310000		Combined code 0x02310000

Dedmen at 12:41, 24 November 2021

2021-11-24T12:41:27Z

← Older revision		Revision as of 14:41, 24 November 2021
Line 146:		Line 146:
	name = "Mod Section"; // Display name of your category.		name = "Mod Section"; // Display name of your category.
	isAddon = 1;		isAddon = 1;
	group[] = {"TAG_MyActionName"};		group[] = {"TAG_MyActionName"}; // List of all actions inside this category.
	};		};
	};		};