@quenty/toolutils 1.0.1-canary.534.e0a44d2.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.534.e0a44d2.0 (2025-01-28)
+
+
+### Features
+
+* Add new ToolUtils package ([c056229](https://github.com/Quenty/NevermoreEngine/commit/c056229ced6478e2123e6565ffcea8431b0bb87a))
+* Add ToolUtils.getEquippedHumanoid() and ToolUtils.getEquippedPlayer() ([5a05b53](https://github.com/Quenty/NevermoreEngine/commit/5a05b53fcef940f389985d5499d18bf6ef26a8c7))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 James Onnen (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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## ToolUtils
+
+<div align="center">
+  <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/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" />
+  </a>
+</div>
+
+Utility methods for tools
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RxToolUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/toolutils --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@quenty/toolutils",
+  "version": "1.0.1-canary.534.e0a44d2.0",
+  "description": "Utility methods for tools",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "toolutils"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/toolutils/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/brio": "14.15.0",
+    "@quenty/instanceutils": "13.15.0",
+    "@quenty/loader": "10.7.1",
+    "@quenty/rx": "13.15.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "e0a44d2ca0a612beb227c36fee1837e0898c3207"
+}

package/src/Shared/RxToolUtils.lua

@@ -0,0 +1,30 @@
+--[=[
+	@class RxToolUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RxInstanceUtils = require("RxInstanceUtils")
+local RxBrioUtils = require("RxBrioUtils")
+
+local RxToolUtils = {}
+
+--[=[
+	Observes the equipped humanoid of a given tool
+
+	@param tool Instance
+	@return Observable<Brio<Humanoid>>
+]=]
+function RxToolUtils.observeEquippedHumanoidBrio(tool)
+	assert(typeof(tool) == "Instance", "Bad tool")
+
+	return RxInstanceUtils.observePropertyBrio(tool, "Parent", function(parent)
+		return parent and parent:IsA("Model")
+	end):Pipe({
+		RxBrioUtils.switchMapBrio(function(parent)
+			return RxInstanceUtils.observeChildrenOfClassBrio(parent, "Humanoid")
+		end);
+	})
+end
+
+return RxToolUtils

package/src/Shared/ToolUtils.lua

@@ -0,0 +1,44 @@
+--[=[
+	@class ToolUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local CharacterUtils = require("CharacterUtils")
+
+local ToolUtils = {}
+
+--[=[
+	Gets the equipped humanoid for a given tool
+]=]
+function ToolUtils.getEquippedHumanoid(tool: Tool): Humanoid?
+	assert(typeof(tool) == "Instance", "Bad tool")
+
+	local character = tool.Parent
+	if not (character and character:IsA("Model")) then
+		return nil
+	end
+
+	local humanoid = character:FindFirstChildWhichIsA("Humanoid")
+	if not humanoid then
+		return nil
+	end
+
+	return humanoid
+end
+
+--[=[
+	Gets the equipped player for a given tool
+]=]
+function ToolUtils.getEquippedPlayer(tool: Tool): Player?
+	assert(typeof(tool) == "Instance", "Bad tool")
+
+	local humanoid = ToolUtils.getEquippedHumanoid(tool)
+	if not humanoid then
+		return nil
+	end
+
+	return CharacterUtils.getPlayerFromCharacter(humanoid)
+end
+
+return ToolUtils

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "ToolUtilsTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "toolutils": {
+        "$path": ".."
+      }
+    }
+  }
+}