Add feature to show death message only from teammates

Author: DiFFoZ

OpenDeathMessages/API/DisplayType.cs

@@ -0,0 +1,8 @@
+namespace EvolutionPlugins.OpenDeathMessages.Services
+{
+    public enum DisplayType
+    {
+        Global,
+        Group
+    }
+}

OpenDeathMessages/API/IPlayerMessager.cs

@@ -0,0 +1,16 @@
+using EvolutionPlugins.OpenDeathMessages.Services;
+using OpenMod.API.Ioc;
+using OpenMod.Unturned.Players;
+using System.Drawing;
+using System.Threading.Tasks;
+
+namespace EvolutionPlugins.OpenDeathMessages.API
+{
+    [Service]
+    public interface IPlayerMessager
+    {
+        Task SendMessageGlobalOrGroupAsync(UnturnedPlayer player, string message, string? iconUrl, Color color);
+
+        Task ChangeDisplayTypeAsync(UnturnedPlayer player, DisplayType displayType);
+    }
+}

OpenDeathMessages/Commands/CommandDeathMessageDisplay.cs

@@ -0,0 +1,55 @@
+using Cysharp.Threading.Tasks;
+using EvolutionPlugins.OpenDeathMessages.API;
+using EvolutionPlugins.OpenDeathMessages.Services;
+using Microsoft.Extensions.Configuration;
+using OpenMod.Core.Commands;
+using OpenMod.Unturned.Commands;
+using OpenMod.Unturned.Users;
+using System;
+
+namespace EvolutionPlugins.OpenDeathMessages.Commands
+{
+    [Command("deathmessagedisplay")]
+    [CommandAlias("dmd")]
+    [CommandActor(typeof(UnturnedUser))]
+    [CommandSyntax("<group|global>")]
+    public class CommandDeathMessageDisplay : UnturnedCommand
+    {
+        private readonly IPlayerMessager m_PlayerMessager;
+        private readonly IConfiguration m_Configuration;
+
+        public CommandDeathMessageDisplay(IServiceProvider serviceProvider, IPlayerMessager playerMessager, IConfiguration configuration) : base(serviceProvider)
+        {
+            m_PlayerMessager = playerMessager;
+            m_Configuration = configuration;
+        }
+
+        protected override async UniTask OnExecuteAsync()
+        {
+            if (Context.Parameters.Count != 1)
+            {
+                throw new CommandWrongUsageException(Context);
+            }
+
+            var displayType = DisplayType.Global;
+            var displayTypeString = Context.Parameters[0];
+            if (displayTypeString.Equals("group", StringComparison.InvariantCultureIgnoreCase))
+            {
+                displayType = DisplayType.Group;
+            }
+            else if (displayTypeString.Equals("global", StringComparison.InvariantCultureIgnoreCase))
+            {
+                displayType = DisplayType.Global;
+            }
+            else
+            {
+                throw new CommandWrongUsageException(Context);
+            }
+
+            var user = (UnturnedUser)Context.Actor;
+            await m_PlayerMessager.ChangeDisplayTypeAsync(user.Player, displayType);
+
+            await PrintAsync(m_Configuration[$"commands:deathMessageDisplay:{(displayType is DisplayType.Global ? "global" : "group")}"]);
+        }
+    }
+}

…DeathMessages/Events/PlayerDeathEvent.cs …ents/UnturnedPlayerDeathEventListener.csOpenDeathMessages/Events/PlayerDeathEvent.cs renamed to OpenDeathMessages/Events/UnturnedPlayerDeathEventListener.cs OpenDeathMessages/Events/PlayerDeathEvent.cs renamed to OpenDeathMessages/Events/UnturnedPlayerDeathEventListener.cs

@@ -1,8 +1,7 @@
-using EvolutionPlugins.Universal.Extras.Broadcast;
+using EvolutionPlugins.OpenDeathMessages.API;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Localization;
 using OpenMod.API.Eventing;
-using OpenMod.API.Users;
 using OpenMod.Unturned.Locations;
 using OpenMod.Unturned.Players.Life.Events;
 using OpenMod.Unturned.Users;
@@ -12,25 +11,23 @@
 
 namespace EvolutionPlugins.OpenDeathMessages.Events
 {
-    public class PlayerDeathEvent : IEventListener<UnturnedPlayerDeathEvent>
+    public class UnturnedPlayerDeathEventListener : IEventListener<UnturnedPlayerDeathEvent>
     {
         private readonly IUnturnedUserDirectory m_UnturnedUserDirectory;
-        private readonly IUserManager m_UserManager;
         private readonly IStringLocalizer m_StringLocalizer;
         private readonly IConfiguration m_Configuration;
-        private readonly IBroadcastManager m_BroadcastManager;
         private readonly IUnturnedLocationDirectory m_UnturnedLocationDirectory;
+        private readonly IPlayerMessager m_PlayerMessager;
 
-        public PlayerDeathEvent(IUnturnedUserDirectory unturnedUserDirectory, IUserManager userManager,
-            IStringLocalizer stringLocalizer, IConfiguration configuration, IBroadcastManager broadcastManager,
-            IUnturnedLocationDirectory unturnedLocationDirectory)
+        public UnturnedPlayerDeathEventListener(IUnturnedUserDirectory unturnedUserDirectory,
+            IStringLocalizer stringLocalizer, IConfiguration configuration,
+            IUnturnedLocationDirectory unturnedLocationDirectory, IPlayerMessager playerMessager)
         {
             m_UnturnedUserDirectory = unturnedUserDirectory;
-            m_UserManager = userManager;
             m_StringLocalizer = stringLocalizer;
             m_Configuration = configuration;
-            m_BroadcastManager = broadcastManager;
             m_UnturnedLocationDirectory = unturnedLocationDirectory;
+            m_PlayerMessager = playerMessager;
         }
 
         public async Task HandleEventAsync(object? sender, UnturnedPlayerDeathEvent @event)
@@ -65,7 +62,8 @@ public async Task HandleEventAsync(object? sender, UnturnedPlayerDeathEvent @eve
                 return;
             }
 
-            await m_BroadcastManager.BroadcastAsync(message, m_Configuration["iconUrl"], ColorTranslator.FromHtml(m_Configuration["color"]));
+            await m_PlayerMessager.SendMessageGlobalOrGroupAsync(victimUser.Player, message,
+                m_Configuration["iconUrl"], ColorTranslator.FromHtml(m_Configuration["color"]));
         }
     }
 }

OpenDeathMessages/EvolutionPlugins.OpenDeathMessages.csproj

@@ -24,11 +24,11 @@
 
   <ItemGroup>
     <PackageReference Include="EvolutionPlugins.Universal.Extras.Unturned" Version="1.0.1" />
-    <PackageReference Include="OpenMod.Unturned" Version="3.1.3" />
+    <PackageReference Include="OpenMod.Unturned" Version="3.3.4" />
     <PackageReference Include="Legacy2CPSWorkaround" Version="1.0.0">
       <PrivateAssets>All</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies.net461" Version="1.0.2">
+    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies.net461" Version="1.0.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

OpenDeathMessages/ServiceConfigurator.cs

@@ -0,0 +1,60 @@
+using Cysharp.Threading.Tasks;
+using EvolutionPlugins.OpenDeathMessages.API;
+using Microsoft.Extensions.Configuration;
+using OpenMod.API.Ioc;
+using OpenMod.UnityEngine.Extensions;
+using OpenMod.Unturned.Players;
+using SDG.Unturned;
+using Steamworks;
+using System.Collections.Generic;
+using System.Drawing;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace EvolutionPlugins.OpenDeathMessages.Services
+{
+    [PluginServiceImplementation]
+    public class PlayerMessager : IPlayerMessager
+    {
+        private readonly DisplayType m_DisplayType;
+        private readonly HashSet<CSteamID> m_GroupOnlyMessagger = new();
+
+        public PlayerMessager(IConfiguration configuration)
+        {
+            m_DisplayType = (DisplayType)(configuration.GetValue("defaultDisplay:groupDeath", false) ? 1 : 0);
+        }
+
+        private bool ShouldMessageToGroup(UnturnedPlayer player) => m_GroupOnlyMessagger.Contains(player.SteamId) || m_DisplayType is DisplayType.Group;
+
+        public Task ChangeDisplayTypeAsync(UnturnedPlayer player, DisplayType displayType)
+        {
+            if (displayType is DisplayType.Group)
+            {
+                m_GroupOnlyMessagger.Add(player.SteamId);
+                return Task.CompletedTask;
+            }
+
+            m_GroupOnlyMessagger.Remove(player.SteamId);
+            return Task.CompletedTask;
+        }
+
+        public async Task SendMessageGlobalOrGroupAsync(UnturnedPlayer player, string message, string? iconUrl, Color color)
+        {
+            var unityColor = color.ToUnityColor();
+            await UniTask.SwitchToMainThread();
+
+            if (ShouldMessageToGroup(player))
+            {
+                foreach (var teammate in Provider.clients
+                    .Where(x => !x.player.quests.isMemberOfAGroup || x.player.quests.isMemberOfSameGroupAs(player.Player)))
+                {
+                    ChatManager.serverSendMessage(message, unityColor, toPlayer: teammate, iconURL: iconUrl, useRichTextFormatting: true);
+                }
+
+                return;
+            }
+
+            ChatManager.serverSendMessage(message, unityColor, iconURL: iconUrl, mode: EChatMode.GLOBAL, useRichTextFormatting: true);
+        }
+    }
+}

OpenDeathMessages/Services/PlayerMessager.cs

@@ -1,3 +1,8 @@
 iconUrl: "https://i.imgur.com/Ld1qy8j.png"
 # it can support hex color (#FFFFFF)
-color: "white"
+color: "white"
+
+defaultDisplay:
+# If enabled then players will only see death messages from teammates.
+# If player is not in group then all death messages will be received.
+  groupDeath: false

OpenDeathMessages/config.yaml

@@ -62,3 +62,8 @@ deathCause:
   burner: "{Victim.DisplayName} was burned by a zombie"
   spit: "{Victim.DisplayName} was dissolved by a zombie"
   spark: "{Victim.DisplayName} was electrocuted by a zombie"
+
+commands:
+  deathMessageDisplay:
+    group: "Successfully set death messages display to GROUP"
+    global: "Successfully set death messsage display to GLOBAL"