@quenty/inputkeymaputils 7.4.1 → 7.5.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputkeymaputils@7.4.1...@quenty/inputkeymaputils@7.5.0) (2022-11-08)
+
+
+### Features
+
+* Add InputChordUtils ([4418e7b](https://github.com/Quenty/NevermoreEngine/commit/4418e7b5542429708ed4559d3b5e0f83dc4a5c5a))
+
+
+
+
+
 ## [7.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputkeymaputils@7.4.0...@quenty/inputkeymaputils@7.4.1) (2022-11-04)
 
 **Note:** Version bump only for package @quenty/inputkeymaputils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputkeymaputils",
-  "version": "7.4.1",
+  "version": "7.5.0",
   "description": "System to define rebindable key bindings and inputs for Roblox.",
   "keywords": [
     "Roblox",
@@ -29,6 +29,7 @@
     "@quenty/baseobject": "^6.0.1",
     "@quenty/brio": "^8.1.1",
     "@quenty/clienttranslator": "^8.3.1",
+    "@quenty/enumutils": "^3.0.0",
     "@quenty/inputmode": "^7.2.1",
     "@quenty/loader": "^6.0.1",
     "@quenty/maid": "^2.4.0",
@@ -45,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8b9877c26a3fc753409a5114e56717837291279d"
+  "gitHead": "3432599d8ed7bf7f0436d7cd5495925543450117"
 }

package/src/Shared/InputKeyMap.lua

@@ -9,39 +9,23 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local HttpService = game:GetService("HttpService")
-
 local BaseObject = require("BaseObject")
 local ValueObject = require("ValueObject")
 local InputModeType = require("InputModeType")
-local Set = require("Set")
-
-local function convertValuesToJSONIfNeeded(list)
-	local result = {}
-	for key, value in pairs(list) do
-		if type(value) == "table" then
-			result[key] = HttpService:JSONEncode(value)
-		else
-			result[key] = value
-		end
-	end
-	return result
-end
-
-local function areInputTypesListsEquivalent(a, b)
-	-- allocate, hehe
-	local setA = Set.fromTableValue(convertValuesToJSONIfNeeded(a))
-	local setB = Set.fromTableValue(convertValuesToJSONIfNeeded(b))
-
-	local remaining = Set.difference(setA, setB)
-	local left = Set.toList(remaining)
-	return #left == 0
-end
+local InputTypeUtils = require("InputTypeUtils")
 
 local InputKeyMap = setmetatable({}, BaseObject)
 InputKeyMap.ClassName = "InputKeyMap"
 InputKeyMap.__index = InputKeyMap
 
+--[=[
+	Constructs a new InputKeyMap. Generally this would be sent immediately to an
+	[InputKeyMapList]. This holds a list of key bindings for a specific type.
+
+	@param inputModeType InputModeType
+	@param inputTypes { InputType }
+	@return InputKeyMap
+]=]
 function InputKeyMap.new(inputModeType, inputTypes)
 	assert(InputModeType.isInputModeType(inputModeType), "Bad inputModeType")
 	assert(type(inputTypes) == "table" or inputTypes == nil, "Bad inputTypes")
@@ -65,35 +49,67 @@ function InputKeyMap:GetInputModeType()
 	return self._inputModeType
 end
 
+--[=[
+	Sets the input types list for this input key map.
+
+	@param inputTypes { InputType }
+]=]
 function InputKeyMap:SetInputTypesList(inputTypes)
 	assert(type(inputTypes) == "table", "Bad inputTypes")
 
 	self._inputType.Value = inputTypes
 end
 
+--[=[
+	Sets the default input types list. This is whatever the game has, which is
+	different than whatever the user has set.
+
+	This will also set the current input type to be the same as the default if they
+	are equivalent.
+
+	@param inputTypes { InputType }
+]=]
 function InputKeyMap:SetDefaultInputTypesList(inputTypes)
 	assert(type(inputTypes) == "table", "Bad inputTypes")
 	assert(type(self._defaultInputTypes) == "table", "bad self._defaultInputTypes")
 
-	if areInputTypesListsEquivalent(self._inputType.Value, self._defaultInputTypes) then
+	if InputTypeUtils.areInputTypesListsEquivalent(self._inputType.Value, self._defaultInputTypes) then
 		self._inputType.Value = inputTypes
 	end
 
 	self._defaultInputTypes = inputTypes
 end
 
+--[=[
+	Gets the default input types list
+
+	@return { InputType }
+]=]
 function InputKeyMap:GetDefaultInputTypesList()
 	return self._defaultInputTypes
 end
 
+--[=[
+	Resets the input type to the default input types.
+]=]
 function InputKeyMap:RestoreDefault()
 	self._inputType.Value = self._defaultInputTypes
 end
 
+--[=[
+	Observes the current list for the input key map list.
+
+	@return Observable<{ InputType }>
+]=]
 function InputKeyMap:ObserveInputTypesList()
 	return self._inputType:Observe()
 end
 
+--[=[
+	Gets the input types list
+
+	@return { InputType }
+]=]
 function InputKeyMap:GetInputTypesList()
 	return self._inputType.Value
 end

package/src/Shared/Types/InputChordUtils.lua

@@ -0,0 +1,47 @@
+--[=[
+	Standardized data type to define an input chord, such as Ctrl+Z.
+
+	@class InputChordUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local EnumUtils = require("EnumUtils")
+
+local InputChordUtils = {}
+
+--[=[
+	Checks
+	@param data any
+	@return boolean
+]=]
+function InputChordUtils.isModifierInputChord(data)
+	return type(data) == "table"
+		and data.type == "ModifierInputChord"
+		and type(data.modifiers) == "table"
+		and EnumUtils.isOfType(Enum.KeyCode, data.keyCode)
+end
+
+--[=[
+	Creates a modifier input chord. This chord specifically separates the
+	order such that the event only triggers when the keyCode is pressed, but
+	also requires the modifier key to be down at the trigger point.
+
+	This mirrors the existing modifier standards for Windows.
+
+	@param modifiers { KeyCode }
+	@param keyCode KeyCode
+	@return ModifierInputChord
+]=]
+function InputChordUtils.createModifierInputChord(modifiers, keyCode)
+	assert(type(modifiers) == "table", "Bad modifiers")
+	assert(EnumUtils.isOfType(Enum.KeyCode, keyCode), "Bad keyCode")
+
+	return {
+		type = "ModifierInputChord";
+		modifiers = modifiers;
+		keyCode = keyCode;
+	}
+end
+
+return InputChordUtils

package/src/Shared/Types/InputTypeUtils.lua

@@ -4,7 +4,10 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local HttpService = game:GetService("HttpService")
+
 local SlottedTouchButtonUtils = require("SlottedTouchButtonUtils")
+local Set = require("Set")
 
 local InputTypeUtils = {}
 
@@ -84,4 +87,33 @@ function InputTypeUtils.getUniqueKeyForInputType(inputType)
 	end
 end
 
+local function convertValuesToJSONIfNeeded(list)
+	local result = {}
+	for key, value in pairs(list) do
+		if type(value) == "table" then
+			result[key] = HttpService:JSONEncode(value)
+		else
+			result[key] = value
+		end
+	end
+	return result
+end
+
+--[=[
+	Expensive comparison check to see if InputTypes are the same or not.
+
+	@param a { InputType }
+	@param b { InputType }
+	@return boolean
+]=]
+function InputTypeUtils.areInputTypesListsEquivalent(a, b)
+	-- allocate, hehe
+	local setA = Set.fromTableValue(convertValuesToJSONIfNeeded(a))
+	local setB = Set.fromTableValue(convertValuesToJSONIfNeeded(b))
+
+	local remaining = Set.difference(setA, setB)
+	local left = Set.toList(remaining)
+	return #left == 0
+end
+
 return InputTypeUtils