@quenty/inputobjectutils 4.18.0 → 4.18.1

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.
 
+## [4.18.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@4.18.0...@quenty/inputobjectutils@4.18.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [4.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@4.17.2...@quenty/inputobjectutils@4.18.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/inputobjectutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputobjectutils",
-  "version": "4.18.0",
+  "version": "4.18.1",
   "description": "Provides utility functions involving input objects",
   "keywords": [
     "Roblox",
@@ -28,11 +28,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxsignal": "^7.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/rxsignal": "^7.17.1"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Client/InputObjectRayUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions for constructing rays from input objects
 	@class InputObjectRayUtils
@@ -17,12 +18,22 @@ local InputObjectRayUtils = {}
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
-function InputObjectRayUtils.cameraRayFromInputObject(inputObject, distance, offset, camera)
+function InputObjectRayUtils.cameraRayFromInputObject(
+	inputObject: InputObject,
+	distance: number,
+	offset: (Vector3 | Vector2)?,
+	camera: Camera?
+): Ray
 	assert(inputObject, "Bad inputObject")
-	offset = offset or Vector3.zero
+
+	local rayOffset = offset or Vector3.zero
 
 	local position = inputObject.Position
-	return InputObjectRayUtils.cameraRayFromScreenPosition(Vector2.new(position.x + offset.x, position.y + offset.y), distance, camera)
+	return InputObjectRayUtils.cameraRayFromScreenPosition(
+		Vector2.new(position.X + rayOffset.X, position.Y + rayOffset.Y),
+		distance,
+		camera
+	)
 end
 
 --[=[
@@ -33,14 +44,21 @@ end
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
-function InputObjectRayUtils.cameraRayFromMouse(mouse, distance, offset, camera)
+function InputObjectRayUtils.cameraRayFromMouse(
+	mouse: Mouse,
+	distance: number,
+	offset: (Vector3 | Vector2)?,
+	camera: Camera?
+): Ray
 	assert(mouse, "Bad mouse")
-	offset = offset or Vector3.zero
+
+	local rayOffset = offset or Vector3.zero
 
 	return InputObjectRayUtils.cameraRayFromScreenPosition(
-		Vector2.new(mouse.x + offset.x, mouse.y + offset.y),
+		Vector2.new(mouse.X + rayOffset.X, mouse.Y + rayOffset.Y),
 		distance,
-		camera)
+		camera
+	)
 end
 
 --[=[
@@ -50,14 +68,20 @@ end
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
-function InputObjectRayUtils.cameraRayFromInputObjectWithOffset(inputObject, distance, offset, camera)
+function InputObjectRayUtils.cameraRayFromInputObjectWithOffset(
+	inputObject: InputObject,
+	distance: number?,
+	offset: Vector3 | Vector2,
+	camera: Camera?
+): Ray
 	assert(inputObject, "Bad inputObject")
 
 	local position = inputObject.Position
 	return InputObjectRayUtils.cameraRayFromScreenPosition(
-		Vector2.new(position.x + offset.x, position.y + offset.y),
+		Vector2.new(position.X + offset.X, position.Y + offset.Y),
 		distance,
-		camera)
+		camera
+	)
 end
 
 --[=[
@@ -66,11 +90,15 @@ end
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
-function InputObjectRayUtils.cameraRayFromScreenPosition(position, distance, camera)
+function InputObjectRayUtils.cameraRayFromScreenPosition(
+	position: Vector3 | Vector2,
+	distance: number?,
+	camera: Camera?
+): Ray
 	distance = distance or DEFAULT_RAY_DISTANCE
-	camera = camera or Workspace.CurrentCamera
+	local currentCamera = camera or Workspace.CurrentCamera
 
-	local baseRay = camera:ScreenPointToRay(position.X, position.Y)
+	local baseRay = currentCamera:ScreenPointToRay(position.X, position.Y)
 	return Ray.new(baseRay.Origin, baseRay.Direction.unit * distance)
 end
 
@@ -80,11 +108,15 @@ end
 	@param camera Camera? -- Optional
 	@return Ray
 ]=]
-function InputObjectRayUtils.cameraRayFromViewportPosition(position, distance, camera)
+function InputObjectRayUtils.cameraRayFromViewportPosition(
+	position: Vector3 | Vector2,
+	distance: number?,
+	camera: Camera?
+): Ray
 	distance = distance or DEFAULT_RAY_DISTANCE
-	camera = camera or Workspace.CurrentCamera
+	local currentCamera = camera or Workspace.CurrentCamera
 
-	local baseRay = camera:ViewportPointToRay(position.X, position.Y)
+	local baseRay = currentCamera:ViewportPointToRay(position.X, position.Y)
 	return Ray.new(baseRay.Origin, baseRay.Direction.unit * distance)
 end
 
@@ -95,8 +127,8 @@ end
 	@param radius number
 	@return { Ray }
 ]=]
-function InputObjectRayUtils.generateCircleRays(ray, count, radius)
-	local rays = { }
+function InputObjectRayUtils.generateCircleRays(ray: Ray, count: number, radius: number): { Ray }
+	local rays = {}
 
 	local origin = ray.Origin
 	local direction = ray.Direction
@@ -104,8 +136,8 @@ function InputObjectRayUtils.generateCircleRays(ray, count, radius)
 	local cframePointing = CFrame.new(origin, origin + direction)
 
 	for i=1, count do
-		local angle = math.pi*2*(i-1)/count
-		local offset = cframePointing:vectorToWorldSpace(Vector3.new(
+		local angle = math.pi * 2 * (i - 1) / count
+		local offset = cframePointing:VectorToWorldSpace(Vector3.new(
 			math.cos(angle)*radius,
 			math.sin(angle)*radius,
 			0))

package/src/Client/InputObjectTracker.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Tracks an input object, whether it's a mouse or a touch button for position
 	or mouse down.
@@ -38,39 +39,40 @@ local InputObjectUtils = require("InputObjectUtils")
 local InputObjectRayUtils = require("InputObjectRayUtils")
 local RxInputObjectUtils = require("RxInputObjectUtils")
 local RxSignal = require("RxSignal")
+local _Maid = require("Maid")
+local _Observable = require("Observable")
 
 local InputObjectTracker = setmetatable({}, BaseObject)
 InputObjectTracker.ClassName = "InputObjectTracker"
 InputObjectTracker.__index = InputObjectTracker
 
-function InputObjectTracker.new(initialInputObject)
+export type InputObjectTracker = typeof(setmetatable(
+	{} :: {
+		_maid: _Maid.Maid,
+		_initialPosition: Vector2,
+		_initialInputObject: InputObject,
+		_lastMousePosition: Vector2,
+		_isMouse: boolean,
+		_camera: Camera?,
+
+		InputEnded: RxSignal.RxSignal<()>,
+	},
+	{ __index = InputObjectTracker }
+))
+
+local function toVector2(vector3: Vector3): Vector2
+	return Vector2.new(vector3.X, vector3.Y)
+end
+
+function InputObjectTracker.new(initialInputObject: InputObject): InputObjectTracker
 	assert(typeof(initialInputObject) == "Instance" and initialInputObject:IsA("InputObject"), "Bad initialInputObject")
 
-	local self = setmetatable(BaseObject.new(), InputObjectTracker)
+	local self: InputObjectTracker = setmetatable(BaseObject.new() :: any, InputObjectTracker)
 
 	self._initialInputObject = assert(initialInputObject, "No initialInputObject")
 
 	if InputObjectUtils.isMouseUserInputType(self._initialInputObject.UserInputType) then
-		self._lastMousePosition = self._initialInputObject.Position
-		self._isMouse = true
-
-		self._maid:GiveTask(UserInputService.InputBegan:Connect(function(inputObject)
-			if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
-				self._lastMousePosition = inputObject.Position
-			end
-		end))
-
-		self._maid:GiveTask(UserInputService.InputChanged:Connect(function(inputObject)
-			if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
-				self._lastMousePosition = inputObject.Position
-			end
-		end))
-
-		self._maid:GiveTask(UserInputService.InputEnded:Connect(function(inputObject)
-			if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
-				self._lastMousePosition = inputObject.Position
-			end
-		end))
+		self:_setupMouse()
 	end
 
 	self._initialPosition = self:GetPosition()
@@ -80,12 +82,34 @@ function InputObjectTracker.new(initialInputObject)
 	return self
 end
 
+function InputObjectTracker._setupMouse(self: InputObjectTracker): ()
+	self._lastMousePosition = toVector2(self._initialInputObject.Position)
+	self._isMouse = true
+
+	self._maid:GiveTask(UserInputService.InputBegan:Connect(function(inputObject)
+		if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
+			self._lastMousePosition = toVector2(inputObject.Position)
+		end
+	end))
+
+	self._maid:GiveTask(UserInputService.InputChanged:Connect(function(inputObject)
+		if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
+			self._lastMousePosition = toVector2(inputObject.Position)
+		end
+	end))
+
+	self._maid:GiveTask(UserInputService.InputEnded:Connect(function(inputObject)
+		if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
+			self._lastMousePosition = toVector2(inputObject.Position)
+		end
+	end))
+end
 --[=[
 	Observes when the input is ended
 
 	@return Observable
 ]=]
-function InputObjectTracker:ObserveInputEnded()
+function InputObjectTracker.ObserveInputEnded(self: InputObjectTracker): _Observable.Observable<()>
 	return RxInputObjectUtils.observeInputObjectEnded(self._initialInputObject)
 end
 
@@ -94,7 +118,7 @@ end
 
 	@return Vector2
 ]=]
-function InputObjectTracker:GetInitialPosition()
+function InputObjectTracker.GetInitialPosition(self: InputObjectTracker): Vector2
 	return self._initialPosition
 end
 
@@ -103,28 +127,37 @@ end
 
 	@return Observable<Vector2>
 ]=]
-function InputObjectTracker:GetPosition()
+function InputObjectTracker.GetPosition(self: InputObjectTracker): Vector2
 	if self._isMouse then
 		return self._lastMousePosition
 	else
 		local position = self._initialInputObject.Position
-		return Vector2.new(position.x, position.y)
+		return Vector2.new(position.X, position.Y)
 	end
 end
 
 --[=[
 	Observes the input object ray
 
-	@param distance number? -- Optional number, defaults to 1000
-	@return Observable<Vector2>
+	@param rayDistance number? -- Optional number, defaults to 1000
+	@return Ray
 ]=]
-function InputObjectTracker:GetRay(distance)
-	distance = distance or 1000
+function InputObjectTracker.GetRay(self: InputObjectTracker, rayDistance: number?): Ray
+	local distance = rayDistance or 1000
 
 	if self._isMouse then
-		return InputObjectRayUtils.cameraRayFromScreenPosition(self._lastMousePosition, distance, self._camera or Workspace.CurrentCamera)
+		return InputObjectRayUtils.cameraRayFromScreenPosition(
+			self._lastMousePosition,
+			distance,
+			self._camera or Workspace.CurrentCamera
+		)
 	else
-		return InputObjectRayUtils.cameraRayFromInputObject(self._initialInputObject, distance, Vector2.zero, self._camera or Workspace.CurrentCamera)
+		return InputObjectRayUtils.cameraRayFromInputObject(
+			self._initialInputObject,
+			distance,
+			Vector2.zero,
+			self._camera or Workspace.CurrentCamera
+		)
 	end
 end
 
@@ -133,7 +166,7 @@ end
 
 	@param camera Camera
 ]=]
-function InputObjectTracker:SetCamera(camera)
+function InputObjectTracker.SetCamera(self: InputObjectTracker, camera: Camera): ()
 	assert(typeof(camera) == "Instance", "Bad camera")
 
 	self._camera = camera

package/src/Client/InputObjectUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides utility functions involving input objects
 	@class InputObjectUtils
@@ -25,7 +26,7 @@ local MOUSE_BUTTON_USER_INPUT_TYPES = {
 	@param userInputType UserInputType
 	@return boolean
 ]=]
-function InputObjectUtils.isMouseUserInputType(userInputType)
+function InputObjectUtils.isMouseUserInputType(userInputType: Enum.UserInputType): boolean
 	assert(typeof(userInputType) == "EnumItem", "Bad userInputType")
 
 	return MOUSE_USER_INPUT_TYPES[userInputType] or false
@@ -37,7 +38,7 @@ end
 	@param userInputType UserInputType
 	@return boolean
 ]=]
-function InputObjectUtils.isMouseButtonInputType(userInputType)
+function InputObjectUtils.isMouseButtonInputType(userInputType: Enum.UserInputType): boolean
 	assert(typeof(userInputType) == "EnumItem", "Bad userInputType")
 
 	return MOUSE_BUTTON_USER_INPUT_TYPES[userInputType] or false
@@ -51,7 +52,7 @@ end
 	@param otherInputObject InputObject
 	@return boolean
 ]=]
-function InputObjectUtils.isSameInputObject(inputObject, otherInputObject)
+function InputObjectUtils.isSameInputObject(inputObject: InputObject, otherInputObject: InputObject): boolean
 	assert(inputObject, "Bad inputObject")
 	assert(otherInputObject, "Bad otherInputObject")
 

package/src/Client/RxInputObjectUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RxInputObjectUtils
 ]=]
@@ -12,7 +13,13 @@ local InputObjectUtils = require("InputObjectUtils")
 
 local RxInputObjectUtils = {}
 
-function RxInputObjectUtils.observeInputObjectEnded(initialInputObject)
+--[=[
+	Observes the input object ended event. This will fire immediately if the input object is already ended.
+
+	@param initialInputObject InputObject
+	@return Observable<()>
+]=]
+function RxInputObjectUtils.observeInputObjectEnded(initialInputObject: InputObject): Observable.Observable<()>
 	assert(initialInputObject, "Bad initialInputObject")
 
 	return Observable.new(function(sub)