@quenty/inputobjectutils 2.1.0 → 3.0.1-canary.38bdfe3.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.1-canary.38bdfe3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@3.0.0...@quenty/inputobjectutils@3.0.1-canary.38bdfe3.0) (2022-09-07)
+
+
+### Features
+
+* Support Vector2 and Vector3 in InputObjectRayUtils ([8843d02](https://github.com/Quenty/NevermoreEngine/commit/8843d02fd1c4e7aa6fee4cbd9cd1cafe076ca7ef))
+
+
+
+
+
+# [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.1.0",
+  "version": "3.0.1-canary.38bdfe3.0",
   "description": "Provides utility functions involving input objects",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "501844bd6c3d3f765fd3032b997d8030bc963a1f"
+  "gitHead": "38bdfe3721bddf1d272628b1104b1d8e0abaf24f"
 }

package/src/Client/InputObjectRayUtils.lua

@@ -13,7 +13,7 @@ local InputObjectRayUtils = {}
 	Computes a camera ray from an inputObject
 	@param inputObject InputObject
 	@param distance number
-	@param offset Vector3? -- Optional
+	@param offset Vector3 | Vector2 | nil -- Optional
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
@@ -21,14 +21,15 @@ function InputObjectRayUtils.cameraRayFromInputObject(inputObject, distance, off
 	assert(inputObject, "Bad inputObject")
 	offset = offset or Vector3.new()
 
-	return InputObjectRayUtils.cameraRayFromScreenPosition(inputObject.Position + offset, distance, camera)
+	local position = inputObject.Position
+	return InputObjectRayUtils.cameraRayFromScreenPosition(Vector2.new(position.x + offset.x, position.y + offset.y), distance, camera)
 end
 
 --[=[
 	Computes a camera ray from the mouse
 	@param mouse Mouse
 	@param distance number
-	@param offset Vector3? -- Optional
+	@param offset Vector3 | Vector2 | nil -- Optional
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
@@ -45,21 +46,22 @@ end
 --[=[
 	@param inputObject InputObject
 	@param distance number? -- Optional
-	@param offset Vector3
+	@param offset Vector3 | Vector2
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
 function InputObjectRayUtils.cameraRayFromInputObjectWithOffset(inputObject, distance, offset, camera)
 	assert(inputObject, "Bad inputObject")
 
+	local position = inputObject.Position
 	return InputObjectRayUtils.cameraRayFromScreenPosition(
-		inputObject.Position + offset,
+		Vector2.new(position.x + offset.x, position.y + offset.y),
 		distance,
 		camera)
 end
 
 --[=[
-	@param position Vector3
+	@param position Vector3 | Vector2
 	@param distance number? -- Optional
 	@param camera Camera? -- Optional
 	@return Ray
@@ -73,7 +75,7 @@ function InputObjectRayUtils.cameraRayFromScreenPosition(position, distance, cam
 end
 
 --[=[
-	@param position Vector3
+	@param position Vector3 | Vector2
 	@param distance number? -- Optional
 	@param camera Camera? -- Optional
 	@return Ray

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.