@quenty/deathreport 1.3.0 → 1.4.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.
 
+# [1.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/deathreport@1.3.0...@quenty/deathreport@1.4.0) (2022-07-31)
+
+
+### Features
+
+* Add DeathReport support for weapon data ([010d5bd](https://github.com/Quenty/NevermoreEngine/commit/010d5bd760b456f52d1c50a5f6302e512ed57677))
+
+
+
+
+
 # [1.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/deathreport@1.2.0...@quenty/deathreport@1.3.0) (2022-07-02)
 
 **Note:** Version bump only for package @quenty/deathreport

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/deathreport",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Death report service which will track the deaths of players",
   "keywords": [
     "Roblox",
@@ -29,19 +29,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^5.0.0",
-    "@quenty/binder": "^6.2.0",
-    "@quenty/characterutils": "^5.1.0",
+    "@quenty/baseobject": "^5.1.0",
+    "@quenty/binder": "^6.3.0",
+    "@quenty/characterutils": "^5.2.0",
     "@quenty/humanoidkillerutils": "^2.2.0",
     "@quenty/loader": "^5.0.0",
-    "@quenty/maid": "^2.3.0",
-    "@quenty/playerhumanoidbinder": "^6.2.0",
-    "@quenty/remoting": "^5.1.0",
-    "@quenty/rx": "^5.1.0",
-    "@quenty/rxbinderutils": "^6.2.0",
-    "@quenty/servicebag": "^5.0.0",
+    "@quenty/maid": "^2.4.0",
+    "@quenty/playerhumanoidbinder": "^6.3.0",
+    "@quenty/remoting": "^5.2.0",
+    "@quenty/rx": "^5.2.0",
+    "@quenty/rxbinderutils": "^6.3.0",
+    "@quenty/servicebag": "^5.1.0",
     "@quenty/signal": "^2.2.0",
     "@quenty/table": "^3.1.0"
   },
-  "gitHead": "de33c83e7f897e2b0887c77aeb1fc7963756f234"
+  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
 }

package/src/Client/DeathReportServiceClient.lua

@@ -72,6 +72,26 @@ function DeathReportServiceClient:ObservePlayerDeathReports(player)
 	return self._reportProcessor:ObservePlayerDeathReports(player)
 end
 
+--[=[
+	Observes killer reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportServiceClient:ObserveHumanoidKillerReports(humanoid)
+	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
+end
+
+--[=[
+	Observes death reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportServiceClient:ObserveHumanoidDeathReports(humanoid)
+	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)
+end
+
 --[=[
 	Gets the last recorded death reports
 	@return { DeathReport }

package/src/Server/DeathReportService.lua

@@ -39,6 +39,32 @@ function DeathReportService:Init(serviceBag)
 
 	self._reportProcessor = DeathReportProcessor.new()
 	self._maid:GiveTask(self._reportProcessor)
+
+	self._weaponDataRetrievers = {}
+end
+
+function DeathReportService:AddWeaponDataRetriever(getWeaponData)
+	table.insert(self._weaponDataRetrievers, getWeaponData)
+
+	return function()
+		local index = table.find(self._weaponDataRetrievers, getWeaponData)
+		if index then
+			table.remove(self._weaponDataRetrievers, index)
+		end
+	end
+end
+
+function DeathReportService:FindWeaponData(humanoid)
+	for _, item in pairs(self._weaponDataRetrievers) do
+		local result = item(humanoid)
+		if result then
+			assert(DeathReportUtils.isWeaponData(result), "Failed to return valid weaponData")
+
+			return result
+		end
+	end
+
+	return nil
 end
 
 --[=[
@@ -61,14 +87,35 @@ function DeathReportService:ObservePlayerDeathReports(player)
 	return self._reportProcessor:ObservePlayerDeathReports(player)
 end
 
+--[=[
+	Observes killer reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportService:ObserveHumanoidKillerReports(humanoid)
+	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
+end
+
+--[=[
+	Observes death reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportService:ObserveHumanoidDeathReports(humanoid)
+	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)
+end
+
 --[=[
 	Reports the death of a humanoid. This is called automatically
 	by [DeathTrackedHumanoid].
 
 	@param humanoid Humanoid -- Humanoid that died
+	@param weaponData WeaponData? -- Weapon data to report
 ]=]
-function DeathReportService:ReportDeath(humanoid)
-	local report = DeathReportUtils.fromDeceasedHumanoid(humanoid)
+function DeathReportService:ReportDeath(humanoid, weaponData)
+	local report = DeathReportUtils.fromDeceasedHumanoid(humanoid, weaponData or self:FindWeaponData(humanoid))
 
 	-- Notify services
 	self.NewDeathReport:Fire(report)

package/src/Server/Stats/PlayerKillTrackerAssigner.lua

@@ -21,6 +21,8 @@ function PlayerKillTrackerAssigner.new(serviceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._deathReportBindersServer = self._serviceBag:GetService(DeathReportBindersServer)
 
+	self._killTrackers = {}
+
 	self._maid:GiveTask(Players.PlayerAdded:Connect(function(player)
 		self:_handlePlayerAdded(player)
 	end))
@@ -35,6 +37,24 @@ function PlayerKillTrackerAssigner.new(serviceBag)
 	return self
 end
 
+function PlayerKillTrackerAssigner:GetPlayerKills(player)
+	local tracker = self:GetPlayerKillTracker(player)
+	if tracker then
+		return tracker:GetKills()
+	else
+		return nil
+	end
+end
+
+function PlayerKillTrackerAssigner:GetPlayerKillTracker(player)
+	local trackerInstance = self._killTrackers[player]
+	if trackerInstance then
+		return self._deathReportBindersServer.PlayerKillTracker:Get(trackerInstance)
+	else
+		return nil
+	end
+end
+
 function PlayerKillTrackerAssigner:_handlePlayerRemoving(player)
 	self._maid[player] = nil
 end
@@ -45,6 +65,12 @@ function PlayerKillTrackerAssigner:_handlePlayerAdded(player)
 	local killTracker = PlayerKillTrackerUtils.create(self._deathReportBindersServer.PlayerKillTracker, player)
 	maid:GiveTask(killTracker)
 
+	self._killTrackers[player] = killTracker
+
+	maid:GiveTask(function()
+		self._killTrackers[player] = nil
+	end)
+
 	local deathTracker = PlayerKillTrackerUtils.create(self._deathReportBindersServer.PlayerDeathTracker, player)
 	maid:GiveTask(deathTracker)
 

package/src/Shared/DeathReportProcessor.lua

@@ -23,6 +23,12 @@ function DeathReportProcessor.new()
 	self._playerDeathSubTable = ObservableSubscriptionTable.new()
 	self._maid:GiveTask(self._playerDeathSubTable)
 
+	self._humanoidKillerSubTable = ObservableSubscriptionTable.new()
+	self._maid:GiveTask(self._humanoidKillerSubTable)
+
+	self._humanoidDeathSubTable = ObservableSubscriptionTable.new()
+	self._maid:GiveTask(self._humanoidDeathSubTable)
+
 	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
 		self._playerKillerSubTable:Complete(player)
 		self._playerDeathSubTable:Complete(player)
@@ -55,6 +61,30 @@ function DeathReportProcessor:ObservePlayerDeathReports(player)
 	return self._playerDeathSubTable:Observe(player)
 end
 
+--[=[
+	Observes death reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportProcessor:ObserveHumanoidDeathReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
+	return self._humanoidDeathSubTable:Observe(humanoid)
+end
+
+--[=[
+	Observes killer reports for the given humanoid
+
+	@param humanoid Humanoid
+	@return Observable<DeathReport>
+]=]
+function DeathReportProcessor:ObserveHumanoidKillerReports(humanoid)
+	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
+
+	return self._humanoidKillerSubTable:Observe(humanoid)
+end
+
 --[=[
 	Handles the death report
 
@@ -67,9 +97,17 @@ function DeathReportProcessor:HandleDeathReport(deathReport)
 		self._playerKillerSubTable:Fire(deathReport.killerPlayer, deathReport)
 	end
 
+	if deathReport.killerHumanoid then
+		self._humanoidKillerSubTable:Fire(deathReport.killerHumanoid, deathReport)
+	end
+
 	if deathReport.player then
 		self._playerDeathSubTable:Fire(deathReport.player, deathReport)
 	end
+
+	if deathReport.humanoid then
+		self._humanoidDeathSubTable:Fire(deathReport.humanoid, deathReport)
+	end
 end
 
 return DeathReportProcessor

package/src/Shared/DeathReportUtils.lua

@@ -15,33 +15,54 @@ local DeathReportUtils = {}
 	Constructs a new DeathReport from a humanoid
 
 	@param humanoid Humanomid
+	@param weaponData WeaponData
 	@return DeathReport
 ]=]
-function DeathReportUtils.fromDeceasedHumanoid(humanoid)
+function DeathReportUtils.fromDeceasedHumanoid(humanoid, weaponData)
+	assert(DeathReportUtils.isWeaponData(weaponData) or weaponData == nil, "Bad weaponData")
+
 	return {
 		adornee = humanoid.Parent;
 		humanoid = humanoid;
 		player = CharacterUtils.getPlayerFromCharacter(humanoid);
 		killerHumanoid = HumanoidKillerUtils.getKillerHumanoidOfHumanoid(humanoid);
 		killerPlayer = HumanoidKillerUtils.getPlayerKillerOfHumanoid(humanoid);
-		weaponData = DeathReportUtils.createWeaponData();
+		weaponData = weaponData or DeathReportUtils.createWeaponData(nil);
 	}
 end
 
+--[=[
+	Returns true if a DeathReport
+
+	@param deathReport any
+	@return boolean
+]=]
 function DeathReportUtils.isDeathReport(deathReport)
 	return type(deathReport) == "table"
 		and typeof(deathReport.humanoid) == "Instance"
 end
 
+--[=[
+	Returns true if a WeaponData
+
+	@param weaponData any
+	@return boolean
+]=]
+function DeathReportUtils.isWeaponData(weaponData)
+	return type(weaponData) == "table" and (typeof(weaponData.weaponInstance) == "Instance" or weaponData.weaponInstance == nil)
+end
+
 --[=[
 	Creates weapon data information
 
+	@param weaponInstance Instance?
 	@return WeaponData
 ]=]
-function DeathReportUtils.createWeaponData()
+function DeathReportUtils.createWeaponData(weaponInstance)
+	assert(typeof(weaponInstance) == "Instance" or weaponInstance == nil, "Bad weaponInstance")
+
 	return {
-		weaponKey = "test";
-		weaponInstance = nil;
+		weaponInstance = weaponInstance;
 	}
 end
 
@@ -137,6 +158,10 @@ function DeathReportUtils.getKillerColor(deathReport)
 	return nil
 end
 
+--[=[
+	Gets the default color of a death report to use.
+	@return Color3
+]=]
 function DeathReportUtils.getDefaultColor()
 	return DEFAULT_COLOR
 end