feat: Adding CustomKeycard for CustomItems

EXILED/Exiled.API/Extensions/BitwiseExtensions.cs

@@ -59,5 +59,21 @@ public static T ModifyFlags<T>(this T flags, bool value, params T[] changeFlags)
 
             return (T)Enum.ToObject(typeof(T), currentValue);
         }
+
+        /// <summary>
+        /// Checks if flag has specified value.
+        /// </summary>
+        /// <param name="flag">Flag to check.</param>
+        /// <param name="value">Value to check in flag.</param>
+        /// <typeparam name="T">The type of the enum.</typeparam>
+        /// <returns><see langword="true"/> if value is presented in flag. Otherwise, <see langword="false"/>.</returns>
+        public static bool HasFlagFast<T>(this T flag, T value)
+            where T : Enum
+        {
+            long flagValue = Convert.ToInt64(flag);
+            long valueValue = Convert.ToInt64(value);
+
+            return (flagValue & valueValue) == valueValue;
+        }
     }
 }

EXILED/Exiled.CustomItems/API/Features/CustomKeycard.cs

@@ -0,0 +1,127 @@
+// -----------------------------------------------------------------------
+// <copyright file="CustomKeycard.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.CustomItems.API.Features
+{
+    using System;
+
+    using Exiled.API.Enums;
+    using Exiled.API.Extensions;
+    using Exiled.API.Features;
+    using Exiled.API.Features.Doors;
+    using Exiled.API.Features.Items;
+    using Exiled.API.Features.Lockers;
+    using Exiled.API.Features.Pickups;
+    using Exiled.Events.EventArgs.Item;
+    using Exiled.Events.EventArgs.Player;
+    using UnityEngine;
+
+    /// <summary>
+    /// The Custom keycard base class.
+    /// </summary>
+    public abstract class CustomKeycard : CustomItem
+    {
+        /// <inheritdoc/>
+        /// <exception cref="ArgumentOutOfRangeException">Throws if specified <see cref="ItemType"/> is not Keycard.</exception>
+        public override ItemType Type
+        {
+            get => base.Type;
+            set
+            {
+                if (!value.IsKeycard())
+                    throw new ArgumentOutOfRangeException("Type", value, "Invalid keycard type.");
+
+                base.Type = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the permissions for custom keycard.
+        /// </summary>
+        public virtual KeycardPermissions Permissions { get; set; }
+
+        /// <inheritdoc/>
+        public override void Give(Player player, Item item, bool displayMessage = true)
+        {
+            base.Give(player, item, displayMessage);
+
+            if (item.Is(out Keycard card))
+                card.Permissions = Permissions;
+        }
+
+        /// <inheritdoc/>
+        public override Pickup? Spawn(Vector3 position, Item item, Player? previousOwner = null)
+        {
+            if (item.Is(out Keycard card))
+                card.Permissions = Permissions;
+
+            return base.Spawn(position, item, previousOwner);
+        }
+
+        /// <summary>
+        /// Called when custom keycard interacts with a door.
+        /// </summary>
+        /// <param name="player">Owner of Custom keycard.</param>
+        /// <param name="door">Door with which interacting.</param>
+        protected virtual void OnInteractingDoor(Player player, Door door)
+        {
+        }
+
+        /// <summary>
+        /// Called when custom keycard interacts with a locker.
+        /// </summary>
+        /// <param name="player">Owner of Custom keycard.</param>
+        /// <param name="chamber">Chamber with which interacting.</param>
+        protected virtual void OnInteractingLocker(Player player, Chamber chamber)
+        {
+        }
+
+        /// <inheritdoc/>
+        protected override void SubscribeEvents()
+        {
+            base.SubscribeEvents();
+
+            Exiled.Events.Handlers.Player.InteractingDoor += OnInternalInteractingDoor;
+            Exiled.Events.Handlers.Player.InteractingLocker += OnInternalInteractingLocker;
+            Exiled.Events.Handlers.Item.KeycardInteracting += OnInternalKeycardInteracting;
+        }
+
+        /// <inheritdoc/>
+        protected override void UnsubscribeEvents()
+        {
+            base.UnsubscribeEvents();
+
+            Exiled.Events.Handlers.Player.InteractingDoor -= OnInternalInteractingDoor;
+            Exiled.Events.Handlers.Player.InteractingLocker -= OnInternalInteractingLocker;
+            Exiled.Events.Handlers.Item.KeycardInteracting -= OnInternalKeycardInteracting;
+        }
+
+        private void OnInternalKeycardInteracting(KeycardInteractingEventArgs ev)
+        {
+            if (!Check(ev.Pickup))
+                return;
+
+            OnInteractingDoor(ev.Player, ev.Door);
+        }
+
+        private void OnInternalInteractingDoor(InteractingDoorEventArgs ev)
+        {
+            if (!Check(ev.Player.CurrentItem))
+                return;
+
+            OnInteractingDoor(ev.Player, ev.Door);
+        }
+
+        private void OnInternalInteractingLocker(InteractingLockerEventArgs ev)
+        {
+            if (!Check(ev.Player.CurrentItem))
+                return;
+
+            OnInteractingLocker(ev.Player, ev.InteractingChamber);
+        }
+    }
+}