Merge pull request #3 from OhmV-IR/DeathMarkers

Death markers

Author: NikeLaosClericus

NitroxClient/Communication/MultiplayerSession/ConnectionState/CommunicatingState.cs

@@ -1,4 +1,4 @@
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState

NitroxClient/Communication/Packets/Processors/DeathMarkersChangedProcessor.cs

@@ -0,0 +1,20 @@
+using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.GameLogic;
+using NitroxModel.Packets;
+
+namespace NitroxClient.Communication.Packets.Processors;
+
+public class DeathMarkersChangedProcessor : ClientPacketProcessor<DeathMarkersChanged>
+{
+    private readonly LocalPlayer localPlayer;
+
+    public DeathMarkersChangedProcessor(LocalPlayer localPlayer)
+    {
+        this.localPlayer = localPlayer;
+    }
+
+    public override void Process(DeathMarkersChanged packet)
+    {
+        localPlayer.MarkDeathPointsWithBeacon = packet.MarkDeathPointsWithBeacon;
+    }
+}

NitroxClient/Communication/Packets/Processors/PlayerDeathProcessor.cs

@@ -1,4 +1,4 @@
-using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.Communication.Packets.Processors.Abstract;
 using NitroxClient.GameLogic;
 using NitroxModel.Helper;
 using NitroxModel.Packets;
@@ -20,7 +20,6 @@ public override void Process(PlayerDeathEvent playerDeath)
         Log.Debug($"{player.PlayerName} died");
         Log.InGame(Language.main.Get("Nitrox_PlayerDied").Replace("{PLAYER}", player.PlayerName));
         player.PlayerDeathEvent.Trigger(player);
-
         // TODO: Add any death related triggers (i.e. scoreboard updates, rewards, etc.)
     }
 }

NitroxClient/GameLogic/InitialSync/PlayerInitialSyncProcessor.cs

@@ -35,6 +35,7 @@ public PlayerInitialSyncProcessor(Items item, ItemContainers itemContainers, Loc
         AddStep(sync => SetPlayerStats(sync.PlayerStatsData));
         AddStep(sync => SetPlayerGameMode(sync.GameMode));
         AddStep(sync => SetPlayerKeepInventoryOnDeath(sync.KeepInventoryOnDeath));
+        AddStep(sync => SetPlayerMarkDeathPointsWithBeacon(sync.MarkDeathPointsWithBeacon));
     }
 
     private void SetPlayerPermissions(Perms permissions)
@@ -141,4 +142,9 @@ private void SetPlayerKeepInventoryOnDeath(bool keepInventoryOnDeath)
     {
         localPlayer.KeepInventoryOnDeath = keepInventoryOnDeath;
     }
+
+    private void SetPlayerMarkDeathPointsWithBeacon(bool markDeathPointsWithBeacon)
+    {
+        localPlayer.MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
+    }
 }

NitroxClient/GameLogic/LocalPlayer.cs

@@ -37,10 +37,10 @@ public class LocalPlayer : ILocalNitroxPlayer
     /// </summary>
     public ushort? PlayerId => multiplayerSession?.Reservation?.PlayerId;
     public PlayerSettings PlayerSettings => multiplayerSession.PlayerSettings;
-
     public Perms Permissions { get; set; }
     public IntroCinematicMode IntroCinematicMode { get; set; }
     public bool KeepInventoryOnDeath { get; set; }
+    public bool MarkDeathPointsWithBeacon { get; set; }
 
     public LocalPlayer(IMultiplayerSession multiplayerSession, IPacketSender packetSender, ThrottledPacketSender throttledPacketSender)
     {
@@ -53,6 +53,7 @@ public LocalPlayer(IMultiplayerSession multiplayerSession, IPacketSender packetS
         Permissions = Perms.PLAYER;
         IntroCinematicMode = IntroCinematicMode.NONE;
         KeepInventoryOnDeath = false;
+        MarkDeathPointsWithBeacon = false;
     }
 
     public void BroadcastLocation(Vector3 location, Vector3 velocity, Quaternion bodyRotation, Quaternion aimingRotation)

NitroxClient/MonoBehaviours/Gui/InGame/DeathBeacon.cs

@@ -0,0 +1,38 @@
+using NitroxModel.DataStructures.Unity;
+using NitroxModel_Subnautica.DataStructures;
+using UnityEngine;
+
+namespace NitroxClient.MonoBehaviours.Gui.InGame;
+public class DeathBeacon : MonoBehaviour
+{
+    private const float DESPAWN_DISTANCE = 20f;
+    private const float DESPAWN_DISTANCE_SQUARED = DESPAWN_DISTANCE * DESPAWN_DISTANCE;
+    private const float CHECK_RATE = 1.5f; // in seconds
+
+    public static void SpawnDeathBeacon(NitroxVector3 location, string playerName)
+    {
+        GameObject beacon = new($"{playerName}DeathBeacon");
+        beacon.transform.position = location.ToUnity();
+        PingInstance signal = beacon.AddComponent<PingInstance>();
+        signal.pingType = PingType.Signal;
+        signal.origin = beacon.transform;
+        signal.minDist = DESPAWN_DISTANCE + 15f;
+        signal._label = Language.main.Get("Nitrox_PlayerDeathBeaconLabel").Replace("{PLAYER}", playerName);
+        beacon.AddComponent<DeathBeacon>();
+        signal.displayPingInManager = true;
+        signal.Initialize();
+    }
+
+    private void Start()
+    {
+        InvokeRepeating(nameof(CheckPlayerDistance), 0, CHECK_RATE);
+    }
+
+    private void CheckPlayerDistance()
+    {
+        if ((Player.main.transform.position - transform.position).sqrMagnitude <= DESPAWN_DISTANCE_SQUARED)
+        {
+            Destroy(gameObject);
+        }
+    }
+}

NitroxClient/MonoBehaviours/PlayerDeathBroadcaster.cs

@@ -1,4 +1,6 @@
 using NitroxClient.GameLogic;
+using NitroxClient.MonoBehaviours.Gui.InGame;
+using NitroxModel_Subnautica.DataStructures;
 using UnityEngine;
 
 namespace NitroxClient.MonoBehaviours;
@@ -16,6 +18,10 @@ public void Awake()
 
     private void PlayerDeath(Player player)
     {
+        if (localPlayer.MarkDeathPointsWithBeacon)
+        {
+            DeathBeacon.SpawnDeathBeacon(player.transform.position.ToDto(), localPlayer.PlayerName);
+        }
         localPlayer.BroadcastDeath(player.transform.position);
     }
 

NitroxModel/Packets/DeathMarkersChanged.cs

@@ -0,0 +1,11 @@
+namespace NitroxModel.Packets;
+
+public class DeathMarkersChanged : Packet
+{
+    public bool MarkDeathPointsWithBeacon { get; }
+
+    public DeathMarkersChanged(bool markDeathPointsWithBeacon)
+    {
+        MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
+    }
+}

NitroxModel/Packets/InitialPlayerSync.cs

@@ -36,6 +36,7 @@ public class InitialPlayerSync : Packet
         public bool IsFirstPlayer { get; }
         public Dictionary<NitroxId, int> BuildOperationIds { get; }
         public bool KeepInventoryOnDeath { get; }
+        public bool MarkDeathPointsWithBeacon { get; }
 
         public InitialPlayerSync(NitroxId playerGameObjectId,
             bool firstTimeConnecting,
@@ -59,7 +60,8 @@ public InitialPlayerSync(NitroxId playerGameObjectId,
             TimeData timeData,
             bool isFirstPlayer,
             Dictionary<NitroxId, int> buildOperationIds,
-            bool keepInventoryOnDeath)
+            bool keepInventoryOnDeath,
+            bool markDeathPointsWithBeacon)
         {
             AssignedEscapePodId = assignedEscapePodId;
             PlayerGameObjectId = playerGameObjectId;
@@ -84,6 +86,7 @@ public InitialPlayerSync(NitroxId playerGameObjectId,
             IsFirstPlayer = isFirstPlayer;
             BuildOperationIds = buildOperationIds;
             KeepInventoryOnDeath = keepInventoryOnDeath;
+            MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
         }
 
         /// <remarks>Used for deserialization</remarks>
@@ -110,7 +113,8 @@ public InitialPlayerSync(
             TimeData timeData,
             bool isFirstPlayer,
             Dictionary<NitroxId, int> buildOperationIds,
-            bool keepInventoryOnDeath)
+            bool keepInventoryOnDeath,
+            bool markDeathPointsWithBeacon)
         {
             AssignedEscapePodId = assignedEscapePodId;
             PlayerGameObjectId = playerGameObjectId;
@@ -135,6 +139,7 @@ public InitialPlayerSync(
             IsFirstPlayer = isFirstPlayer;
             BuildOperationIds = buildOperationIds;
             KeepInventoryOnDeath = keepInventoryOnDeath;
+            MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
         }
     }
 }

NitroxModel/Serialization/SubnauticaServerConfig.cs

@@ -30,6 +30,9 @@ public class SubnauticaServerConfig : NitroxConfig<SubnauticaServerConfig>
         [PropertyDescription("Prevents players from losing items on death")]
         public bool KeepInventoryOnDeath { get; set; } = false;
 
+        [PropertyDescription("Places a beacon where players die")]
+        public bool MarkDeathPointsWithBeacon { get; set; } = true;
+
         [PropertyDescription("Measured in milliseconds")]
         public int SaveInterval
         {

NitroxPatcher/Patches/Dynamic/Player_OnKill_Patch.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 using System.Reflection.Emit;
@@ -12,6 +12,7 @@ public sealed partial class Player_OnKill_Patch : NitroxPatch, IDynamicPatch
     private static readonly MethodInfo TARGET_METHOD = Reflect.Method((Player t) => t.OnKill(default(DamageType)));
 
     private static readonly MethodInfo SKIP_METHOD = Reflect.Method(() => GameModeUtils.IsPermadeath());
+
     public static IEnumerable<CodeInstruction> Transpiler(MethodBase original, IEnumerable<CodeInstruction> instructions)
     {
         List<CodeInstruction> instructionList = instructions.ToList();

NitroxServer/Communication/Packets/Processors/PlayerJoiningMultiplayerSessionProcessor.cs

@@ -87,7 +87,8 @@ public override void Process(PlayerJoiningMultiplayerSession packet, INitroxConn
                 storyManager.GetTimeData(),
                 isFirstPlayer,
                 BuildingManager.GetEntitiesOperations(globalRootEntities),
-                serverConfig.KeepInventoryOnDeath
+                serverConfig.KeepInventoryOnDeath,
+                serverConfig.MarkDeathPointsWithBeacon
             );
 
             player.SendPacket(initialPlayerSync);

NitroxServer/ConsoleCommands/SetDeathMarkersCommand.cs

@@ -0,0 +1,42 @@
+using System.IO;
+using NitroxModel.DataStructures.GameLogic;
+using NitroxModel.Packets;
+using NitroxModel.Serialization;
+using NitroxServer.ConsoleCommands.Abstract;
+using NitroxServer.ConsoleCommands.Abstract.Type;
+using NitroxServer.GameLogic;
+
+namespace NitroxServer.ConsoleCommands;
+
+internal class SetDeathMarkersCommand : Command
+{
+    private readonly PlayerManager playerManager;
+    private readonly SubnauticaServerConfig serverConfig;
+    private readonly Server server;
+
+    public SetDeathMarkersCommand(PlayerManager playerManager, SubnauticaServerConfig serverConfig, Server server) : base("setdeathmarkers", Perms.ADMIN, "Sets \"Death Markers\" setting to on/off. If \"on\", a beacon will appear at the location where a player dies.")
+    {
+        this.playerManager = playerManager;
+        this.serverConfig = serverConfig;
+        this.server = server;
+        AddParameter(new TypeBoolean("state", true, "the on/off state of if a death marker is spawned on death"));
+    }
+
+    protected override void Execute(CallArgs args)
+    {
+        bool newDeathMarkersState = args.Get<bool>(0);
+        using (serverConfig.Update(Path.Combine(KeyValueStore.Instance.GetSavesFolderDir(), server.Name)))
+        {
+            if (serverConfig.MarkDeathPointsWithBeacon != newDeathMarkersState)
+            {
+                serverConfig.MarkDeathPointsWithBeacon = newDeathMarkersState;
+                playerManager.SendPacketToAllPlayers(new DeathMarkersChanged(newDeathMarkersState));
+                SendMessageToAllPlayers($"MarkDeathPointsWithBeacon changed to \"{newDeathMarkersState}\" by {args.SenderName}");
+            }
+            else
+            {
+                SendMessage(args.Sender, $"MarkDeathPointsWithBeacon already set to {newDeathMarkersState}");
+            }
+        }
+    }
+}