@quenty/inputobjectutils 2.0.1-canary.c3c8cd3.0 → 2.0.2

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [2.0.1-canary.c3c8cd3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.0.0...@quenty/inputobjectutils@2.0.1-canary.c3c8cd3.0) (2021-10-12)
+## [2.0.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.0.1...@quenty/inputobjectutils@2.0.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/inputobjectutils
+
+
+
+
+
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@2.0.0...@quenty/inputobjectutils@2.0.1) (2021-10-13)
 
 
 ### Bug Fixes
 
-* InputObjectRayUtils allows the specification of the camera ([c3c8cd3](https://github.com/Quenty/NevermoreEngine/commit/c3c8cd3fe14e7342315d82f45c53f887be5ce192))
+* InputObjectRayUtils allows the specification of the camera ([4956ef9](https://github.com/Quenty/NevermoreEngine/commit/4956ef91728c9a8f763dab565f56e439981b122f))
 
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 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/README.md

@@ -1,10 +1,10 @@
 ## InputObjectUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </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" />
@@ -13,26 +13,9 @@
 
 Provides utility functions involving input objects
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/InputObjectRayUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/inputobjectutils --save
-```
-
-## InputObjectRayUtils API
-
-### `InputObjectRayUtils.cameraRayFromInputObject(inputObject, distance)`
-
-### `InputObjectRayUtils.cameraRayFromInputObjectWithOffset(inputObject, distance, offset)`
-
-### `InputObjectRayUtils.cameraRayFromScreenPosition(position, distance)`
-
-### `InputObjectRayUtils.cameraRayFromViewportPosition(position, distance)`
-
-### `InputObjectRayUtils.generateCircleRays(ray, count, radius)`
-Generates a circle of rays including the center ray
-
-## InputObjectUtils API
-
-### `InputObjectUtils.isMouseUserInputType(userInputType)`
-
-### `InputObjectUtils.isSameInputObject(inputObject, otherInputObject)`
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputobjectutils",
-  "version": "2.0.1-canary.c3c8cd3.0",
+  "version": "2.0.2",
   "description": "Provides utility functions involving input objects",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c3c8cd3fe14e7342315d82f45c53f887be5ce192"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/InputObjectRayUtils.lua

@@ -1,5 +1,7 @@
---- Utility functions for constructing rays from input objects
--- @module InputObjectRayUtils
+--[=[
+	Utility functions for constructing rays from input objects
+	@class InputObjectRayUtils
+]=]
 
 local Workspace = game:GetService("Workspace")
 
@@ -7,6 +9,14 @@ local DEFAULT_RAY_DISTANCE = 1000
 
 local InputObjectRayUtils = {}
 
+--[=[
+	Computes a camera ray from an inputObject
+	@param inputObject InputObject
+	@param distance number
+	@param offset Vector3? -- Optional
+	@param camera Camera? -- Optional
+	@return Ray
+]=]
 function InputObjectRayUtils.cameraRayFromInputObject(inputObject, distance, offset, camera)
 	assert(inputObject, "Bad inputObject")
 	offset = offset or Vector3.new()
@@ -14,6 +24,14 @@ function InputObjectRayUtils.cameraRayFromInputObject(inputObject, distance, off
 	return InputObjectRayUtils.cameraRayFromScreenPosition(inputObject.Position + offset, distance, camera)
 end
 
+--[=[
+	Computes a camera ray from the mouse
+	@param mouse Mouse
+	@param distance number
+	@param offset Vector3? -- Optional
+	@param camera Camera? -- Optional
+	@return Ray
+]=]
 function InputObjectRayUtils.cameraRayFromMouse(mouse, distance, offset, camera)
 	assert(mouse, "Bad mouse")
 	offset = offset or Vector3.new(0, 0, 0)
@@ -24,6 +42,13 @@ function InputObjectRayUtils.cameraRayFromMouse(mouse, distance, offset, camera)
 		camera)
 end
 
+--[=[
+	@param inputObject InputObject
+	@param distance number? -- Optional
+	@param offset Vector3
+	@param camera Camera? -- Optional
+	@return Ray
+]=]
 function InputObjectRayUtils.cameraRayFromInputObjectWithOffset(inputObject, distance, offset, camera)
 	assert(inputObject, "Bad inputObject")
 
@@ -33,6 +58,12 @@ function InputObjectRayUtils.cameraRayFromInputObjectWithOffset(inputObject, dis
 		camera)
 end
 
+--[=[
+	@param position Vector3
+	@param distance number? -- Optional
+	@param camera Camera? -- Optional
+	@return Ray
+]=]
 function InputObjectRayUtils.cameraRayFromScreenPosition(position, distance, camera)
 	distance = distance or DEFAULT_RAY_DISTANCE
 	camera = camera or Workspace.CurrentCamera
@@ -41,6 +72,12 @@ function InputObjectRayUtils.cameraRayFromScreenPosition(position, distance, cam
 	return Ray.new(baseRay.Origin, baseRay.Direction.unit * distance)
 end
 
+--[=[
+	@param position Vector3
+	@param distance number? -- Optional
+	@param camera Camera? -- Optional
+	@return Ray
+]=]
 function InputObjectRayUtils.cameraRayFromViewportPosition(position, distance, camera)
 	distance = distance or DEFAULT_RAY_DISTANCE
 	camera = camera or Workspace.CurrentCamera
@@ -49,8 +86,13 @@ function InputObjectRayUtils.cameraRayFromViewportPosition(position, distance, c
 	return Ray.new(baseRay.Origin, baseRay.Direction.unit * distance)
 end
 
-
--- Generates a circle of rays including the center ray
+--[=[
+	Generates a circle of rays including the center ray
+	@param ray Ray
+	@param count number
+	@param radius number
+	@return { Ray }
+]=]
 function InputObjectRayUtils.generateCircleRays(ray, count, radius)
 	local rays = { }
 

package/src/Client/InputObjectUtils.lua

@@ -1,5 +1,7 @@
---- Provides utility functions involving input objects
--- @module InputObjectUtils
+--[=[
+	Provides utility functions involving input objects
+	@class InputObjectUtils
+]=]
 
 local InputObjectUtils = {}
 
@@ -11,12 +13,26 @@ local MOUSE_USER_INPUT_TYPES = {
 	[Enum.UserInputType.MouseMovement] = true;
 }
 
+--[=[
+	Returns whether a user input type involves the mouse.
+
+	@param userInputType UserInputType
+	@return true
+]=]
 function InputObjectUtils.isMouseUserInputType(userInputType)
 	assert(typeof(userInputType) == "EnumItem", "Bad userInputType")
 
-	return MOUSE_USER_INPUT_TYPES[userInputType]
+	return MOUSE_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.
+
+	@param inputObject InputObject
+	@param otherInputObject InputObject
+	@return boolean
+]=]
 function InputObjectUtils.isSameInputObject(inputObject, otherInputObject)
 	assert(inputObject, "Bad inputObject")
 	assert(otherInputObject, "Bad otherInputObject")