@quenty/ragdoll 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ragdoll@5.2.1...@quenty/ragdoll@5.3.0) (2022-01-17)
+
+
+### Features
+
+* Add RagdollService and suppress initialization race condition warnings in deferred mode ([480a089](https://github.com/Quenty/NevermoreEngine/commit/480a0892f47fd5acbcb4e846bfb2dd93e207e681))
+
+
+
+
+
+## [5.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ragdoll@5.2.0...@quenty/ragdoll@5.2.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/ragdoll
+
+
+
+
+
 # [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ragdoll@5.1.2...@quenty/ragdoll@5.2.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/ragdoll

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/ragdoll",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Quenty's Ragdoll system for Roblox - Floppy fun ragdolls",
   "keywords": [
     "Roblox",
@@ -25,23 +25,23 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.4.0",
-    "@quenty/binder": "^4.7.0",
-    "@quenty/camera": "^5.2.0",
-    "@quenty/characterutils": "^3.5.0",
+    "@quenty/baseobject": "^3.5.0",
+    "@quenty/binder": "^4.8.0",
+    "@quenty/camera": "^5.3.0",
+    "@quenty/characterutils": "^3.6.0",
     "@quenty/hapticfeedbackutils": "^2.1.1",
     "@quenty/humanoidanimatorutils": "^2.0.1",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/playerhumanoidbinder": "^4.7.0",
-    "@quenty/promise": "^3.5.0",
-    "@quenty/remoting": "^3.5.0",
-    "@quenty/rx": "^3.7.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/playerhumanoidbinder": "^4.8.0",
+    "@quenty/promise": "^3.6.0",
+    "@quenty/remoting": "^3.6.0",
+    "@quenty/rx": "^3.8.0",
     "@quenty/table": "^2.1.1",
-    "@quenty/valuebaseutils": "^3.7.0"
+    "@quenty/valuebaseutils": "^3.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Client/Classes/RagdollClient.lua

@@ -17,6 +17,7 @@ local BaseObject = require("BaseObject")
 local CameraStackService = require("CameraStackService")
 local CharacterUtils = require("CharacterUtils")
 local HapticFeedbackUtils = require("HapticFeedbackUtils")
+local RagdollServiceClient = require("RagdollServiceClient")
 
 local RagdollClient = setmetatable({}, BaseObject)
 RagdollClient.ClassName = "RagdollClient"
@@ -31,7 +32,9 @@ RagdollClient.__index = RagdollClient
 function RagdollClient.new(humanoid, serviceBag)
 	local self = setmetatable(BaseObject.new(humanoid), RagdollClient)
 
-	self._cameraStackService = serviceBag:GetService(CameraStackService)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._ragdollServiceClient = self._serviceBag:GetService(RagdollServiceClient)
+	self._cameraStackService = self._serviceBag:GetService(CameraStackService)
 
 	local player = CharacterUtils.getPlayerFromCharacter(self._obj)
 	if player == Players.LocalPlayer then
@@ -56,7 +59,9 @@ function RagdollClient:_setupCameraShake(impulseCamera)
 		local velocity = head.Velocity
 		local dVelocity = velocity - lastVelocity
 		if dVelocity.magnitude >= 0 then
-			impulseCamera:Impulse(cameraCFrame:vectorToObjectSpace(-0.1*cameraCFrame.lookVector:Cross(dVelocity)))
+			if self._ragdollServiceClient:GetScreenShakeEnabled() then
+				impulseCamera:Impulse(cameraCFrame:vectorToObjectSpace(-0.1*cameraCFrame.lookVector:Cross(dVelocity)))
+			end
 		end
 
 		lastVelocity = velocity

package/src/Client/Classes/RagdollableClient.lua

@@ -83,8 +83,9 @@ function RagdollableClient:_ragdollLocal()
 
 	-- Really hard to infer whether or not we're the network owner, so we just try to do this for every single one.
 
-	-- Hopefully these are already created. Intent here is to reset friction.
-	RagdollRigging.createRagdollJoints(self._obj.Parent, self._obj.RigType)
+	-- Hopefully these are already created. Intent here is to reset friction. If not, the friction
+	-- should be good.
+	RagdollRigging.configureRagdollJoints(false, self._obj.Parent, self._obj.RigType)
 
 	maid:GiveTask(RagdollUtils.setupState(self._obj))
 	maid:GiveTask(RagdollUtils.setupMotors(self._obj))

package/src/Client/RagdollServiceClient.lua

@@ -0,0 +1,49 @@
+--[=[
+	@client
+	@class RagdollServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local AttributeUtils = require("AttributeUtils")
+local RagdollServiceConstants = require("RagdollServiceConstants")
+
+local Players = game:GetService("Players")
+
+local RagdollServiceClient = {}
+
+--[=[
+	Initializes the ragdoll service on the client. Should be done via [ServiceBag].
+	@param serviceBag ServiceBag
+]=]
+function RagdollServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._serviceBag:GetService(require("RagdollBindersClient"))
+
+	self._screenShakeEnabled = true
+end
+
+--[=[
+	Sets screen shake enabled for the local player
+	@param value boolelan
+]=]
+function RagdollServiceClient:SetScreenShakeEnabled(value)
+	assert(type(value) == "boolean", "Bad value")
+	Players.LocalPlayer:SetAttribute(RagdollServiceConstants.SCREEN_SHAKE_ENABLED_ATTRIBUTE)
+end
+
+--[=[
+	Returns wheher screenshake is enabled.
+	@return boolean
+]=]
+function RagdollServiceClient:GetScreenShakeEnabled()
+	assert(self._serviceBag, "Not initialized")
+
+
+	return AttributeUtils.getAttribute(Players.LocalPlayer, RagdollServiceConstants.SCREEN_SHAKE_ENABLED_ATTRIBUTE, true)
+end
+
+
+return RagdollServiceClient

package/src/Server/Classes/Ragdollable.lua

@@ -32,7 +32,7 @@ function Ragdollable.new(humanoid, serviceBag)
 	self._ragdollBinder = serviceBag:GetService(RagdollBindersServer).Ragdoll
 
 	self._obj.BreakJointsOnDeath = false
-	RagdollRigging.createRagdollJoints(self._obj.Parent, humanoid.RigType)
+	RagdollRigging.configureRagdollJoints(true, self._obj.Parent, humanoid.RigType)
 
 	local player = CharacterUtils.getPlayerFromCharacter(self._obj)
 	if player then
@@ -97,7 +97,7 @@ function Ragdollable:_enableServer()
 	local maid = Maid.new()
 
 	-- This will reset friction too
-	RagdollRigging.createRagdollJoints(self._obj.Parent, self._obj.RigType)
+	RagdollRigging.configureRagdollJoints(true, self._obj.Parent, self._obj.RigType)
 
 	maid:GiveTask(RagdollUtils.setupState(self._obj))
 	maid:GiveTask(RagdollUtils.setupMotors(self._obj))

package/src/Server/RagdollService.lua

@@ -0,0 +1,32 @@
+--[=[
+	@server
+	@class RagdollService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RagdollService = {}
+
+--[=[
+	Initializes the ragdoll service on the server. Should be done via [ServiceBag].
+	@param serviceBag ServiceBag
+]=]
+function RagdollService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._binders = self._serviceBag:GetService(require("RagdollBindersServer"))
+end
+
+--[=[
+	Sets whether ragdolls should unragdoll automatically.
+	@param unragdollAutomatically boolean
+]=]
+function RagdollService:SetUnragdollAutomatically(unragdollAutomatically)
+	assert(self._serviceBag, "Not initialized")
+	assert(type(unragdollAutomatically) == "boolean", "Bad unragdollAutomatically")
+
+	self._binders.UnragdollAutomatically:SetAutomaticTagging(unragdollAutomatically)
+end
+
+return RagdollService

package/src/Shared/RagdollRigging.lua

@@ -243,7 +243,7 @@ local function indexParts(model)
 	return parts
 end
 
-local function createRigJoints(parts, rig)
+local function configureRigJoints(create, parts, rig)
 	for _, params in ipairs(rig) do
 		local part0Name, part1Name, attachmentName, limits = unpack(params)
 		local part0 = parts[part0Name]
@@ -255,35 +255,34 @@ local function createRigJoints(parts, rig)
 				-- Our rigs only have one joint per part (connecting each part to it's parent part), so
 				-- we can re-use it if we have to re-rig that part again.
 				local constraint = part1:FindFirstChild(BALL_SOCKET_NAME)
-				if not constraint then
+				if constraint == nil and create then
 					constraint = Instance.new("BallSocketConstraint")
 					constraint.Name = BALL_SOCKET_NAME
+				end
 
-					if RunService:IsClient() then
-						warn(("[RagdollRigging] - Creating BallSocketConstraint %q"))
-					end
+				if constraint then
+					constraint.Attachment0 = a0
+					constraint.Attachment1 = a1
+					constraint.LimitsEnabled = true
+					constraint.UpperAngle = limits.UpperAngle
+					constraint.TwistLimitsEnabled = true
+					constraint.TwistLowerAngle = limits.TwistLowerAngle
+					constraint.TwistUpperAngle = limits.TwistUpperAngle
+					-- Scale constant torque limit for joint friction relative to gravity and the mass of
+					-- the body part.
+					local gravityScale = workspace.Gravity / REFERENCE_GRAVITY
+					local referenceMass = limits.ReferenceMass
+					local massScale = referenceMass and (part1:GetMass() / referenceMass) or 1
+					local maxTorque = limits.FrictionTorque or DEFAULT_MAX_FRICTION_TORQUE
+					constraint.MaxFrictionTorque = maxTorque * massScale * gravityScale
+					constraint.Parent = part1
 				end
-				constraint.Attachment0 = a0
-				constraint.Attachment1 = a1
-				constraint.LimitsEnabled = true
-				constraint.UpperAngle = limits.UpperAngle
-				constraint.TwistLimitsEnabled = true
-				constraint.TwistLowerAngle = limits.TwistLowerAngle
-				constraint.TwistUpperAngle = limits.TwistUpperAngle
-				-- Scale constant torque limit for joint friction relative to gravity and the mass of
-				-- the body part.
-				local gravityScale = workspace.Gravity / REFERENCE_GRAVITY
-				local referenceMass = limits.ReferenceMass
-				local massScale = referenceMass and (part1:GetMass() / referenceMass) or 1
-				local maxTorque = limits.FrictionTorque or DEFAULT_MAX_FRICTION_TORQUE
-				constraint.MaxFrictionTorque = maxTorque * massScale * gravityScale
-				constraint.Parent = part1
 			end
 		end
 	end
 end
 
-local function createAdditionalAttachments(parts, attachments)
+local function configureAdditionalAttachments(create, parts, attachments)
 	for _, attachmentParams in ipairs(attachments) do
 		local partName, attachmentName, cframe, baseAttachmentName = unpack(attachmentParams)
 		local part = parts[partName]
@@ -299,13 +298,11 @@ local function createAdditionalAttachments(parts, attachments)
 				end
 				-- The attachment names are unique within a part, so we can re-use
 				if not attachment then
-					attachment = Instance.new("Attachment")
-					attachment.Name = attachmentName
-					attachment.CFrame = cframe
-					attachment.Parent = part
-
-					if RunService:IsClient() then
-						warn(("[RagdollRigging] - Creating attachment %q"):format(attachmentName))
+					if create then
+						attachment = Instance.new("Attachment")
+						attachment.Name = attachmentName
+						attachment.CFrame = cframe
+						attachment.Parent = part
 					end
 				else
 					attachment.CFrame = cframe
@@ -315,7 +312,7 @@ local function createAdditionalAttachments(parts, attachments)
 	end
 end
 
-local function createNoCollides(parts, noCollides)
+local function configureNoCollides(create, parts, noCollides)
 	-- This one's trickier to handle for an already rigged character since a part will have multiple
 	-- NoCollide children with the same name. Having fewer unique names is better for
 	-- replication so we suck it up and deal with the complexity here.
@@ -363,16 +360,16 @@ local function createNoCollides(parts, noCollides)
 		local reusables = reusableNoCollides[part1]
 		for part0, _ in pairs(neededPart0s) do
 			local constraint = table.remove(reusables)
-			if not constraint then
+			if constraint == nil and create then
 				constraint = Instance.new("NoCollisionConstraint")
-				if RunService:IsClient() then
-					warn(("[RagdollRigging] - Creating NoCollisionConstraint %q"))
-				end
 			end
-			constraint.Name = NO_COLLIDE_NAME
-			constraint.Part0 = part0
-			constraint.Part1 = part1
-			constraint.Parent = part1
+
+			if constraint then
+				constraint.Name = NO_COLLIDE_NAME
+				constraint.Part0 = part0
+				constraint.Part1 = part1
+				constraint.Parent = part1
+			end
 		end
 	end
 end
@@ -396,19 +393,20 @@ end
 
 --[=[
 	Creates joints on a model for a given rig type.
+	@param create boolean -- True if we create the joints, false if we just configure.
 	@param model Model
 	@param rigType HumanoidRigType
 ]=]
-function RagdollRigging.createRagdollJoints(model, rigType)
+function RagdollRigging.configureRagdollJoints(create, model, rigType)
 	local parts = indexParts(model)
 	if rigType == Enum.HumanoidRigType.R6 then
-		createAdditionalAttachments(parts, R6_ADDITIONAL_ATTACHMENTS)
-		createRigJoints(parts, R6_RAGDOLL_RIG)
-		createNoCollides(parts, R6_NO_COLLIDES)
+		configureAdditionalAttachments(create, parts, R6_ADDITIONAL_ATTACHMENTS)
+		configureRigJoints(create, parts, R6_RAGDOLL_RIG)
+		configureNoCollides(create, parts, R6_NO_COLLIDES)
 	elseif rigType == Enum.HumanoidRigType.R15 then
-		createAdditionalAttachments(parts, R15_ADDITIONAL_ATTACHMENTS)
-		createRigJoints(parts, R15_RAGDOLL_RIG)
-		createNoCollides(parts, R15_NO_COLLIDES)
+		configureAdditionalAttachments(create, parts, R15_ADDITIONAL_ATTACHMENTS)
+		configureRigJoints(create, parts, R15_RAGDOLL_RIG)
+		configureNoCollides(create, parts, R15_NO_COLLIDES)
 	else
 		error("unknown rig type", 2)
 	end

package/src/Shared/RagdollServiceConstants.lua

@@ -0,0 +1,11 @@
+--[=[
+	@class RagdollServiceConstants
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Table = require("Table")
+
+return Table.readonly({
+	SCREEN_SHAKE_ENABLED_ATTRIBUTE = "RagdollScreenShakeEnabled"
+})