@quenty/adorneeutils 3.3.0 → 3.3.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneeutils@3.3.0...@quenty/adorneeutils@3.3.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/adorneeutils
+
+
+
+
+
 # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneeutils@3.2.0...@quenty/adorneeutils@3.3.0) (2024-12-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/adorneeutils",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "AdorneeUtils - Generic adornee functions to make attaching to objects in Roblox easier.",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "66190e48c1ca93b07040326e9cfcf97e8eb4b0e1"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/AdorneeUtils.lua

@@ -13,7 +13,7 @@ local AdorneeUtils = {}
 	@param adornee Instance
 	@return Vector3?
 ]=]
-function AdorneeUtils.getCenter(adornee)
+function AdorneeUtils.getCenter(adornee: Instance): Vector3?
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	if adornee:IsA("BasePart") then
@@ -51,10 +51,10 @@ end
 --[=[
 	Gets the bounding box of the adornee
 	@param adornee Instance
-	@return CFrame?
-	@return Vector3?
+	@return CFrame? -- Center of the bounding box
+	@return Vector3? -- Size of the bounding box
 ]=]
-function AdorneeUtils.getBoundingBox(adornee)
+function AdorneeUtils.getBoundingBox(adornee: Instance): (CFrame, Vector3)
 	if adornee:IsA("Model") then
 		return adornee:GetBoundingBox()
 	elseif adornee:IsA("Attachment") then
@@ -70,8 +70,8 @@ end
 	@param part BasePart
 	@return boolean
 ]=]
-function AdorneeUtils.isPartOfAdornee(adornee, part)
-	assert(part:IsA("BasePart"))
+function AdorneeUtils.isPartOfAdornee(adornee: Instance, part: BasePart): boolean
+	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
 	if adornee:IsA("Humanoid") then
 		if not adornee.Parent then
@@ -89,7 +89,7 @@ end
 	@param adornee Instance
 	@return { BasePart }
 ]=]
-function AdorneeUtils.getParts(adornee)
+function AdorneeUtils.getParts(adornee: Instance): { BasePart }
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	local parts = {}
@@ -120,12 +120,13 @@ end
 	@param adornee Instance
 	@return Vector3?
 ]=]
-function AdorneeUtils.getAlignedSize(adornee)
+function AdorneeUtils.getAlignedSize(adornee: Instance): Vector3?
 	if adornee:IsA("Model") then
 		return select(2, adornee:GetBoundingBox())
 	elseif adornee:IsA("Humanoid") then
-		if adornee.Parent then
-			return select(2, adornee.Parent:GetBoundingBox())
+		local character = adornee.Parent
+		if character and character:IsA("Model") then
+			return select(2, character:GetBoundingBox())
 		else
 			return nil
 		end
@@ -144,7 +145,7 @@ end
 	@param adornee Instance
 	@return CFrame
 ]=]
-function AdorneeUtils.getPartCFrame(adornee)
+function AdorneeUtils.getPartCFrame(adornee: Instance): CFrame?
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	local part = AdorneeUtils.getPart(adornee)
@@ -160,7 +161,7 @@ end
 	@param adornee Instance
 	@return Position
 ]=]
-function AdorneeUtils.getPartPosition(adornee)
+function AdorneeUtils.getPartPosition(adornee: Instance): Vector3?
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	local part = AdorneeUtils.getPart(adornee)
@@ -176,7 +177,7 @@ end
 	@param adornee Instance
 	@return Vector3
 ]=]
-function AdorneeUtils.getPartVelocity(adornee)
+function AdorneeUtils.getPartVelocity(adornee: Instance): Vector3?
 	local part = AdorneeUtils.getPart(adornee)
 	if not part then
 		return nil
@@ -190,7 +191,7 @@ end
 	@param adornee Instance
 	@return BasePart
 ]=]
-function AdorneeUtils.getPart(adornee)
+function AdorneeUtils.getPart(adornee: Instance): BasePart?
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	if adornee:IsA("BasePart") then
@@ -202,11 +203,11 @@ function AdorneeUtils.getPart(adornee)
 			return adornee:FindFirstChildWhichIsA("BasePart")
 		end
 	elseif adornee:IsA("Attachment") then
-		return adornee.Parent
+		return adornee:FindFirstAncestorWhichIsA("BasePart")
 	elseif adornee:IsA("Humanoid") then
 		return adornee.RootPart
 	elseif adornee:IsA("Accessory") or adornee:IsA("Clothing") then
-		return adornee:FindFirstChildWhichIsA("BasePart")
+		return adornee:FindFirstChildWhichIsA("BasePart") :: BasePart
 	elseif adornee:IsA("Tool") then
 		local handle = adornee:FindFirstChild("Handle")
 		if handle and handle:IsA("BasePart") then
@@ -224,7 +225,7 @@ end
 	@param adornee Instance
 	@return Instance
 ]=]
-function AdorneeUtils.getRenderAdornee(adornee)
+function AdorneeUtils.getRenderAdornee(adornee: Instance): Instance?
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
 	if adornee:IsA("BasePart") then
@@ -249,4 +250,4 @@ function AdorneeUtils.getRenderAdornee(adornee)
 	end
 end
 
-return AdorneeUtils
+return AdorneeUtils