feat: Add CustomKeycard wrapper n stuff

EXILED/Exiled.API/Exiled.API.csproj

@@ -31,12 +31,14 @@
         <Reference Include="Pooling" HintPath="$(EXILED_REFERENCES)\Pooling.dll" Private="false" />
         <Reference Include="Mirror" HintPath="$(EXILED_REFERENCES)\Mirror.dll" Private="false" />
         <Reference Include="NorthwoodLib" HintPath="$(EXILED_REFERENCES)\NorthwoodLib.dll" Private="false" />
+        <Reference Include="Snake" HintPath="$(EXILED_REFERENCES)\Snake.dll" Private="false" />
         <Reference Include="Unity.TextMeshPro" HintPath="$(EXILED_REFERENCES)\Unity.TextMeshPro.dll" Private="false" />
         <Reference Include="UnityEngine" HintPath="$(EXILED_REFERENCES)\UnityEngine.dll" Private="false" />
         <Reference Include="UnityEngine.CoreModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.CoreModule.dll" Private="false" />
         <Reference Include="UnityEngine.ParticleSystemModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.ParticleSystemModule.dll" Private="false" />
         <Reference Include="UnityEngine.PhysicsModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.PhysicsModule.dll" Private="false" />
         <Reference Include="UnityEngine.AudioModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.AudioModule.dll" Private="false" />
+        <Reference Include="UnityEngine.UI" HintPath="$(EXILED_REFERENCES)\UnityEngine.UI.dll" Private="false" />
         <Reference Include="YamlDotNet" HintPath="$(EXILED_REFERENCES)\YamlDotNet.dll" Private="false" />
     </ItemGroup>
 

EXILED/Exiled.API/Extensions/ItemExtensions.cs

@@ -84,6 +84,14 @@ public static class ItemExtensions
         /// <returns>Returns whether the <see cref="ItemType"/> is a keycard.</returns>
         public static bool IsKeycard(this ItemType type) => GetCategory(type) == ItemCategory.Keycard;
 
+        /// <summary>
+        /// Checks if an <see cref="ItemType"/> is a custom keycard.
+        /// </summary>
+        /// <param name="type">The item to be checked.</param>
+        /// <returns>Returns where the <see cref="ItemType"/> is a custom keycard.</returns>
+        /// <remarks>This just signifies whether the ItemType represents a keycard that has modifiable properties.</remarks>
+        public static bool IsCustomKeycard(this ItemType type) => type is ItemType.KeycardCustomTaskForce or ItemType.KeycardCustomSite02 or ItemType.KeycardCustomManagement or ItemType.KeycardCustomMetalCase;
+
         /// <summary>
         /// Given an <see cref="ItemType"/>, returns the matching <see cref="ItemBase"/>.
         /// </summary>

EXILED/Exiled.API/Extensions/MirrorExtensions.cs

@@ -19,12 +19,15 @@ namespace Exiled.API.Extensions
     using CustomPlayerEffects;
     using Exiled.API.Enums;
     using Exiled.API.Features.Items;
+    using Exiled.API.Features.Items.Keycards;
+    using Exiled.API.Features.Pickups.Keycards;
     using Features;
     using Features.Pools;
     using InventorySystem;
     using InventorySystem.Items;
     using InventorySystem.Items.Firearms;
     using InventorySystem.Items.Firearms.Modules;
+    using InventorySystem.Items.Keycards;
     using MEC;
     using Mirror;
     using PlayerRoles;
@@ -401,6 +404,30 @@ public static void SendFakeEffectTo(this Player effectOwner, Player target, Effe
             });
         }
 
+        /// <summary>
+        /// Makes the server resend a message to all clients updating a keycards details to current values.
+        /// </summary>
+        /// <param name="customKeycardItem">The keycard to resync.</param>
+        public static void ResyncKeycardItem(CustomKeycardItem customKeycardItem)
+        {
+            if (KeycardDetailSynchronizer.Database.Remove(customKeycardItem.Serial))
+            {
+                KeycardDetailSynchronizer.ServerProcessItem(customKeycardItem.Base);
+            }
+        }
+
+        /// <summary>
+        /// Makes the server resend a message to all clients updating a keycards details to current values.
+        /// </summary>
+        /// <param name="customKeycard">The keycard to resync.</param>
+        public static void ResyncKeycardPickup(CustomKeycardPickup customKeycard)
+        {
+            if (KeycardDetailSynchronizer.Database.Remove(customKeycard.Serial))
+            {
+                KeycardDetailSynchronizer.ServerProcessPickup(customKeycard.Base);
+            }
+        }
+
         /// <summary>
         /// Send CASSIE announcement that only <see cref="Player"/> can hear.
         /// </summary>

EXILED/Exiled.API/Features/Items/Item.cs

@@ -12,6 +12,7 @@ namespace Exiled.API.Features.Items
 
     using Exiled.API.Extensions;
     using Exiled.API.Features.Core;
+    using Exiled.API.Features.Items.Keycards;
     using Exiled.API.Features.Pickups;
     using Exiled.API.Interfaces;
     using InventorySystem;
@@ -217,7 +218,19 @@ public static Item Get(ItemBase itemBase)
             return itemBase switch
             {
                 InventorySystem.Items.Firearms.Firearm firearm => new Firearm(firearm),
-                KeycardItem keycard => new Keycard(keycard),
+                KeycardItem keycard => keycard switch
+                {
+                    ChaosKeycardItem chaosKeycardItem => new ChaosKeycard(chaosKeycardItem),
+                    SingleUseKeycardItem singleUseKeycardItem => new SingleUseKeycard(singleUseKeycardItem),
+                    _ => keycard.ItemTypeId switch
+                    {
+                        ItemType.KeycardCustomTaskForce => new TaskForceKeycard(keycard),
+                        ItemType.KeycardCustomSite02 => new Site02Keycard(keycard),
+                        ItemType.KeycardCustomManagement => new ManagementKeycard(keycard),
+                        ItemType.KeycardCustomMetalCase => new MetalKeycard(keycard),
+                        _ => new Keycard(keycard),
+                    }
+                },
                 UsableItem usable => usable switch
                 {
                     Scp330Bag scp330Bag => new Scp330(scp330Bag),
@@ -304,7 +317,19 @@ public static T Get<T>(ushort serial)
         public static Item Create(ItemType type, Player owner = null) => type.GetTemplate() switch
         {
             InventorySystem.Items.Firearms.Firearm => new Firearm(type),
-            KeycardItem => new Keycard(type),
+            KeycardItem keycard => keycard switch
+            {
+                ChaosKeycardItem => new ChaosKeycard(type),
+                SingleUseKeycardItem => new SingleUseKeycard(type),
+                _ => type switch
+                {
+                    ItemType.KeycardCustomTaskForce => new TaskForceKeycard(type),
+                    ItemType.KeycardCustomSite02 => new Site02Keycard(type),
+                    ItemType.KeycardCustomManagement => new ManagementKeycard(type),
+                    ItemType.KeycardCustomMetalCase => new MetalKeycard(type),
+                    _ => new Keycard(type, owner),
+                }
+            },
             UsableItem usable => usable switch
             {
                 Scp330Bag => new Scp330(),

EXILED/Exiled.API/Features/Items/Keycard.cs

@@ -7,10 +7,9 @@
 
 namespace Exiled.API.Features.Items
 {
-    using System;
-
     using Exiled.API.Enums;
     using Exiled.API.Interfaces;
+    using Interactables.Interobjects.DoorUtils;
     using InventorySystem.Items.Keycards;
 
     /// <summary>
@@ -32,8 +31,9 @@ public Keycard(KeycardItem itemBase)
         /// Initializes a new instance of the <see cref="Keycard"/> class.
         /// </summary>
         /// <param name="type">The <see cref="ItemType"/> of the keycard.</param>
-        internal Keycard(ItemType type)
-            : this((KeycardItem)Server.Host.Inventory.CreateItemInstance(new(type, 0), false))
+        /// <param name="owner">The owner of the grenade. Leave <see langword="null"/> for no owner.</param>
+        internal Keycard(ItemType type, Player owner = null)
+            : this((KeycardItem)(owner ?? Server.Host).Inventory.CreateItemInstance(new(type, 0), false))
         {
         }
 
@@ -45,26 +45,32 @@ internal Keycard(ItemType type)
         /// <summary>
         /// Gets or sets the <see cref="KeycardPermissions"/> of the keycard.
         /// </summary>
-        public KeycardPermissions Permissions
+        public virtual KeycardPermissions Permissions
         {
             get
             {
                 foreach (DetailBase detail in Base.Details)
                 {
-                    switch (detail)
-                    {
-                        case PredefinedPermsDetail predefinedPermsDetail:
-                            return (KeycardPermissions)predefinedPermsDetail.Levels.Permissions;
-                        case CustomPermsDetail customPermsDetail:
-                            return (KeycardPermissions)customPermsDetail.GetPermissions(null);
-                    }
+                    if (detail is IDoorPermissionProvider doorPermissionProvider)
+                        return (KeycardPermissions)doorPermissionProvider.GetPermissions(null);
                 }
 
                 return KeycardPermissions.None;
             }
 
-            [Obsolete("Not functional anymore", true)]
-            set => _ = value;
+            set
+            {
+                foreach (DetailBase detail in Base.Details)
+                {
+                    if (detail is PredefinedPermsDetail doorPermissionProvider)
+                    {
+                        KeycardLevels keycardLevels = new((DoorPermissionFlags)value);
+                        doorPermissionProvider._containmentLevel = keycardLevels.Containment;
+                        doorPermissionProvider._armoryLevel = keycardLevels.Armory;
+                        doorPermissionProvider._adminLevel = keycardLevels.Admin;
+                    }
+                }
+            }
         }
 
         /// <summary>

EXILED/Exiled.API/Features/Items/Keycards/ChaosKeycard.cs

@@ -0,0 +1,54 @@
+// -----------------------------------------------------------------------
+// <copyright file="ChaosKeycard.cs" company="ExMod Team">
+// Copyright (c) ExMod Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Items.Keycards
+{
+    using InventorySystem.Items;
+    using InventorySystem.Items.Keycards;
+    using InventorySystem.Items.Keycards.Snake;
+
+    /// <summary>
+    /// A base class for chaos keycard items.
+    /// </summary>
+    public class ChaosKeycard : Keycard
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChaosKeycard"/> class.
+        /// </summary>
+        /// <param name="itemBase">The <see cref="ItemBase"/> to encapsulate.</param>
+        internal ChaosKeycard(ChaosKeycardItem itemBase)
+            : base(itemBase)
+        {
+            Base = itemBase;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChaosKeycard"/> class.
+        /// </summary>
+        /// <param name="type">The <see cref="ItemType"/> of the item to create.</param>
+        internal ChaosKeycard(ItemType type)
+            : this((ChaosKeycardItem)Server.Host.Inventory.CreateItemInstance(new(type, 0), false))
+        {
+        }
+
+        /// <summary>
+        /// Gets the <see cref="KeycardItem"/> this encapsulates.
+        /// </summary>
+        public new ChaosKeycardItem Base { get; }
+
+        /// <summary>
+        /// Gets the <see cref="InventorySystem.Items.Keycards.Snake.SnakeEngine"/> this encapsulates.
+        /// </summary>
+        public SnakeEngine SnakeEngine => Base._localEngine;
+
+        /// <summary>
+        /// Returns the Keycard in a human readable format.
+        /// </summary>
+        /// <returns>A string containing Keycard-related data.</returns>
+        public override string ToString() => $"{Type} == ({Serial}) [{Weight}] *{Scale}* |{Permissions}|";
+    }
+}