@quenty/humanoidtracker 8.3.1-canary.d08dd64.0 → 8.4.0

package/CHANGELOG.md

@@ -3,9 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [8.3.1-canary.d08dd64.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidtracker@8.3.0...@quenty/humanoidtracker@8.3.1-canary.d08dd64.0) (2024-01-01)
+# [8.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidtracker@8.3.0...@quenty/humanoidtracker@8.4.0) (2024-01-08)
 
-**Note:** Version bump only for package @quenty/humanoidtracker
+
+### Features
+
+* Add HumanoidTrackerService API methods that allow for use on server too ([e674fda](https://github.com/Quenty/NevermoreEngine/commit/e674fda95746f87e052da7087aea298084dfb381))
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/humanoidtracker",
-  "version": "8.3.1-canary.d08dd64.0",
+  "version": "8.4.0",
   "description": "HumanoidTracker for Roblox - Tracks a player's character's humanoid",
   "keywords": [
     "Roblox",
@@ -25,14 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "7.1.1-canary.d08dd64.0",
-    "@quenty/maid": "2.6.0",
-    "@quenty/promise": "7.1.1-canary.d08dd64.0",
-    "@quenty/signal": "3.1.1-canary.d08dd64.0",
-    "@quenty/valueobject": "8.3.1-canary.d08dd64.0"
+    "@quenty/baseobject": "^7.2.0",
+    "@quenty/loader": "^7.3.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.2.0",
+    "@quenty/signal": "^3.2.0",
+    "@quenty/valueobject": "^8.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d08dd641615f51bc83b2fe46f11f41bd95acdec1"
+  "gitHead": "075fb03a03f12ade8758f667767ba738204e0c4b"
 }

package/src/Shared/HumanoidTracker.lua

@@ -9,8 +9,9 @@ local Maid = require("Maid")
 local Signal = require("Signal")
 local ValueObject = require("ValueObject")
 local Promise = require("Promise")
+local BaseObject = require("BaseObject")
 
-local HumanoidTracker = {}
+local HumanoidTracker = setmetatable({}, BaseObject)
 HumanoidTracker.ClassName = "HumanoidTracker"
 HumanoidTracker.__index = HumanoidTracker
 
@@ -42,18 +43,17 @@ HumanoidTracker.__index = HumanoidTracker
 	@return HumanoidTracker
 ]=]
 function HumanoidTracker.new(player)
-	local self = setmetatable({}, HumanoidTracker)
+	local self = setmetatable(BaseObject.new(), HumanoidTracker)
 
 	self._player = player or error("No player")
-	self._maid = Maid.new()
+
+	self.HumanoidDied = self._maid:Add(Signal.new())
 
 	-- Tracks the current character humanoid, may be nil
-	self.Humanoid = ValueObject.new()
-	self._maid:GiveTask(self.Humanoid)
+	self.Humanoid = self._maid:Add(ValueObject.new())
 
 	-- Tracks the alive humanoid, may be nil
-	self.AliveHumanoid = ValueObject.new()
-	self._maid:GiveTask(self.AliveHumanoid)
+	self.AliveHumanoid = self._maid:Add(ValueObject.new())
 
 	self._maid:GiveTask(self.Humanoid.Changed:Connect(function(newHumanoid, oldHumanoid, maid)
 		if not self.Destroy then
@@ -69,9 +69,6 @@ function HumanoidTracker.new(player)
 		self:_onCharacterChanged()
 	end))
 
-	self.HumanoidDied = Signal.new()
-	self._maid:GiveTask(self.HumanoidDied)
-
 	self:_onCharacterChanged()
 
 	return self
@@ -168,12 +165,4 @@ function HumanoidTracker:_handleHumanoidChanged(newHumanoid, _, maid)
 	end))
 end
 
---[=[
-	Cleans up the humanoid tracker and sets the metatable to be nil.
-]=]
-function HumanoidTracker:Destroy()
-	self._maid:DoCleaning()
-	setmetatable(self, nil)
-end
-
 return HumanoidTracker

package/src/Shared/HumanoidTrackerService.lua

@@ -0,0 +1,150 @@
+--[=[
+	Centralized humanoid tracking service.
+
+	@class HumanoidTrackerService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Players = game:GetService("Players")
+
+local HumanoidTracker = require("HumanoidTracker")
+local Maid = require("Maid")
+
+local HumanoidTrackerService = {}
+HumanoidTrackerService.ServiceName = "HumanoidTrackerService"
+
+function HumanoidTrackerService:Init()
+	assert(not self._maid, "Already initialized")
+	self._maid = Maid.new()
+
+	self._humanoidTrackerMap = {}
+
+	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
+		self._maid[player] = nil
+	end))
+end
+
+--[=[
+	Gets a humanoid tracker for a given player
+
+	@param player Player? -- If not set, uses local player
+	@return HumanoidTracker
+]=]
+function HumanoidTrackerService:GetHumanoidTracker(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+
+	if self._humanoidTrackerMap[player] then
+		return self._humanoidTrackerMap[player]
+	else
+		local maid = Maid.new()
+		local tracker = maid:Add(HumanoidTracker.new(player))
+
+		maid:GiveTask(function()
+			self._maid[player] = nil
+			self._humanoidTrackerMap[player] = nil
+		end)
+
+		self._maid[player] = maid
+		self._humanoidTrackerMap[player] = tracker
+
+		return tracker
+	end
+end
+
+--[=[
+	Gets a player's humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Humanoid?
+]=]
+function HumanoidTrackerService:GetHumanoid(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+	return self:GetHumanoidTracker(player).Humanoid.Value
+end
+
+--[=[
+	Observe a player's humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Observable<Humanoid | nil>
+]=]
+function HumanoidTrackerService:ObserveHumanoid(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+
+	return self:GetHumanoidTracker(player).Humanoid:Observe()
+end
+
+--[=[
+	Observe a player's humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Observable<Brio<Humanoid>>
+]=]
+function HumanoidTrackerService:ObserveHumanoidBrio(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+
+	return self:GetHumanoidTracker(player).Humanoid:ObserveBrio(function(value)
+		return value ~= nil
+	end)
+end
+
+--[=[
+	Gets a player's alive humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Humanoid?
+]=]
+function HumanoidTrackerService:GetAliveHumanoid(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+	return self:GetHumanoidTracker(player).AliveHumanoid.Value
+end
+
+--[=[
+	Observe a player's alive humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Observable<Humanoid | nil>
+]=]
+function HumanoidTrackerService:ObserveAliveHumanoid(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+
+	return self:GetHumanoidTracker(player).AliveHumanoid:Observe()
+end
+
+--[=[
+	Observe a player's alive humanoid
+
+	@param player Player? -- If not set, uses local player
+	@return Observable<Brio<Humanoid>>
+]=]
+function HumanoidTrackerService:ObserveAliveHumanoidBrio(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	player = player or Players.LocalPlayer
+
+	return self:GetHumanoidTracker(player).AliveHumanoid:ObserveBrio(function(value)
+		return value ~= nil
+	end)
+end
+
+--[=[
+	Cleans up the humanoid tracking service
+]=]
+function HumanoidTrackerService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return HumanoidTrackerService

package/src/Client/HumanoidTrackerService.lua

@@ -1,26 +0,0 @@
---[=[
-	@class HumanoidTrackerService
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Players = game:GetService("Players")
-
-local HumanoidTracker = require("HumanoidTracker")
-
-local HumanoidTrackerService = {}
-HumanoidTrackerService.ServiceName = "HumanoidTrackerService"
-
-function HumanoidTrackerService:Init()
-	assert(not self._humanoidTracker, "Already initialized")
-
-	self._humanoidTracker = HumanoidTracker.new(Players.LocalPlayer)
-end
-
-function HumanoidTrackerService:GetHumanoidTracker()
-	assert(self._humanoidTracker, "Not initialized")
-
-	return self._humanoidTracker
-end
-
-return HumanoidTrackerService