@quenty/adorneeutils 2.1.0 → 2.1.2-canary.247.1597949.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.
 
+## [2.1.2-canary.247.1597949.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneeutils@2.1.1...@quenty/adorneeutils@2.1.2-canary.247.1597949.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/adorneeutils
+
+
+
+
+
+## [2.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneeutils@2.1.0...@quenty/adorneeutils@2.1.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/adorneeutils
+
+
+
+
+
 # [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/adorneeutils@2.0.0...@quenty/adorneeutils@2.1.0) (2021-09-22)
 
 

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 @@
 ## AdorneeUtils
 <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,6 +13,8 @@
 
 AdorneeUtils - Generic adornee functions to make attaching to objects in Roblox easier.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/AdorneeUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/adorneeutils --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/adorneeutils",
-  "version": "2.1.0",
+  "version": "2.1.2-canary.247.1597949.0",
   "description": "AdorneeUtils - Generic adornee functions to make attaching to objects in Roblox easier.",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6288c63115f31544fce6663d018826e81ef01c7f"
+  "gitHead": "159794913fb32aedaf48d2a2d7808d50449f4c01"
 }

package/src/Shared/AdorneeUtils.lua

@@ -1,9 +1,18 @@
----
--- @module AdorneeUtils
--- @author Quenty
+--[=[
+	Utilities involving an "Adornee" effectively, any Roblox instance. This is an extremely
+	useful library to use as it lets you abstract applying effects to any Roblox instance
+	instead of specifically switching for different Roblox types.
+
+	@class AdorneeUtils
+]=]
 
 local AdorneeUtils = {}
 
+--[=[
+	Gets the center of the adornee
+	@param adornee Instance
+	@return Vector3?
+]=]
 function AdorneeUtils.getCenter(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
@@ -39,6 +48,12 @@ function AdorneeUtils.getCenter(adornee)
 	end
 end
 
+--[=[
+	Gets the bounding box of the adornee
+	@param adornee Instance
+	@return CFrame?
+	@return Vector3?
+]=]
 function AdorneeUtils.getBoundingBox(adornee)
 	if adornee:IsA("Model") then
 		return adornee:GetBoundingBox()
@@ -49,6 +64,12 @@ function AdorneeUtils.getBoundingBox(adornee)
 	end
 end
 
+--[=[
+	Returns whether a part is a part of an adornee
+	@param adornee Instance
+	@param part BasePart
+	@return boolean
+]=]
 function AdorneeUtils.isPartOfAdornee(adornee, part)
 	assert(part:IsA("BasePart"))
 
@@ -63,6 +84,11 @@ function AdorneeUtils.isPartOfAdornee(adornee, part)
 	return adornee == part or part:IsDescendantOf(adornee)
 end
 
+--[=[
+	Retrieves all parts of an adornee
+	@param adornee Instance
+	@return { BasePart }
+]=]
 function AdorneeUtils.getParts(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
@@ -89,6 +115,11 @@ function AdorneeUtils.getParts(adornee)
 	return parts
 end
 
+--[=[
+	Retrieves a size aligned the adornee's CFrame
+	@param adornee Instance
+	@return Vector3?
+]=]
 function AdorneeUtils.getAlignedSize(adornee)
 	if adornee:IsA("Model") then
 		return select(2, adornee:GetBoundingBox())
@@ -108,6 +139,11 @@ function AdorneeUtils.getAlignedSize(adornee)
 	return nil
 end
 
+--[=[
+	Retrieves this adornee's "part"'s CFrame.
+	@param adornee Instance
+	@return CFrame
+]=]
 function AdorneeUtils.getPartCFrame(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
@@ -119,6 +155,11 @@ function AdorneeUtils.getPartCFrame(adornee)
 	return part.CFrame
 end
 
+--[=[
+	Retrieves this adornee's "part"'s position.
+	@param adornee Instance
+	@return Position
+]=]
 function AdorneeUtils.getPartPosition(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
@@ -130,6 +171,11 @@ function AdorneeUtils.getPartPosition(adornee)
 	return part.Position
 end
 
+--[=[
+	Retrieves this adornee's "part"'s Velocity.
+	@param adornee Instance
+	@return Vector3
+]=]
 function AdorneeUtils.getPartVelocity(adornee)
 	local part = AdorneeUtils.getPart(adornee)
 	if not part then
@@ -139,6 +185,11 @@ function AdorneeUtils.getPartVelocity(adornee)
 	return part.Velocity
 end
 
+--[=[
+	Retrieves this adornee's part
+	@param adornee Instance
+	@return BasePart
+]=]
 function AdorneeUtils.getPart(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")
 
@@ -168,6 +219,11 @@ function AdorneeUtils.getPart(adornee)
 	end
 end
 
+--[=[
+	Retrieves this adornee's part on which to attach a rendering instance to
+	@param adornee Instance
+	@return Instance
+]=]
 function AdorneeUtils.getRenderAdornee(adornee)
 	assert(typeof(adornee) == "Instance", "Adornee must by of type 'Instance'")