Decal helpers

SecretAPI/Features/DecalHelpers.cs

@@ -0,0 +1,111 @@
+namespace SecretAPI.Features;
+
+using System;
+using Decals;
+using InventorySystem.Items;
+using InventorySystem.Items.Autosync;
+using InventorySystem.Items.Firearms.Modules;
+using Mirror;
+using RelativePositioning;
+using UnityEngine;
+using Utils.Networking;
+
+/// <summary>
+/// Helps with handling Decals (<see cref="DecalPoolType"/>) and sending them to clients without the need for a firearm with the <see cref="ImpactEffectsModule"/>.
+/// </summary>
+public static class DecalHelpers
+{
+    private static bool hasData = false;
+    private static ItemType itemType = ItemType.None;
+    private static byte subcomponentIndex = 0;
+
+    /// <summary>
+    /// Creates an <see cref="AutosyncMessage"/> for spawning a decal that can be sent to players.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="startPosition">The position from which the decal will be applied to a surface.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    /// <returns>The message which is to be sent to players.</returns>
+    public static AutosyncMessage GetDecalMessage(Vector3 position, Vector3 startPosition, DecalPoolType type)
+    {
+        RelativePosition hitPoint = new(position);
+        RelativePosition startRaycastPoint = new(startPosition);
+
+        (ItemType itemTypeId, byte moduleIndex) = GetItemData();
+
+        using NetworkWriterPooled? writer = NetworkWriterPool.Get();
+        writer.WriteByte(moduleIndex);
+        writer.WriteSubheader(ImpactEffectsModule.RpcType.ImpactDecal);
+        writer.WriteByte((byte)type);
+        writer.WriteRelativePosition(hitPoint);
+        writer.WriteRelativePosition(startRaycastPoint);
+
+        return new AutosyncMessage(writer, new ItemIdentifier(itemTypeId, 0));
+    }
+
+    /// <summary>
+    /// Spawns a decal.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="startPosition">The position from which the decal will be applied to a surface.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    public static void SpawnDecalFromPosition(Vector3 position, Vector3 startPosition, DecalPoolType type = DecalPoolType.Blood)
+        => GetDecalMessage(position, startPosition, type).SendToAuthenticated();
+
+    /// <summary>
+    /// Spawns a decal.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="normal">The normal of the face the decal is on.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    public static void SpawnDecalFromNormal(Vector3 position, Vector3 normal, DecalPoolType type = DecalPoolType.Blood)
+        => GetDecalMessage(position, position + normal, type).SendToAuthenticated();
+
+    /// <summary>
+    /// Spawns a decal.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="normal">The normal rotation of the face the decal is on.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    public static void SpawnDecalFromNormal(Vector3 position, Quaternion normal, DecalPoolType type = DecalPoolType.Blood)
+        => GetDecalMessage(position, position + (normal * Vector3.forward), type).SendToAuthenticated();
+
+    /// <summary>
+    /// Spawns a decal.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="direction">The direction opposite to the normal of the face the decal will be placed on.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    public static void SpawnDecalFromDirection(Vector3 position, Vector3 direction, DecalPoolType type = DecalPoolType.Blood)
+        => GetDecalMessage(position, position - direction, type).SendToAuthenticated();
+
+    /// <summary>
+    /// Spawns a decal.
+    /// </summary>
+    /// <param name="position">The position where the decal will spawn.</param>
+    /// <param name="direction">The direction opposite to the normal of the face the decal will be placed on.</param>
+    /// <param name="type">The type of decal to spawn.</param>
+    public static void SpawnDecalFromDirection(Vector3 position, Quaternion direction, DecalPoolType type = DecalPoolType.Blood)
+        => GetDecalMessage(position, position - (direction * Vector3.forward), type).SendToAuthenticated();
+
+    private static (ItemType ItemType, byte SubcomponentIndex) GetItemData()
+    {
+        if (hasData)
+            return (itemType, subcomponentIndex);
+
+        foreach (ModularAutosyncItem? autoItem in ModularAutosyncItem.AllTemplates)
+        {
+            for (byte b = 0; b < autoItem.AllSubcomponents.Length; b++)
+            {
+                if (autoItem.AllSubcomponents[b] is not ImpactEffectsModule)
+                    continue;
+                subcomponentIndex = b;
+                itemType = autoItem.ItemTypeId;
+                hasData = true;
+                return (itemType, subcomponentIndex);
+            }
+        }
+
+        throw new InvalidOperationException("Couldn't find the `InventorySystem.Items.Firearms.Modules.ImpactEffectsModule` in the any ModularAutosyncItem!");
+    }
+}