@quenty/inputmode 3.5.0 → 3.5.1-canary.238.2c4d310.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.5.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputmode@3.5.0...@quenty/inputmode@3.5.1-canary.238.2c4d310.0) (2021-12-29)
+
+**Note:** Version bump only for package @quenty/inputmode
+
+
+
+
+
 # [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputmode@3.4.0...@quenty/inputmode@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/inputmode

package/README.md

@@ -1,10 +1,10 @@
 ## InputMode
 <div align="center">
-  <a href="http://quenty.github.io/api/">
+  <a href="http://quenty.github.io/NevermoreEngine/">
     <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputmode",
-  "version": "3.5.0",
+  "version": "3.5.1-canary.238.2c4d310.0",
   "description": "Trace input mode state and trigger changes correctly",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/maid": "^2.0.1",
-    "@quenty/signal": "^2.0.0",
-    "@quenty/table": "^2.1.0",
-    "@quenty/valueobject": "^3.5.0"
+    "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
+    "@quenty/maid": "2.0.2-canary.238.2c4d310.0",
+    "@quenty/signal": "2.0.1-canary.238.2c4d310.0",
+    "@quenty/table": "2.1.1-canary.238.2c4d310.0",
+    "@quenty/valueobject": "3.5.1-canary.238.2c4d310.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
+  "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
 }

package/src/Client/INPUT_MODES.lua

@@ -1,6 +1,9 @@
---- Holds input states for Keyboard, Mouse, et cetera. Mostly useful for providing UI input hints to the user by
--- identifying the most recent input state provided.
--- @module INPUT_MODES
+--[=[
+	Holds input states for Keyboard, Mouse, et cetera. Mostly useful for providing UI input hints to the user by
+	identifying the most recent input state provided.
+
+	@class INPUT_MODES
+]=]
 
 local UserInputService = game:GetService("UserInputService")
 local GuiService = game:GetService("GuiService")
@@ -15,6 +18,12 @@ local INPUT_MODES = {
 	THUMBSTICK_DEADZONE = 0.14
 }
 
+--[=[
+	Input from a keypad
+	@prop Keypad InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Keypad = InputMode.new("Keypad", {
 	Enum.KeyCode.KeypadZero;
 	Enum.KeyCode.KeypadOne;
@@ -35,6 +44,12 @@ INPUT_MODES.Keypad = InputMode.new("Keypad", {
 	Enum.KeyCode.KeypadEquals;
 })
 
+--[=[
+	Input from a keyboard
+	@prop Keyboard InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Keyboard = InputMode.new("Keyboard", {
 	Enum.UserInputType.Keyboard;
 
@@ -166,6 +181,12 @@ INPUT_MODES.Keyboard = InputMode.new("Keyboard", {
 	Enum.KeyCode.Undo;
 })
 
+--[=[
+	Input involving arrow keys!
+	@prop ArrowKeys InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.ArrowKeys = InputMode.new("ArrowKeys", {
 	Enum.KeyCode.Left;
 	Enum.KeyCode.Right;
@@ -173,6 +194,12 @@ INPUT_MODES.ArrowKeys = InputMode.new("ArrowKeys", {
 	Enum.KeyCode.Down;
 })
 
+--[=[
+	Input involving WASD
+	@prop WASD InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.WASD = InputMode.new("WASD", {
 	Enum.KeyCode.W;
 	Enum.KeyCode.A;
@@ -180,6 +207,12 @@ INPUT_MODES.WASD = InputMode.new("WASD", {
 	Enum.KeyCode.D;
 })
 
+--[=[
+	Input involving the mouse
+	@prop Mouse InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Mouse = InputMode.new("Mouse", {
 	Enum.UserInputType.MouseButton1;
 	Enum.UserInputType.MouseButton2;
@@ -188,15 +221,32 @@ INPUT_MODES.Mouse = InputMode.new("Mouse", {
 	Enum.UserInputType.MouseMovement;
 })
 
+--[=[
+	Input involving the keyboard OR mouse.
+	@prop KeyboardAndMoues InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.KeyboardAndMouse = InputMode.new("KeyboardAndMouse", {
 	INPUT_MODES.Mouse;
 	INPUT_MODES.Keyboard;
 })
 
+--[=[
+	Input involving touch input.
+	@prop Touch InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Touch = InputMode.new("Touch", {
 	Enum.UserInputType.Touch;
 })
 
+--[=[
+	@prop DPad InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.DPad = InputMode.new("DPad", {
 	Enum.KeyCode.DPadLeft;
 	Enum.KeyCode.DPadRight;
@@ -204,11 +254,23 @@ INPUT_MODES.DPad = InputMode.new("DPad", {
 	Enum.KeyCode.DPadDown;
 })
 
+--[=[
+	Input involved thumbsticks.
+	@prop Thumbsticks InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Thumbsticks = InputMode.new("Thumbsticks", {
 	Enum.KeyCode.Thumbstick1;
 	Enum.KeyCode.Thumbstick2;
 })
 
+--[=[
+	Input involving gamepads
+	@prop Gamepads InputMode
+	@readonly
+	@within INPUT_MODES
+]=]
 INPUT_MODES.Gamepads = InputMode.new("Gamepads", {
 	Enum.UserInputType.Gamepad1;
 	Enum.UserInputType.Gamepad2;
@@ -238,7 +300,6 @@ INPUT_MODES.Gamepads = InputMode.new("Gamepads", {
 	Enum.KeyCode.DPadDown;
 })
 
-
 local function triggerEnabled()
 	if UserInputService.MouseEnabled then
 		INPUT_MODES.Mouse:Enable()

package/src/Client/InputMode.lua

@@ -1,14 +1,35 @@
----  Trace input mode state and trigger changes correctly
--- @classmod InputMode
+--[=[
+	Trace input mode state and trigger changes correctly
+	@class InputMode
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 
+--[=[
+	Fires off when the mode is enabled
+	@prop Enabled Signal<()>
+	@within InputMode
+]=]
+
+--[=[
+	Name of the InputMode
+	@prop Name Signal<()>
+	@within InputMode
+]=]
+
 local InputMode = {}
 InputMode.__index = InputMode
 InputMode.ClassName = "InputMode"
 
+--[=[
+	Constructs a new InputMode
+
+	@param name string
+	@param typesAndInputModes { { UserInputType | KeyCode | string | InputMode } }
+	@return InputMode
+]=]
 function InputMode.new(name, typesAndInputModes)
 	local self = setmetatable({}, InputMode)
 
@@ -16,9 +37,6 @@ function InputMode.new(name, typesAndInputModes)
 	self._valid = {}
 
 	self.Name = name or "Unnamed"
-
-	--- Fires off when the mode is enabled
-	-- @signal Enabled
 	self.Enabled = Signal.new()
 
 	self:_addValidTypesFromTable(typesAndInputModes)
@@ -26,6 +44,10 @@ function InputMode.new(name, typesAndInputModes)
 	return self
 end
 
+--[=[
+	Checks the last point this input mode was used.
+	@return number
+]=]
 function InputMode:GetLastEnabledTime()
 	return self._lastEnabled
 end
@@ -48,6 +70,10 @@ function InputMode:_addInputMode(inputMode)
 	end
 end
 
+--[=[
+	Returns all keys defining the input mode.
+	@return { UserInputType | KeyCode | string }
+]=]
 function InputMode:GetKeys()
 	local keys = {}
 	for key, _ in pairs(self._valid) do
@@ -56,21 +82,29 @@ function InputMode:GetKeys()
 	return keys
 end
 
----
--- @param inputType May be a UserInputType or KeyCode
+--[=[
+	Checks the validity of the inputType
+	@param inputType { UserInputType | KeyCode | string }
+	@return boolean
+]=]
 function InputMode:IsValid(inputType)
 	assert(inputType, "Must send in inputType")
 
 	return self._valid[inputType]
 end
 
---- Enables the mode
+--[=[
+	Enables the mode
+]=]
 function InputMode:Enable()
 	self._lastEnabled = tick()
 	self.Enabled:Fire()
 end
 
---- Evaluates the input object, and if it's valid, enables the mode
+--[=[
+	Evaluates the input object, and if it's valid, enables the mode
+	@param inputObject InputObject
+]=]
 function InputMode:Evaluate(inputObject)
 	if self._valid[inputObject.UserInputType]
 		or self._valid[inputObject.KeyCode] then

package/src/Client/InputModeProcessor.lua

@@ -1,26 +1,43 @@
---- Process inputs by evaluating states
--- @classmod InputModeProcessor
+--[=[
+	Process inputs by evaluating inputModes. Typically not used directly, but rather, just
+	use modes from INPUT_MODES.
+
+	@class InputModeProcessor
+]=]
 
 local InputModeProcessor = {}
 InputModeProcessor.__index = InputModeProcessor
 InputModeProcessor.ClassName = InputModeProcessor
 
-function InputModeProcessor.new(states)
+--[=[
+	Construtcs a new inputModeProcessor
+	@param inputModes { InputMode }
+	@return InputModeProcessor
+]=]
+function InputModeProcessor.new(inputModes)
 	local self = setmetatable({}, InputModeProcessor)
 
 	self._inputModes = {}
 
-	for _, state in pairs(states) do
+	for _, state in pairs(inputModes) do
 		self._inputModes[#self._inputModes+1] = state
 	end
 
 	return self
 end
 
+--[=[
+	Gets all input mode inputModes being used
+	@return { InputMode }
+]=]
 function InputModeProcessor:GetStates()
 	return self._inputModes
 end
 
+--[=[
+	Applies the inputObject as an evaluation for the inputm odes
+	@param inputObject InputObject
+]=]
 function InputModeProcessor:Evaluate(inputObject)
 	for _, inputMode in pairs(self._inputModes) do
 		inputMode:Evaluate(inputObject)

package/src/Client/InputModeSelector.lua

@@ -1,6 +1,7 @@
--- Selects the most recent input mode and attempts to
--- identify the best state from it
--- @classmod InputModeSelector
+--[=[
+	Selects the most recent input mode and attempts to identify the best state from it.
+	@class InputModeSelector
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -16,6 +17,11 @@ InputModeSelector.DEFAULT_MODES = {
 	INPUT_MODES.Touch
 }
 
+--[=[
+	Constructs a new InputModeSelector
+	@param inputModes { InputMode }
+	@return InputModeSelector
+]=]
 function InputModeSelector.new(inputModes)
 	local self = setmetatable({}, InputModeSelector)
 
@@ -24,6 +30,11 @@ function InputModeSelector.new(inputModes)
 	self._activeMode = ValueObject.new()
 	self._maid:GiveTask(self._activeMode)
 
+--[=[
+	Event that fires whenever the active mode changes.
+	@prop Changed Signal<InputMode, InputMode> -- newMode, oldMode
+	@within InputModeSelector
+]=]
 	self.Changed = self._activeMode.Changed
 
 	for _, inputMode in pairs(inputModes or InputModeSelector.DEFAULT_MODES) do
@@ -33,10 +44,19 @@ function InputModeSelector.new(inputModes)
 	return self
 end
 
+--[=[
+	Returns the current active mode
+	@return InputMode
+]=]
 function InputModeSelector:GetActiveMode()
 	return rawget(self, "_activeMode").Value
 end
 
+--[=[
+	The current active input mode
+	@prop Value InputMode?
+	@within InputModeSelector
+]=]
 function InputModeSelector:__index(index)
 	if index == "Value" then
 		return rawget(self, "_activeMode").Value
@@ -52,6 +72,12 @@ function InputModeSelector:__index(index)
 	end
 end
 
+--[=[
+	Binds the updateBindFunction to the mode selector
+
+	@param updateBindFunction (newMode: InputMode, modeMaid: Maid) -> ()
+	@return InputModeSelector
+]=]
 function InputModeSelector:Bind(updateBindFunction)
 	local maid = Maid.new()
 	self._maid[updateBindFunction] = maid
@@ -85,8 +111,16 @@ function InputModeSelector:_addInputMode(inputMode)
 	end
 end
 
+--[=[
+	Cleans up the input mode selector.
+
+	:::info
+	This should be called whenever the mode selector is done being used.
+	:::
+]=]
 function InputModeSelector:Destroy()
 	self._maid:DoCleaning()
+	setmetatable(self, nil)
 end
 
 return InputModeSelector