@quenty/inputobjectutils 2.0.3-canary.256.edbbcfc.0 → 3.0.0

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [2.0.3-canary.256.edbbcfc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.0.2...@quenty/inputobjectutils@2.0.3-canary.256.edbbcfc.0) (2022-03-27)
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.1.0...@quenty/inputobjectutils@3.0.0) (2022-05-21)
+
+**Note:** Version bump only for package @quenty/inputobjectutils
+
+
+
+
+
+# [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.0.2...@quenty/inputobjectutils@2.1.0) (2022-03-27)
 
 **Note:** Version bump only for package @quenty/inputobjectutils
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2022 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputobjectutils",
-  "version": "2.0.3-canary.256.edbbcfc.0",
+  "version": "3.0.0",
   "description": "Provides utility functions involving input objects",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "edbbcfc38516772a791d50dc43cd6b304ffc4aff"
+  "gitHead": "9f7eaea7543c33c89d2e32c38491b13f9271f4f7"
 }

package/src/Client/InputObjectUtils.lua

@@ -13,11 +13,17 @@ local MOUSE_USER_INPUT_TYPES = {
 	[Enum.UserInputType.MouseMovement] = true;
 }
 
+local MOUSE_BUTTON_USER_INPUT_TYPES = {
+	[Enum.UserInputType.MouseButton1] = true;
+	[Enum.UserInputType.MouseButton2] = true;
+	[Enum.UserInputType.MouseButton3] = true;
+}
+
 --[=[
 	Returns whether a user input type involves the mouse.
 
 	@param userInputType UserInputType
-	@return true
+	@return boolean
 ]=]
 function InputObjectUtils.isMouseUserInputType(userInputType)
 	assert(typeof(userInputType) == "EnumItem", "Bad userInputType")
@@ -25,6 +31,18 @@ function InputObjectUtils.isMouseUserInputType(userInputType)
 	return MOUSE_USER_INPUT_TYPES[userInputType] or false
 end
 
+--[=[
+	Returns whether a user input type is a mouse button specifically.
+
+	@param userInputType UserInputType
+	@return boolean
+]=]
+function InputObjectUtils.isMouseButtonInputType(userInputType)
+	assert(typeof(userInputType) == "EnumItem", "Bad userInputType")
+
+	return MOUSE_BUTTON_USER_INPUT_TYPES[userInputType] or false
+end
+
 --[=[
 	Compares the two input objects and determines if they are the same thing. For example,
 	a finger being dragged across a screen, or a mouse input being used as a cursor.