@quenty/inputobjectutils 4.5.0 → 4.6.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@4.5.0...@quenty/inputobjectutils@4.6.0) (2024-09-12)
+
+
+### Bug Fixes
+
+* InputObjectUtils didn't load dependencies properly ([bfeb42c](https://github.com/Quenty/NevermoreEngine/commit/bfeb42c9fe16ce5a8ba50e0451fdc1d304e6bc9c))
+
+
+### Features
+
+* Recreate InputObjectTracker to be easier to use ([dc78fe7](https://github.com/Quenty/NevermoreEngine/commit/dc78fe7b83d4be3a08eadf690b13685111e38e25))
+
+
+
+
+
 # [4.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputobjectutils@4.4.0...@quenty/inputobjectutils@4.5.0) (2024-08-09)
 
 **Note:** Version bump only for package @quenty/inputobjectutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputobjectutils",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "Provides utility functions involving input objects",
   "keywords": [
     "Roblox",
@@ -28,9 +28,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^10.3.0",
-    "@quenty/maid": "^3.2.0",
-    "@quenty/rx": "^13.4.0"
+    "@quenty/baseobject": "^10.4.0",
+    "@quenty/loader": "^10.4.0",
+    "@quenty/maid": "^3.3.0",
+    "@quenty/rx": "^13.5.0",
+    "@quenty/rxsignal": "^7.5.0"
   },
-  "gitHead": "ba466bdbc05c42fb607cf5e228c16339201d21d7"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Client/InputObjectTracker.lua

@@ -0,0 +1,142 @@
+--[=[
+	Tracks an input object, whether it's a mouse or a touch button for position
+	or mouse down.
+
+	Works around a bug in the mouse object where the mouse input objects are new
+	per a mouse event.
+
+	```lua
+	local maid = Maid.new()
+	local tracker = maid:Add(InputObjectTracker.new(initialInputObject))
+
+	maid:GiveTask(RunService.RenderStepped:Connect(function()
+		print("Input down at", tracker:GetPosition())
+
+		-- Can also cast a ray
+		print("Cast ray at", tracker:GetRay())
+	end))
+
+	maid:GiveTask(tracker:ObserveInputEnded():Subscribe(function()
+		maid:DoCleaning()
+	end))
+
+	maid:GiveTask(tracker.InputEnded:Connect(function()
+
+	end))
+	```
+
+	@class InputObjectTracker
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Workspace = game:GetService("Workspace")
+local UserInputService = game:GetService("UserInputService")
+
+local BaseObject = require("BaseObject")
+local InputObjectUtils = require("InputObjectUtils")
+local InputObjectRayUtils = require("InputObjectRayUtils")
+local RxInputObjectUtils = require("RxInputObjectUtils")
+local RxSignal = require("RxSignal")
+
+local InputObjectTracker = setmetatable({}, BaseObject)
+InputObjectTracker.ClassName = "InputObjectTracker"
+InputObjectTracker.__index = InputObjectTracker
+
+function InputObjectTracker.new(initialInputObject)
+	assert(typeof(initialInputObject) == "Instance" and initialInputObject:IsA("InputObject"), "Bad initialInputObject")
+
+	local self = setmetatable(BaseObject.new(), 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))
+	end
+
+	self._initialPosition = self:GetPosition()
+
+	self.InputEnded = RxSignal.new(self:ObserveInputEnded())
+
+	return self
+end
+
+--[=[
+	Observes when the input is ended
+
+	@return Observable
+]=]
+function InputObjectTracker:ObserveInputEnded()
+	return RxInputObjectUtils.observeInputObjectEnded(self._initialInputObject)
+end
+
+--[=[
+	Gets the initial position for the input object
+
+	@return Vector2
+]=]
+function InputObjectTracker:GetInitialPosition()
+	return self._initialPosition
+end
+
+--[=[
+	Observes input object position
+
+	@return Observable<Vector2>
+]=]
+function InputObjectTracker:GetPosition()
+	if self._isMouse then
+		return self._lastMousePosition
+	else
+		local position = self._initialInputObject.Position
+		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>
+]=]
+function InputObjectTracker:GetRay(distance)
+	distance = distance or 1000
+
+	if self._isMouse then
+		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)
+	end
+end
+
+--[=[
+	Sets the camera for the input object tracker to retrieve rays from
+
+	@param camera Camera
+]=]
+function InputObjectTracker:SetCamera(camera)
+	assert(typeof(camera) == "Instance", "Bad camera")
+
+	self._camera = camera
+end
+
+return InputObjectTracker

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/src/Client/InputObjectPositionTracker.lua

@@ -1,70 +0,0 @@
---[=[
-	@class InputObjectPositionTracker
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Workspace = game:GetService("Workspace")
-local UserInputService = game:GetService("UserInputService")
-
-local BaseObject = require("BaseObject")
-local InputObjectUtils = require("InputObjectUtils")
-local InputObjectRayUtils = require("InputObjectRayUtils")
-
-local InputObjectPositionTracker = setmetatable({}, BaseObject)
-InputObjectPositionTracker.ClassName = "InputObjectPositionTracker"
-InputObjectPositionTracker.__index = InputObjectPositionTracker
-
-function InputObjectPositionTracker.new(initialInputObject)
-	assert(typeof(initialInputObject) == "Instance" and initialInputObject:IsA("InputObject"), "Bad initialInputObject")
-
-	local self = setmetatable(BaseObject.new(), InputObjectPositionTracker)
-
-	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))
-	end
-
-	return self
-end
-
-function InputObjectPositionTracker:GetInputObjectPosition()
-	if self._isMouse then
-		return self._lastMousePosition
-	else
-		local position = self._initialInputObject.Position
-		return Vector2.new(position.x, position.y)
-	end
-end
-
-function InputObjectPositionTracker:GetInputObjectRay(distance)
-	distance = distance or 1000
-
-	if self._isMouse then
-		return InputObjectRayUtils.cameraRayFromScreenPosition(self._lastMousePosition, distance, Workspace.CurrentCamera)
-	else
-		return InputObjectRayUtils.cameraRayFromInputObject(self._initialInputObject, distance, Vector2.zero, Workspace.CurrentCamera)
-	end
-end
-
-return InputObjectPositionTracker