@quenty/deathreport 3.26.0 → 3.27.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.
 
+# [3.27.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/deathreport@3.26.0...@quenty/deathreport@3.27.0) (2023-08-01)
+
+
+### Features
+
+* Add DeathReportServiceClient:ObserveCharacterKillerReports(character) and DeathReportServiceClient:ObserveCharacterDeathReports(character) ([1c1d32e](https://github.com/Quenty/NevermoreEngine/commit/1c1d32eb0bae543b11a06e022aa400a40b6be73f))
+
+
+
+
+
 # [3.26.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/deathreport@3.25.0...@quenty/deathreport@3.26.0) (2023-07-28)
 
 **Note:** Version bump only for package @quenty/deathreport

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/deathreport",
-  "version": "3.26.0",
+  "version": "3.27.0",
   "description": "Death report service which will track the deaths of players",
   "keywords": [
     "Roblox",
@@ -30,18 +30,18 @@
   },
   "dependencies": {
     "@quenty/baseobject": "^6.2.1",
-    "@quenty/binder": "^8.23.0",
+    "@quenty/binder": "^8.24.0",
     "@quenty/characterutils": "^6.12.0",
     "@quenty/humanoidkillerutils": "^2.2.0",
     "@quenty/loader": "^6.2.1",
     "@quenty/maid": "^2.5.0",
-    "@quenty/playerhumanoidbinder": "^8.23.0",
+    "@quenty/playerhumanoidbinder": "^8.24.0",
     "@quenty/remoting": "^6.9.0",
     "@quenty/rx": "^7.14.0",
-    "@quenty/rxbinderutils": "^8.24.0",
+    "@quenty/rxbinderutils": "^8.25.0",
     "@quenty/servicebag": "^6.8.0",
     "@quenty/signal": "^2.4.0",
     "@quenty/table": "^3.2.0"
   },
-  "gitHead": "539b6bcf1266fb18e143059d08381654cca200bd"
+  "gitHead": "839b4d929e4d6154aadf719f1ecfb9add4c8b247"
 }

package/src/Client/DeathReportServiceClient.lua

@@ -60,6 +60,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportServiceClient:ObservePlayerKillerReports(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
 	return self._reportProcessor:ObservePlayerKillerReports(player)
 end
 
@@ -70,6 +72,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportServiceClient:ObservePlayerDeathReports(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
 	return self._reportProcessor:ObservePlayerDeathReports(player)
 end
 
@@ -80,6 +84,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportServiceClient:ObserveHumanoidKillerReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
 	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
 end
 
@@ -90,9 +96,35 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportServiceClient:ObserveHumanoidDeathReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
 	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)
 end
 
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportServiceClient:ObserveCharacterKillerReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._reportProcessor:ObserveCharacterKillerReports(character)
+end
+
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportServiceClient:ObserveCharacterDeathReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._reportProcessor:ObserveCharacterDeathReports(character)
+end
+
 --[=[
 	Gets the last recorded death reports
 	@return { DeathReport }

package/src/Server/DeathReportService.lua

@@ -75,6 +75,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportService:ObservePlayerKillerReports(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
 	return self._reportProcessor:ObservePlayerKillerReports(player)
 end
 
@@ -85,6 +87,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportService:ObservePlayerDeathReports(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
 	return self._reportProcessor:ObservePlayerDeathReports(player)
 end
 
@@ -95,6 +99,8 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportService:ObserveHumanoidKillerReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
 	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
 end
 
@@ -105,9 +111,35 @@ end
 	@return Observable<DeathReport>
 ]=]
 function DeathReportService:ObserveHumanoidDeathReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
 	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)
 end
 
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportService:ObserveCharacterKillerReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._reportProcessor:ObserveCharacterKillerReports(character)
+end
+
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportService:ObserveCharacterDeathReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._reportProcessor:ObserveCharacterDeathReports(character)
+end
+
 --[=[
 	Reports the death of a humanoid. This is called automatically
 	by [DeathTrackedHumanoid].

package/src/Shared/DeathReportProcessor.lua

@@ -1,4 +1,6 @@
 --[=[
+	Handles shared observable subscription tables for the client and server
+
 	@class DeathReportProcessor
 ]=]
 
@@ -29,6 +31,12 @@ function DeathReportProcessor.new()
 	self._humanoidDeathSubTable = ObservableSubscriptionTable.new()
 	self._maid:GiveTask(self._humanoidDeathSubTable)
 
+	self._characterKillerSubTable = ObservableSubscriptionTable.new()
+	self._maid:GiveTask(self._characterKillerSubTable)
+
+	self._characterDeathSubTable = ObservableSubscriptionTable.new()
+	self._maid:GiveTask(self._characterDeathSubTable)
+
 	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
 		self._playerKillerSubTable:Complete(player)
 		self._playerDeathSubTable:Complete(player)
@@ -85,6 +93,31 @@ function DeathReportProcessor:ObserveHumanoidKillerReports(humanoid)
 	return self._humanoidKillerSubTable:Observe(humanoid)
 end
 
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportProcessor:ObserveCharacterKillerReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._characterKillerSubTable:Observe(character)
+end
+
+--[=[
+	Observes killer reports for the given character
+
+	@param character Model
+	@return Observable<DeathReport>
+]=]
+function DeathReportProcessor:ObserveCharacterDeathReports(character)
+	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
+
+	return self._characterDeathSubTable:Observe(character)
+end
+
+
 --[=[
 	Handles the death report
 
@@ -99,6 +132,11 @@ function DeathReportProcessor:HandleDeathReport(deathReport)
 
 	if deathReport.killerHumanoid then
 		self._humanoidKillerSubTable:Fire(deathReport.killerHumanoid, deathReport)
+
+		local character = deathReport.killerHumanoid.Parent
+		if character then
+			self._characterKillerSubTable:Fire(character, deathReport)
+		end
 	end
 
 	if deathReport.player then
@@ -107,6 +145,11 @@ function DeathReportProcessor:HandleDeathReport(deathReport)
 
 	if deathReport.humanoid then
 		self._humanoidDeathSubTable:Fire(deathReport.humanoid, deathReport)
+
+		local character = deathReport.humanoid.Parent
+		if character then
+			self._characterDeathSubTable:Fire(character, deathReport)
+		end
 	end
 end