Death markers setting

Nitrox.Model.Subnautica/Packets/DeathMarkersChanged.cs

@@ -0,0 +1,15 @@
+using System;
+using Nitrox.Model.Packets;
+
+namespace NitroxModel.Packets;
+
+[Serializable]
+public class DeathMarkersChanged : Packet
+{
+    public bool MarkDeathPointsWithBeacon { get; }
+
+    public DeathMarkersChanged(bool markDeathPointsWithBeacon)
+    {
+        MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
+    }
+}

Nitrox.Model.Subnautica/Packets/InitialPlayerSync.cs

@@ -42,6 +42,7 @@ public class InitialPlayerSync : Packet
         public SessionSettings SessionSettings { get; }
         public bool InPrecursor { get; }
         public bool DisplaySurfaceWater { get; }
+        public bool MarkDeathPointsWithBeacon { get; }
 
         public InitialPlayerSync(NitroxId playerGameObjectId,
             bool firstTimeConnecting,
@@ -68,7 +69,8 @@ public InitialPlayerSync(NitroxId playerGameObjectId,
             bool keepInventoryOnDeath,
             SessionSettings sessionSettings,
             bool inPrecursor,
-            bool displaySurfaceWater)
+            bool displaySurfaceWater,
+            bool markDeathPointsWithBeacon)
         {
             AssignedEscapePodId = assignedEscapePodId;
             PlayerGameObjectId = playerGameObjectId;
@@ -96,6 +98,7 @@ public InitialPlayerSync(NitroxId playerGameObjectId,
             SessionSettings = sessionSettings;
             InPrecursor = inPrecursor;
             DisplaySurfaceWater = displaySurfaceWater;
+            MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
         }
 
         /// <remarks>Used for deserialization</remarks>
@@ -125,7 +128,8 @@ public InitialPlayerSync(
             bool keepInventoryOnDeath,
             SessionSettings sessionSettings,
             bool inPrecursor,
-            bool displaySurfaceWater)
+            bool displaySurfaceWater,
+            bool markDeathPointsWithBeacon)
         {
             AssignedEscapePodId = assignedEscapePodId;
             PlayerGameObjectId = playerGameObjectId;
@@ -153,6 +157,7 @@ public InitialPlayerSync(
             SessionSettings = sessionSettings;
             InPrecursor = inPrecursor;
             DisplaySurfaceWater = displaySurfaceWater;
+            MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
         }
     }
 }

Nitrox.Model/Configuration/SubnauticaServerOptions.cs

@@ -70,6 +70,9 @@ public sealed partial class SubnauticaServerOptions
     public bool DisableConsole { get; set; }
     public string? AdminPassword { get; set; } = "";
     public bool KeepInventoryOnDeath { get; set; }
+
+    [PropertyDescription("Places a beacon where players die")]
+    public bool MarkDeathPointsWithBeacon { get; set; }
     public bool PvpEnabled { get; set; } = true;
     public bool AutoSave { get; set; } = true;
 

Nitrox.Server.Subnautica/Models/Commands/Core/HostToServerCommandContext.cs

@@ -82,4 +82,6 @@ public async ValueTask SendAsync<T>(SessionId sessionId, T data)
                 break;
         }
     }
+
+    public override string ToString() => $"'{OriginName}' #{OriginId}";
 }

Nitrox.Server.Subnautica/Models/Commands/Core/PlayerToServerCommandContext.cs

@@ -77,4 +77,6 @@ public async ValueTask SendToOthersAsync<T>(T data)
                 break;
         }
     }
+
+    public override string ToString() => $"'{OriginName}' #{OriginId}";
 }

Nitrox.Server.Subnautica/Models/Commands/DeathMarkerCommand.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel;
+using Nitrox.Model.DataStructures.GameLogic;
+using Nitrox.Server.Subnautica.Models.Commands.Core;
+using NitroxModel.Packets;
+
+namespace Nitrox.Server.Subnautica.Models.Commands;
+
+[RequiresPermission(Perms.ADMIN)]
+internal sealed class DeathMarkerCommand(IOptions<SubnauticaServerOptions> options) : ICommandHandler<bool>
+{
+    private readonly IOptions<SubnauticaServerOptions> options = options;
+
+    [Description("Sets \"death markers\" setting to on/off. If \"on\", a beacon will be placed when a player dies at the location of the death.")]
+    public async Task Execute(ICommandContext context, [Description("The true/false state to set the death markers setting to")] bool newState)
+    {
+        if (options.Value.MarkDeathPointsWithBeacon == newState)
+        {
+            await context.ReplyAsync($"{nameof(options.Value.MarkDeathPointsWithBeacon)} already set to {newState}");
+            return;
+        }
+        options.Value.MarkDeathPointsWithBeacon = newState;
+        await context.SendToAllAsync(new DeathMarkersChanged(newState));
+        await context.SendToAllAsync($"{nameof(options.Value.MarkDeathPointsWithBeacon)} changed to \"{newState}\" by {context}");
+    }
+}

Nitrox.Server.Subnautica/Models/GameLogic/JoiningManager.cs

@@ -206,7 +206,8 @@ private async Task SendInitialSyncAsync(SessionId sessionId, string reservationK
             options.Value.KeepInventoryOnDeath,
             sessionSettings,
             player.InPrecursor,
-            player.DisplaySurfaceWater
+            player.DisplaySurfaceWater,
+            options.Value.MarkDeathPointsWithBeacon
         );
 
         await packetSender.SendPacketAsync(initialPlayerSync, player.SessionId);

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,16 @@
+using NitroxClient.Communication.Packets.Processors.Core;
+using NitroxClient.GameLogic;
+using NitroxModel.Packets;
+
+namespace NitroxClient.Communication.Packets.Processors;
+
+internal sealed class DeathMarkersChangedProcessor(LocalPlayer localPlayer) : IClientPacketProcessor<DeathMarkersChanged>
+{
+    private readonly LocalPlayer localPlayer = localPlayer;
+
+    public Task Process(ClientProcessorContext context, DeathMarkersChanged packet)
+    {
+        localPlayer.MarkDeathPointsWithBeacon = packet.MarkDeathPointsWithBeacon;
+        return Task.CompletedTask;
+    }
+}

NitroxClient/Communication/Packets/Processors/PlayerDeathProcessor.cs

@@ -1,4 +1,4 @@
-using Nitrox.Model.Helper;
+using Nitrox.Model.Helper;
 using Nitrox.Model.Subnautica.Packets;
 using NitroxClient.Communication.Packets.Processors.Core;
 using NitroxClient.GameLogic;

NitroxClient/Extensions/GameObjectExtensions.cs

@@ -10,10 +10,13 @@ namespace NitroxClient.Extensions;
 
 public static class GameObjectExtensions
 {
-    /// <summary>
-    ///     Returns true if game object is the local player, playing on the executing machine.
-    /// </summary>
-    public static bool IsLocalPlayer(this GameObject gameObject) => gameObject == Player.main.gameObject;
+    extension(GameObject self)
+    {
+        /// <summary>
+        ///     Returns true if game object is the local player, playing on the executing machine.
+        /// </summary>
+        public bool IsLocalPlayer => self == Player.main.gameObject;
+    }
 
     public static bool TryGetComponentInChildren<T>(this GameObject go, out T component, bool includeInactive = false) where T : Component
     {

NitroxClient/Extensions/PingInstanceExtensions.cs

@@ -0,0 +1,16 @@
+namespace NitroxClient.Extensions;
+
+internal static class PingInstanceExtensions
+{
+    extension(PingInstance self)
+    {
+        /// <summary>
+        ///     If true, ping instance should not be synchronized to remote players.
+        /// </summary>
+        public bool IsLocalOnly
+        {
+            set => self._id = "local";
+            get => self._id == "local";
+        }
+    }
+}

NitroxClient/GameLogic/Helper/EquipmentHelper.cs

@@ -17,7 +17,7 @@ public class EquipmentHelper
             o => o.GetComponent<UpgradeConsole>().AliveOrNull()?.modules,
             o => o.GetComponent<Vehicle>().AliveOrNull()?.modules,
             o => o.GetComponent<VehicleUpgradeConsoleInput>().AliveOrNull()?.equipment,
-            o => o.IsLocalPlayer() ? Inventory.main.equipment : null
+            o => o.IsLocalPlayer ? Inventory.main.equipment : null
         };
 
         public static Optional<Equipment> FindEquipmentComponent(GameObject owner)

NitroxClient/GameLogic/Helper/InventoryContainerHelper.cs

@@ -17,7 +17,7 @@ public class InventoryContainerHelper
         /// </summary>
         public static Optional<ItemsContainer> TryGetContainerByOwner(GameObject owner)
         {
-            if (owner.IsLocalPlayer())
+            if (owner.IsLocalPlayer)
             {
                 return Optional.Of(Inventory.main.container);
             }

NitroxClient/GameLogic/InitialSync/PlayerInitialSyncProcessor.cs

@@ -37,7 +37,7 @@ public PlayerInitialSyncProcessor(Items item, ItemContainers itemContainers, Loc
         AddStep(sync => SetPlayerStats(sync.PlayerStatsData));
         AddStep(sync => SetUsedItems(sync.UsedItems));
         AddStep(sync => SetPlayerGameMode(sync.GameMode));
-        AddStep(sync => ApplySettings(sync.KeepInventoryOnDeath, sync.SessionSettings.FastHatch, sync.SessionSettings.FastGrow));
+        AddStep(sync => ApplySettings(sync.KeepInventoryOnDeath, sync.SessionSettings.FastHatch, sync.SessionSettings.FastGrow, sync.MarkDeathPointsWithBeacon));
     }
 
     private void SetPlayerPermissions(Perms permissions)
@@ -149,9 +149,10 @@ private static void SetPlayerGameMode(SubnauticaGameMode gameMode)
         GameModeUtils.SetGameMode((GameModeOption)(int)gameMode, GameModeOption.None);
     }
 
-    private void ApplySettings(bool keepInventoryOnDeath, bool fastHatch, bool fastGrow)
+    private void ApplySettings(bool keepInventoryOnDeath, bool fastHatch, bool fastGrow, bool markDeathPointsWithBeacon)
     {
         localPlayer.KeepInventoryOnDeath = keepInventoryOnDeath;
+        localPlayer.MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
         NoCostConsoleCommand.main.fastHatchCheat = fastHatch;
         NoCostConsoleCommand.main.fastGrowCheat = fastGrow;
         if (!fastHatch && !fastGrow)
@@ -170,4 +171,9 @@ private void ApplySettings(bool keepInventoryOnDeath, bool fastHatch, bool fastG
         }
         Log.InGame(cheatsEnabled.ToString());
     }
+
+    private void SetPlayerMarkDeathPointsWithBeacon(bool markDeathPointsWithBeacon)
+    {
+        localPlayer.MarkDeathPointsWithBeacon = markDeathPointsWithBeacon;
+    }
 }

NitroxClient/GameLogic/InitialSync/PlayerPreferencesInitialSyncProcessor.cs

@@ -100,6 +100,11 @@ private static void RefreshPingEntryInPDA(PingInstance pingInstance)
     public static bool TryGetKeyForPingInstance(PingInstance pingInstance, out string pingKey, out bool isRemotePlayerPing, Action failCallback = null)
     {
         isRemotePlayerPing = false;
+        if (pingInstance.IsLocalOnly)
+        {
+            pingKey = string.Empty;
+            return false;
+        }
         if (pingInstance.TryGetComponent(out SignalPing signalPing))
         {
             pingKey = signalPing.descriptionKey;
@@ -129,7 +134,7 @@ public static bool TryGetKeyForPingInstance(PingInstance pingInstance, out strin
             return false;
         }
 
-        Log.Warn($"Couldn't find PingInstance identifier for {pingInstance.name} under {pingInstance.transform.parent}");
+        Log.Warn($"Couldn't find {nameof(PingInstance)} identifier for {pingInstance.name} under {pingInstance.transform.parent}");
         pingKey = string.Empty;
         return false;
     }

NitroxClient/GameLogic/LocalPlayer.cs

@@ -37,10 +37,10 @@ public class LocalPlayer : ILocalNitroxPlayer
     /// </summary>
     public SessionId? SessionId => multiplayerSession.Reservation?.SessionId;
     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,42 @@
+using Nitrox.Model.DataStructures.Unity;
+using UnityEngine;
+
+namespace NitroxClient.MonoBehaviours.Gui.InGame;
+
+/// <summary>
+///     Related to DeathMarker server setting.
+/// </summary>
+internal sealed class DeathBeacon : MonoBehaviour
+{
+    private const float DESPAWN_DISTANCE = 20f;
+
+    private void OnTriggerEnter(Collider collider)
+    {
+        if (!collider.gameObject.IsLocalPlayer)
+        {
+            return;
+        }
+
+        Log.Debug($"{nameof(DeathBeacon)} '{name}' despawn trigger entered by {collider.name}");
+        Destroy(gameObject);
+    }
+
+    public static void SpawnDeathBeacon(NitroxVector3 location, string playerName)
+    {
+        GameObject beacon = new($"{playerName}{nameof(DeathBeacon)}");
+        beacon.transform.position = location.ToUnity();
+        beacon.layer = LayerID.Trigger | LayerID.OnlyVehicle;
+        beacon.AddComponent<DeathBeacon>();
+        PingInstance signal = beacon.AddComponent<PingInstance>();
+        signal.IsLocalOnly = true;
+        signal.pingType = PingType.Signal;
+        signal.origin = beacon.transform;
+        signal.minDist = DESPAWN_DISTANCE + 15f;
+        signal._label = Language.main.Get("Nitrox_PlayerDeathBeaconLabel").Replace("{PLAYER}", playerName);
+        signal.displayPingInManager = true;
+        signal.Initialize();
+        SphereCollider collider = beacon.AddComponent<SphereCollider>();
+        collider.radius = DESPAWN_DISTANCE;
+        collider.isTrigger = true;
+    }
+}

NitroxClient/MonoBehaviours/PlayerDeathBroadcaster.cs

@@ -1,4 +1,5 @@
 using NitroxClient.GameLogic;
+using NitroxClient.MonoBehaviours.Gui.InGame;
 using UnityEngine;
 
 namespace NitroxClient.MonoBehaviours;
@@ -11,16 +12,20 @@ public void Awake()
     {
         localPlayer = this.Resolve<LocalPlayer>();
 
-        Player.main.playerDeathEvent.AddHandler(this, PlayerDeath);
+        Player.main.playerDeathEvent.AddHandler(this, OnPlayerDeath);
     }
 
-    private void PlayerDeath(Player player)
+    private void OnPlayerDeath(Player player)
     {
+        if (localPlayer.MarkDeathPointsWithBeacon)
+        {
+            DeathBeacon.SpawnDeathBeacon(player.transform.position.ToDto(), localPlayer.PlayerName);
+        }
         localPlayer.BroadcastDeath(player.transform.position);
     }
 
     public void OnDestroy()
     {
-        Player.main.playerDeathEvent.RemoveHandler(this, PlayerDeath);
+        Player.main.playerDeathEvent.RemoveHandler(this, OnPlayerDeath);
     }
 }

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;
@@ -11,6 +11,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();