@quenty/rigbuilderutils 3.2.1-canary.8533eea.0 → 3.3.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.2.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@3.2.0...@quenty/rigbuilderutils@3.2.1-canary.8533eea.0) (2021-12-18)
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@3.3.0...@quenty/rigbuilderutils@3.3.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/rigbuilderutils
+
+
+
+
+
+# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@3.2.0...@quenty/rigbuilderutils@3.3.0) (2021-12-18)
 
 
 ### Features
 
-* Add RigBuilderUtils.promiseR15Rig() and  RigBuilderUtils.promisePlayerRig(userId) ([accf109](https://github.com/Quenty/NevermoreEngine/commit/accf10919ad4484aefa40a1f296ad928c8cb02d9))
+* Add RigBuilderUtils.promiseR15Rig() and  RigBuilderUtils.promisePlayerRig(userId) ([93f8c5a](https://github.com/Quenty/NevermoreEngine/commit/93f8c5ab926c6a6effda7f1c66960f3f3c3ec88c))
 
 
 

package/README.md

@@ -1,10 +1,10 @@
 ## RigBuilderUtils
 <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 @@
 
 Utility functions for debugging, builds a Roblox character rig
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RigBuilderUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/rigbuilderutils --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rigbuilderutils",
-  "version": "3.2.1-canary.8533eea.0",
+  "version": "3.3.1",
   "description": "Utility functions for debugging, builds a Roblox character rig",
   "keywords": [
     "Roblox",
@@ -26,17 +26,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/humanoiddescriptionutils": "3.2.1-canary.8533eea.0",
-    "@quenty/insertserviceutils": "3.2.1-canary.8533eea.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/promise": "3.2.1-canary.8533eea.0"
+    "@quenty/humanoiddescriptionutils": "^3.3.1",
+    "@quenty/insertserviceutils": "^3.3.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/promise": "^3.3.1"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "3.2.1-canary.8533eea.0",
-    "@quenty/maid": "2.0.1"
+    "@quenty/camerastoryutils": "^3.3.1",
+    "@quenty/maid": "^2.0.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/AssetServiceUtils.lua

@@ -1,6 +1,7 @@
----
--- @module AssetServiceUtils
--- @author Quenty
+--[=[
+	Utility methods involving the AssetService
+	@class AssetServiceUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,6 +11,12 @@ local Promise = require("Promise")
 
 local AssetServiceUtils = {}
 
+--[=[
+	Retrieves the assetIds for a package
+
+	@param packageAssetId number
+	@return Promise<table>
+]=]
 function AssetServiceUtils.promiseAssetIdsForPackage(packageAssetId)
 	return Promise.spawn(function(resolve, reject)
 		local result

package/src/Shared/RigBuilderUtils.lua

@@ -1,5 +1,7 @@
---- Helps build player characters
--- @module RigBuilderUtils
+--[=[
+	Helps build player characters or other humanoid rigs for use in a variety of situations.
+	@class RigBuilderUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -167,6 +169,10 @@ function RigBuilderUtils.createR6BaseRig()
 	return character
 end
 
+--[=[
+	Creates an R6 mesh rig
+	@return Instance
+]=]
 function RigBuilderUtils.createR6MeshRig()
 	local rig = RigBuilderUtils.createR6BaseRig()
 
@@ -203,6 +209,10 @@ function RigBuilderUtils.createR6MeshRig()
 	return rig
 end
 
+--[=[
+	Creates an R6 boy mesh rig
+	@return Instance
+]=]
 function RigBuilderUtils.createR6MeshBoyRig()
 	local rig = RigBuilderUtils.createR6BaseRig()
 
@@ -239,6 +249,10 @@ function RigBuilderUtils.createR6MeshBoyRig()
 	return rig
 end
 
+--[=[
+	Creates an R6 girl mesh rig
+	@return Instance
+]=]
 function RigBuilderUtils.createR6MeshGirlRig()
 	local rig = RigBuilderUtils.createR6BaseRig()
 
@@ -316,6 +330,11 @@ function RigBuilderUtils._createR15BaseRig()
 	return character, humanoid
 end
 
+--[=[
+	Creates an R15 rig from a package
+	@param packageAssetId number
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promiseR15PackageRig(packageAssetId)
 	assert(type(packageAssetId) == "number", "Bad packageAssetId")
 
@@ -372,6 +391,10 @@ function RigBuilderUtils.promiseR15PackageRig(packageAssetId)
 		end)
 end
 
+--[=[
+	Creates a default R15 rig
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promiseR15Rig()
 	return InsertServiceUtils.promiseAsset(1664543044)
 		:Then(function(inserted)
@@ -399,18 +422,35 @@ function RigBuilderUtils.promiseR15Rig()
 		end)
 end
 
+--[=[
+	Creates an R15 man rig
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promiseR15ManRig()
 	return RigBuilderUtils.promiseR15PackageRig(86500185)
 end
 
+--[=[
+	Creates an R15 woman rig
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promiseR15WomanRig()
 	return RigBuilderUtils.promiseR15PackageRig(86499905)
 end
 
+--[=[
+	Creates an R15 mesh rig
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promiseR15MeshRig()
 	return RigBuilderUtils.promiseR15PackageRig(27112438)
 end
 
+--[=[
+	Creates an R15 rig dressed as a given player
+	@param userId number
+	@return Promise<Instance>
+]=]
 function RigBuilderUtils.promisePlayerRig(userId)
 	assert(type(userId) == "number", "Bad userId")
 

package/src/Shared/RigBuilderUtils.story.lua

@@ -1,6 +1,6 @@
----
--- @module RigBuilderUtils.story
--- @author Quenty
+--[[
+	@class RigBuilderUtils.story
+]]
 
 local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)