@quenty/clipcharacters 12.4.0 → 12.4.1

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.
 
+## [12.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clipcharacters@12.4.0...@quenty/clipcharacters@12.4.1) (2024-05-14)
+
+
+### Bug Fixes
+
+* Update ClipCharacters to act as a service ([b6651b6](https://github.com/Quenty/NevermoreEngine/commit/b6651b6d01375857e022641f62461e179292a97c))
+
+
+
+
+
 # [12.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clipcharacters@12.3.0...@quenty/clipcharacters@12.4.0) (2024-05-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clipcharacters",
-  "version": "12.4.0",
+  "version": "12.4.1",
   "description": "Clip characters locally on the client of other clients so they don't interfer with physics.",
   "keywords": [
     "Roblox",
@@ -25,12 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
+    "@quenty/baseobject": "^10.3.0",
+    "@quenty/brio": "^14.3.0",
+    "@quenty/characterutils": "^12.3.0",
     "@quenty/loader": "^10.3.0",
     "@quenty/maid": "^3.2.0",
-    "@quenty/remoting": "^12.4.0"
+    "@quenty/playerutils": "^8.3.0",
+    "@quenty/remoting": "^12.4.0",
+    "@quenty/servicebag": "^11.4.0",
+    "@quenty/statestack": "^14.4.0",
+    "@quenty/table": "^3.5.0",
+    "@quenty/valueobject": "^13.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3fd5cdca3128bf34c8d9dfae1e92d62533b6e6f5"
+  "gitHead": "4955d2477353af4833f444483d41428faa446a4f"
 }

package/src/Client/ClipCharacters.lua

@@ -0,0 +1,80 @@
+--[=[
+	Clip characters locally on the client of other clients so they don't interfer with physics.
+	@class ClipCharacters
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local ClipCharactersServiceConstants = require("ClipCharactersServiceConstants")
+local RxBrioUtils = require("RxBrioUtils")
+local RxCharacterUtils = require("RxCharacterUtils")
+local RxPlayerUtils = require("RxPlayerUtils")
+
+local ClipCharacters = setmetatable({}, BaseObject)
+ClipCharacters.ClassName = "ClipCharacters"
+ClipCharacters.__index = ClipCharacters
+
+--[=[
+	Prevents characters from clipping together
+
+	@return ClipCharacters
+]=]
+function ClipCharacters.new()
+	local self = setmetatable(BaseObject.new(), ClipCharacters)
+
+	self._maid:GiveTask(RxPlayerUtils.observePlayersBrio():Pipe({
+		RxBrioUtils.flatMapBrio(function(player)
+			return RxCharacterUtils.observeLastCharacterBrio(player)
+		end)
+	}):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid, character = brio:ToMaidAndValue()
+		self:_setupCharacter(maid, character)
+	end))
+
+	return self
+end
+
+function ClipCharacters:_onDescendantAdded(originalTable, descendant)
+	if not originalTable[descendant] and descendant:IsA("BasePart") then
+		originalTable[descendant] = descendant.CollisionGroup
+		descendant.CollisionGroup = ClipCharactersServiceConstants.COLLISION_GROUP_NAME
+	end
+end
+
+function ClipCharacters:_onDescendantRemoving(originalTable, descendant)
+	if originalTable[descendant] then
+		descendant.CollisionGroup = originalTable[descendant]
+		originalTable[descendant] = nil
+	end
+end
+
+function ClipCharacters:_setupCharacter(maid, character)
+	local originalTable = {}
+
+	maid:GiveTask(character.DescendantAdded:Connect(function(descendant)
+		self:_onDescendantAdded(originalTable, descendant)
+	end))
+
+	maid:GiveTask(character.DescendantRemoving:Connect(function(descendant)
+		self:_onDescendantRemoving(originalTable, descendant)
+	end))
+
+	-- Cleanup
+	maid:GiveTask(function()
+		for descendant, _ in pairs(originalTable) do
+			self:_onDescendantRemoving(originalTable, descendant)
+		end
+	end)
+
+	-- Initialize
+	for _, descendant in pairs(character:GetDescendants()) do
+		self:_onDescendantAdded(originalTable, descendant)
+	end
+end
+
+return ClipCharacters

package/src/Client/ClipCharactersServiceClient.lua

@@ -0,0 +1,47 @@
+--[=[
+	@class ClipCharactersServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local ClipCharacters = require("ClipCharacters")
+local Maid = require("Maid")
+local StateStack = require("StateStack")
+
+local ClipCharactersServiceClient = {}
+ClipCharactersServiceClient.ServiceName = "ClipCharactersServiceClient"
+
+function ClipCharactersServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._disableCollisions = self._maid:Add(StateStack.new(false, "boolean"))
+end
+
+--[=[
+	Disables collisions between default geometry and other charaters which stops some random physics
+	glitches from occuring.
+]=]
+function ClipCharactersServiceClient:PushDisableCharacterCollisionsWithDefault()
+	return self._disableCollisions:PushState(true)
+end
+
+function ClipCharactersServiceClient:Start()
+	self._maid:GiveTask(self._disableCollisions:ObserveBrio(function(value)
+		return value
+	end):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid = brio:ToMaid()
+		maid:GiveTask(ClipCharacters.new())
+	end))
+end
+
+function ClipCharactersServiceClient:Destroy()
+	self._maid:DoCleaning()
+end
+
+return ClipCharactersServiceClient

package/src/Server/ClipCharactersService.lua

@@ -0,0 +1,32 @@
+--[=[
+	@class ClipCharactersService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local PhysicsService = game:GetService("PhysicsService")
+
+local Maid = require("Maid")
+local ClipCharactersServiceConstants = require("ClipCharactersServiceConstants")
+
+local ClipCharactersService = {}
+ClipCharactersService.ServiceName = "ClipCharactersService"
+
+function ClipCharactersService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self:_setupPhysicsGroup()
+end
+
+function ClipCharactersService:_setupPhysicsGroup()
+	PhysicsService:RegisterCollisionGroup(ClipCharactersServiceConstants.COLLISION_GROUP_NAME)
+	PhysicsService:CollisionGroupSetCollidable(ClipCharactersServiceConstants.COLLISION_GROUP_NAME, "Default", false)
+end
+
+function ClipCharactersService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return ClipCharactersService

package/src/Shared/ClipCharactersServiceConstants.lua

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

package/test/default.project.json

@@ -0,0 +1,22 @@
+{
+  "name": "ClipCharactersTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "clipcharacters": {
+        "$path": ".."
+      },
+      "Script": {
+        "$path": "scripts/Server"
+      }
+    },
+    "StarterPlayer": {
+      "StarterPlayerScripts": {
+        "Main": {
+          "$path": "scripts/Client"
+        }
+      }
+    }
+  }
+}

package/test/scripts/Client/ClientMain.client.lua

@@ -0,0 +1,12 @@
+--[[
+	@class ClientMain
+]]
+local loader = game:GetService("ReplicatedStorage"):WaitForChild("clipcharacters"):WaitForChild("loader")
+local require = require(loader).bootstrapGame(loader.Parent)
+
+local serviceBag = require("ServiceBag").new()
+serviceBag:GetService(require("ClipCharactersServiceClient"))
+serviceBag:Init()
+serviceBag:Start()
+
+serviceBag:GetService(require("ClipCharactersServiceClient")):PushDisableCharacterCollisionsWithDefault()

package/test/scripts/Server/ServerMain.server.lua

@@ -0,0 +1,12 @@
+--[[
+	@class ServerMain
+]]
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local loader = ServerScriptService:FindFirstChild("LoaderUtils", true).Parent
+local require = require(loader).bootstrapGame(ServerScriptService.clipcharacters)
+
+local serviceBag = require("ServiceBag").new()
+serviceBag:GetService(require("ClipCharactersService"))
+serviceBag:Init()
+serviceBag:Start()

package/src/Shared/ClipCharacters.lua

@@ -1,141 +0,0 @@
---[=[
-	Clip characters locally on the client of other clients so they don't interfer with physics.
-	@class ClipCharacters
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local PhysicsService = game:GetService("PhysicsService")
-local Players = game:GetService("Players")
-
-local Maid = require("Maid")
-local GetRemoteFunction = require("GetRemoteFunction")
-
-local REMOTE_FUNCTION_NAME = "GetClipCharactersId"
-
-local ClipCharacters = {}
-ClipCharacters.ClassName = "ClipCharacters"
-ClipCharacters.__index = ClipCharacters
-ClipCharacters.COLLISION_GROUP_NAME = "ClipCharacters"
-
---[=[
-	Initialize on server
-	@server
-]=]
-function ClipCharacters.initServer()
-	local groupId = PhysicsService:CreateCollisionGroup(ClipCharacters.COLLISION_GROUP_NAME)
-	PhysicsService:CollisionGroupSetCollidable(ClipCharacters.COLLISION_GROUP_NAME, "Default", false)
-
-	local remoteFunction = GetRemoteFunction(REMOTE_FUNCTION_NAME)
-	remoteFunction.OnServerInvoke = function(_)
-		return groupId
-	end
-end
-
---[=[
-	Initialize clipping on the client. Returns a new inst
-	@client
-	@return ClipCharacters
-]=]
-function ClipCharacters.new()
-	local self = setmetatable({}, ClipCharacters)
-
-	self._remoteFunction = GetRemoteFunction(REMOTE_FUNCTION_NAME)
-
-	self._maid = Maid.new()
-	self:_bindUpdatesYielding()
-
-	return self
-end
-
-function ClipCharacters:_onDescendantAdded(originalTable, descendant)
-	if not originalTable[descendant] and descendant:IsA("BasePart") then
-		originalTable[descendant] = descendant.CollisionGroupId
-		descendant.CollisionGroupId = self._collisionGroupId
-	end
-end
-
-function ClipCharacters:_onDescendantRemoving(originalTable, descendant)
-	if originalTable[descendant] then
-		descendant.CollisionGroupId = originalTable[descendant]
-		originalTable[descendant] = nil
-	end
-end
-
-function ClipCharacters:_onCharacterAdd(playerMaid, character)
-	local maid = Maid.new()
-
-	local originalTable = {}
-
-	maid:GiveTask(character.DescendantAdded:Connect(function(descendant)
-		self:_onDescendantAdded(originalTable, descendant)
-	end))
-
-	maid:GiveTask(character.DescendantRemoving:Connect(function(descendant)
-		self:_onDescendantRemoving(originalTable, descendant)
-	end))
-
-	-- Cleanup
-	maid:GiveTask(function()
-		for descendant, _ in pairs(originalTable) do
-			self:_onDescendantRemoving(originalTable, descendant)
-		end
-	end)
-
-	-- Initialize
-	for _, descendant in pairs(character:GetDescendants()) do
-		self:_onDescendantAdded(originalTable, descendant)
-	end
-
-	playerMaid._characterMaid = maid
-end
-
-function ClipCharacters:_onPlayerAdded(player)
-	if player == Players.LocalPlayer then
-		return
-	end
-
-	local maid = Maid.new()
-
-	maid:GiveTask(player.CharacterAdded:Connect(function(character)
-		self:_onCharacterAdd(maid, character)
-	end))
-
-	if player.Character then
-		self:_onCharacterAdd(maid, player.Character)
-	end
-
-	self._maid[player] = maid
-end
-
-function ClipCharacters:_bindUpdatesYielding()
-	self._collisionGroupId = self._remoteFunction:InvokeServer()
-
-	if not self._collisionGroupId then
-		warn("[ClipCharacters] - No self._collisionGroupId")
-	end
-
-	for _, player in pairs(Players:GetPlayers()) do
-		self:_onPlayerAdded(player)
-	end
-
-	self._maid:GiveTask(Players.PlayerAdded:Connect(function(player)
-		self:_onPlayerAdded(player)
-	end))
-
-	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
-		self._maid[player] = nil
-	end))
-end
-
---[=[
-	Stop clipping on client
-]=]
-function ClipCharacters:Destroy()
-	self._maid:DoCleaning()
-	self._maid = nil
-
-	setmetatable({}, nil)
-end
-
-return ClipCharacters