@quenty/rigbuilderutils 6.1.0 → 6.2.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@6.1.0...@quenty/rigbuilderutils@6.2.0) (2023-02-21)
+
+
+### Features
+
+* Add RigBuilderUtils.promiseBasePlayerRig ([80a6bfb](https://github.com/Quenty/NevermoreEngine/commit/80a6bfb8ae8af406c760f18aeba507ae17a3fecf))
+
+
+
+
+
 # [6.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@6.0.1...@quenty/rigbuilderutils@6.1.0) (2022-12-06)
 
 **Note:** Version bump only for package @quenty/rigbuilderutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rigbuilderutils",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Utility functions for debugging, builds a Roblox character rig",
   "keywords": [
     "Roblox",
@@ -26,17 +26,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/humanoiddescriptionutils": "^6.0.1",
-    "@quenty/insertserviceutils": "^6.0.1",
-    "@quenty/loader": "^6.0.1",
-    "@quenty/promise": "^6.0.1"
+    "@quenty/humanoiddescriptionutils": "^6.1.0",
+    "@quenty/insertserviceutils": "^6.1.0",
+    "@quenty/loader": "^6.1.0",
+    "@quenty/promise": "^6.1.0"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "^6.0.1",
+    "@quenty/camerastoryutils": "^6.1.0",
     "@quenty/maid": "^2.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d9b0d10faa443cc42a6c2ac966f2f56d124bbde5"
+  "gitHead": "e084b0cc097ddbcb7c782b8ecbd9c2d619c49354"
 }

package/src/Shared/RigBuilderUtils.lua

@@ -5,8 +5,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local ServerScriptService = game:GetService("ServerScriptService")
-local HttpService = game:GetService("HttpService")
+local Players = game:GetService("Players")
 
 local InsertServiceUtils = require("InsertServiceUtils")
 local PromiseUtils = require("PromiseUtils")
@@ -447,42 +446,95 @@ function RigBuilderUtils.promiseR15MeshRig()
 end
 
 --[=[
-	Creates an R15 rig dressed as a given player
+	Creates an R15 rig with the base details of a given character, but not all of them
 	@param userId number
+	@param humanoidRigType HumanoidRigType | nil
+	@param assetTypeVerification AssetTypeVerification | nil
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promisePlayerRig(userId)
+function RigBuilderUtils.promiseBasePlayerRig(userId, humanoidRigType, assetTypeVerification)
 	assert(type(userId) == "number", "Bad userId")
+	assert(typeof(humanoidRigType) == "EnumItem" or humanoidRigType == nil, "Bad humanoidRigType")
+	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
+
+	return HumanoidDescriptionUtils.promiseFromUserId(userId)
+		:Then(function(playerHumanoidDescription)
+			-- Wipe accessories
+			local humanoidDescription = playerHumanoidDescription:Clone()
+			humanoidDescription.BackAccessory = ""
+			humanoidDescription.FaceAccessory = ""
+			humanoidDescription.FrontAccessory = ""
+			humanoidDescription.HairAccessory = ""
+			humanoidDescription.HatAccessory = ""
+			humanoidDescription.NeckAccessory = ""
+			humanoidDescription.ShouldersAccessory = ""
+			humanoidDescription.WaistAccessory = ""
+			humanoidDescription.GraphicTShirt = 0
+			humanoidDescription.Shirt = 0
+			humanoidDescription.Pants = 0
+			humanoidDescription:SetAccessories({}, true)
+
+			return RigBuilderUtils.promiseHumanoidModelFromDescription(humanoidDescription, humanoidRigType, assetTypeVerification)
+		end)
+end
+
+function RigBuilderUtils.promiseHumanoidModelFromDescription(description, rigType, assetTypeVerification)
+	assert(typeof(description) == "Instance" and description:IsA("HumanoidDescription"), "Bad description")
+	assert(typeof(rigType) == "EnumItem" or rigType == nil, "Bad rigType")
+	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
+
+	return Promise.spawn(function(resolve, reject)
+		local model = nil
+		local ok, err = pcall(function()
+			model = Players:CreateHumanoidModelFromDescription(
+				description,
+				rigType or Enum.HumanoidRigType.R15,
+				assetTypeVerification or Enum.AssetTypeVerification.Default)
+		end)
+		if not ok then
+			return reject(err or "Failed to create model")
+		end
+		if typeof(model) ~= "Instance" then
+			return reject("Bad model result type")
+		end
+
+		return resolve(model)
+	end)
+end
 
-	return PromiseUtils.all({
-		RigBuilderUtils.promiseR15Rig(),
-		HumanoidDescriptionUtils.promiseFromUserId(userId)
-	}):Then(function(meshRig, humanoidDescription)
-		local humanoid = meshRig:FindFirstChildWhichIsA("Humanoid")
-		if not humanoid then
-			return Promise.rejected("No humanoid from rig builder")
+function RigBuilderUtils.promiseHumanoidModelFromUserId(userId, rigType, assetTypeVerification)
+	assert(type(userId) == "number", "Bad userId")
+	assert(typeof(rigType) == "EnumItem" or rigType == nil, "Bad rigType")
+	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
+
+	return Promise.spawn(function(resolve, reject)
+		local model = nil
+		local ok, err = pcall(function()
+			model = Players:CreateHumanoidModelFromUserId(
+				userId,
+				rigType or Enum.HumanoidRigType.R15,
+				assetTypeVerification or Enum.AssetTypeVerification.Default)
+		end)
+		if not ok then
+			return reject(err or "Failed to create model")
+		end
+		if typeof(model) ~= "Instance" then
+			return reject("Bad model result type")
 		end
 
-		meshRig.Archivable = false
-		local originalName = meshRig.Name
-
-		-- Hack! Apparently we need to parent this to the datamodel to apply the description
-		meshRig.Name = "RigBuilderUtils_LoadingHumanoid_" .. HttpService:GenerateGUID(false)
-		meshRig.Parent = ServerScriptService -- somewhere that does not replicate
-
-		return HumanoidDescriptionUtils.promiseApplyDescription(humanoid, humanoidDescription)
-			:Then(function()
-				meshRig.Parent = nil
-				meshRig.Archivable = true
-				meshRig.Name = originalName
-
-				return meshRig
-			end, function(...)
-				-- cleanup
-				meshRig:Destroy()
-				return Promise.rejected(...)
-			end)
+		return resolve(model)
 	end)
 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")
+
+	return RigBuilderUtils.promiseHumanoidModelFromUserId(userId)
+end
+
 return RigBuilderUtils