Merge branch 'master' into modify-labeler

.github/workflows/push_nuget.yml

@@ -10,7 +10,7 @@ defaults:
     working-directory: ./EXILED
 
 env:
-  EXILED_REFERENCES_URL: https://Exiled-Official.github.io/SL-References/Master.zip
+  EXILED_REFERENCES_URL: https://ExMod-Team.github.io/SL-References/Master.zip
   EXILED_REFERENCES_PATH: ${{ github.workspace }}/EXILED/References
 
 jobs:

EXILED/EXILED.props

@@ -15,7 +15,7 @@
 
   <PropertyGroup>
     <!-- This is the global version and is used for all projects that don't have a version -->
-    <Version Condition="$(Version) == ''">8.11.0</Version>
+    <Version Condition="$(Version) == ''">8.12.0-rc.3</Version>
     <!-- Enables public beta warning via the PUBLIC_BETA constant -->
     <PublicBeta>false</PublicBeta>
 

EXILED/Exiled.API/Enums/AuthenticationType.cs

@@ -42,5 +42,10 @@ public enum AuthenticationType
         /// Indicates that the player has been authenticated as DedicatedServer.
         /// </summary>
         DedicatedServer,
+
+        /// <summary>
+        /// Indicates that the player has been authenticated during Offline mode.
+        /// </summary>
+        Offline,
     }
 }

EXILED/Exiled.API/Enums/HazardType.cs

@@ -0,0 +1,37 @@
+// -----------------------------------------------------------------------
+// <copyright file="HazardType.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Enums
+{
+    using Exiled.API.Features.Hazards;
+
+    /// <summary>
+    /// Unique identifier for a <see cref="Hazard"/>.
+    /// </summary>
+    public enum HazardType
+    {
+        /// <summary>
+        /// SCP-939 amnestic cloud.
+        /// </summary>
+        AmnesticCloud,
+
+        /// <summary>
+        /// Sinkhole spawned at start of round.
+        /// </summary>
+        Sinkhole,
+
+        /// <summary>
+        /// SCP-173 tantrum.
+        /// </summary>
+        Tantrum,
+
+        /// <summary>
+        /// Should never happen
+        /// </summary>
+        Unknown,
+    }
+}

EXILED/Exiled.API/Enums/UncuffReason.cs

@@ -0,0 +1,30 @@
+// -----------------------------------------------------------------------
+// <copyright file="UncuffReason.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Enums
+{
+    /// <summary>
+    /// Reasons that player gets uncuffed.
+    /// </summary>
+    public enum UncuffReason
+    {
+        /// <summary>
+        /// Uncuffed by a player.
+        /// </summary>
+        Player,
+
+        /// <summary>
+        /// Uncuffed due to the distance between cuffer and target.
+        /// </summary>
+        OutOfRange,
+
+        /// <summary>
+        /// Uncuffed due to the cuffer no longer alive.
+        /// </summary>
+        CufferDied,
+    }
+}

EXILED/Exiled.API/Extensions/BitwiseExtensions.cs

@@ -0,0 +1,63 @@
+// -----------------------------------------------------------------------
+// <copyright file="BitwiseExtensions.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Extensions
+{
+    using System;
+
+    /// <summary>
+    /// Extensions for bitwise operations.
+    /// </summary>
+    public static class BitwiseExtensions
+    {
+        /// <summary>
+        /// Adds the specified flags to the given enum value.
+        /// </summary>
+        /// <typeparam name="T">The type of the enum.</typeparam>
+        /// <param name="flags">The enum value to add flags to.</param>
+        /// <param name="newFlags">The flags to add.</param>
+        /// <returns>The enum value with the specified flags added.</returns>
+        public static T AddFlags<T>(this T flags, params T[] newFlags)
+            where T : Enum => flags.ModifyFlags(true, newFlags);
+
+        /// <summary>
+        /// Removes the specified flags from the given enum value.
+        /// </summary>
+        /// <typeparam name="T">The type of the enum.</typeparam>
+        /// <param name="flags">The enum value to remove flags from.</param>
+        /// <param name="oldFlags">The flags to remove.</param>
+        /// <returns>The enum value with the specified flags removed.</returns>
+        public static T RemoveFlags<T>(this T flags, params T[] oldFlags)
+            where T : Enum => flags.ModifyFlags(false, oldFlags);
+
+        /// <summary>
+        /// Sets the specified flag to the given value, default is true.
+        /// </summary>
+        /// <param name="flags">The flags enum to modify.</param>
+        /// <param name="value">The value to set the flag to.</param>
+        /// <param name="changeFlags">The flags to modify.</param>
+        /// <typeparam name="T">The type of the enum.</typeparam>
+        /// <returns>The flags enum with the flag set to the given value.</returns>
+        public static T ModifyFlags<T>(this T flags, bool value, params T[] changeFlags)
+            where T : Enum
+        {
+            long currentValue = Convert.ToInt64(flags);
+
+            foreach (T flag in changeFlags)
+            {
+                long flagValue = Convert.ToInt64(flag);
+
+                if (value)
+                    currentValue |= flagValue;
+                else
+                    currentValue &= ~flagValue;
+            }
+
+            return (T)Enum.ToObject(typeof(T), currentValue);
+        }
+    }
+}

EXILED/Exiled.API/Extensions/MirrorExtensions.cs

@@ -435,12 +435,11 @@ public static void SendFakeTargetRpc(Player target, NetworkIdentity behaviorOwne
         /// <example>
         /// EffectOnlySCP207.
         /// <code>
-        ///  MirrorExtensions.SendCustomSync(player, player.ReferenceHub.networkIdentity, typeof(PlayerEffectsController), (writer) => {
-        ///   writer.WriteUInt64(1ul);                                           // DirtyObjectsBit
-        ///   writer.WriteUInt32(1);                                             // DirtyIndexCount
+        ///  MirrorExtensions.SendFakeSyncObject(player, player.NetworkIdentity, typeof(PlayerEffectsController), (writer) => {
+        ///   writer.WriteULong(1ul);                                            // DirtyObjectsBit
+        ///   writer.WriteUInt(1);                                               // DirtyIndexCount
         ///   writer.WriteByte((byte)SyncList&lt;byte&gt;.Operation.OP_SET);     // Operations
-        ///   writer.WriteUInt32(17);                                            // EditIndex
-        ///   writer.WriteByte(1);                                               // Value
+        ///   writer.WriteUInt(17);                                              // EditIndex
         ///  });
         /// </code>
         /// </example>

EXILED/Exiled.API/Extensions/RoleExtensions.cs

@@ -140,18 +140,22 @@ public static SpawnLocation GetRandomSpawnLocation(this RoleTypeId roleType)
             return null;
         }
 
+        /// <summary>
+        /// Gets the starting <see cref="InventoryRoleInfo"/> of a <see cref="RoleTypeId"/>.
+        /// </summary>
+        /// <param name="role">The <see cref="RoleTypeId"/>.</param>
+        /// <returns>The <see cref="InventoryRoleInfo"/> that the role receives on spawn. </returns>
+        public static InventoryRoleInfo GetInventory(this RoleTypeId role)
+            => StartingInventories.DefinedInventories.TryGetValue(role, out InventoryRoleInfo info)
+                ? info
+                : new(Array.Empty<ItemType>(), new());
+
         /// <summary>
         /// Gets the starting items of a <see cref="RoleTypeId"/>.
         /// </summary>
         /// <param name="roleType">The <see cref="RoleTypeId"/>.</param>
         /// <returns>An <see cref="Array"/> of <see cref="ItemType"/> that the role receives on spawn. Will be empty for classes that do not spawn with items.</returns>
-        public static ItemType[] GetStartingInventory(this RoleTypeId roleType)
-        {
-            if (StartingInventories.DefinedInventories.TryGetValue(roleType, out InventoryRoleInfo info))
-                return info.Items;
-
-            return Array.Empty<ItemType>();
-        }
+        public static ItemType[] GetStartingInventory(this RoleTypeId roleType) => GetInventory(roleType).Items;
 
         /// <summary>
         /// Gets the starting ammo of a <see cref="RoleTypeId"/>.
@@ -160,10 +164,9 @@ public static ItemType[] GetStartingInventory(this RoleTypeId roleType)
         /// <returns>An <see cref="Array"/> of <see cref="ItemType"/> that the role receives on spawn. Will be empty for classes that do not spawn with ammo.</returns>
         public static Dictionary<AmmoType, ushort> GetStartingAmmo(this RoleTypeId roleType)
         {
-            if (StartingInventories.DefinedInventories.TryGetValue(roleType, out InventoryRoleInfo info))
-                return info.Ammo.ToDictionary(kvp => kvp.Key.GetAmmoType(), kvp => kvp.Value);
+            InventoryRoleInfo info = roleType.GetInventory();
 
-            return new();
+            return info.Ammo.ToDictionary(kvp => kvp.Key.GetAmmoType(), kvp => kvp.Value);
         }
     }
 }

EXILED/Exiled.API/Extensions/StringExtensions.cs

@@ -161,7 +161,11 @@ public static string GetBefore(this string input, char symbol)
         /// </summary>
         /// <param name="userId">The user id.</param>
         /// <returns>Returns the raw user id.</returns>
-        public static string GetRawUserId(this string userId) => userId.Substring(0, userId.LastIndexOf('@'));
+        public static string GetRawUserId(this string userId)
+        {
+            int index = userId.IndexOf('@');
+            return index == -1 ? userId : userId.Substring(0, index);
+        }
 
         /// <summary>
         /// Gets a SHA256 hash of a player's user id without the authentication.

EXILED/Exiled.API/Features/Camera.cs

@@ -28,7 +28,7 @@ public class Camera : IWrapper<Scp079Camera>, IWorldSpace
         /// <summary>
         /// A <see cref="Dictionary{TKey,TValue}"/> containing all known <see cref="Scp079Camera"/>s and their corresponding <see cref="Camera"/>.
         /// </summary>
-        internal static readonly Dictionary<Scp079Camera, Camera> Camera079ToCamera = new(250);
+        internal static readonly Dictionary<Scp079Camera, Camera> Camera079ToCamera = new(250, new ComponentsEqualityComparer());
 
         private static readonly Dictionary<string, CameraType> NameToCameraType = new()
         {

EXILED/Exiled.API/Features/Doors/AirlockController.cs

@@ -20,7 +20,7 @@ public class AirlockController
         /// <summary>
         /// A <see cref="Dictionary{TKey,TValue}"/> containing all known <see cref="BaseController"/>'s and their corresponding <see cref="AirlockController"/>.
         /// </summary>
-        internal static readonly Dictionary<BaseController, AirlockController> BaseToExiledControllers = new();
+        internal static readonly Dictionary<BaseController, AirlockController> BaseToExiledControllers = new(new ComponentsEqualityComparer());
 
         /// <summary>
         /// Initializes a new instance of the <see cref="AirlockController"/> class.

EXILED/Exiled.API/Features/Doors/Door.cs

@@ -14,7 +14,9 @@ namespace Exiled.API.Features.Doors
     using Exiled.API.Enums;
     using Exiled.API.Extensions;
     using Exiled.API.Features.Core;
+    using Exiled.API.Features.Hazards;
     using Exiled.API.Interfaces;
+    using global::Hazards;
     using Interactables.Interobjects;
     using Interactables.Interobjects.DoorUtils;
     using MEC;
@@ -38,7 +40,7 @@ public class Door : TypeCastObject<Door>, IWrapper<DoorVariant>, IWorldSpace
         /// <summary>
         /// A <see cref="Dictionary{TKey,TValue}"/> containing all known <see cref="DoorVariant"/>'s and their corresponding <see cref="Door"/>.
         /// </summary>
-        internal static readonly Dictionary<DoorVariant, Door> DoorVariantToDoor = new();
+        internal static readonly Dictionary<DoorVariant, Door> DoorVariantToDoor = new(new ComponentsEqualityComparer());
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Door"/> class.
@@ -309,6 +311,31 @@ public static Door Get(DoorVariant doorVariant)
             return DoorVariantToDoor[doorVariant];
         }
 
+        /// <summary>
+        /// Gets the <see cref="Door"/> by <see cref="DoorVariant"/>.
+        /// </summary>
+        /// <param name="doorVariant">The <see cref="DoorVariant"/> to convert into an door.</param>
+        /// <typeparam name="T">The specified <see cref="Door"/> type.</typeparam>
+        /// <returns>The door wrapper for the given <see cref="DoorVariant"/>.</returns>
+        public static T Get<T>(DoorVariant doorVariant)
+            where T : Door => Get(doorVariant) as T;
+
+        /// <summary>
+        /// Gets a <see cref="Door"/> given the specified <see cref="DoorType"/>.
+        /// </summary>
+        /// <param name="doorType">The <see cref="DoorType"/> to search for.</param>
+        /// <returns>The <see cref="Door"/> with the given <see cref="DoorType"/> or <see langword="null"/> if not found.</returns>
+        public static Door Get(DoorType doorType) => List.FirstOrDefault(x => x.Type == doorType);
+
+        /// <summary>
+        /// Gets the <see cref="Door"/> by <see cref="DoorVariant"/>.
+        /// </summary>
+        /// <param name="doorType">The <see cref="DoorVariant"/> to convert into an door.</param>
+        /// <typeparam name="T">The specified <see cref="Door"/> type.</typeparam>
+        /// <returns>The door wrapper for the given <see cref="DoorVariant"/>.</returns>
+        public static T Get<T>(DoorType doorType)
+            where T : Door => Get(doorType) as T;
+
         /// <summary>
         /// Gets a <see cref="Door"/> given the specified name.
         /// </summary>
@@ -320,27 +347,22 @@ public static Door Get(string name)
             return nameExtension is null ? null : Get(nameExtension.TargetDoor);
         }
 
+        /// <summary>
+        /// Gets the <see cref="Door"/> by <see cref="DoorVariant"/>.
+        /// </summary>
+        /// <param name="name">The name to search for.</param>
+        /// <typeparam name="T">The specified <see cref="Door"/> type.</typeparam>
+        /// <returns>The door wrapper for the given <see cref="DoorVariant"/>.</returns>
+        public static T Get<T>(string name)
+            where T : Door => Get(name) as T;
+
         /// <summary>
         /// Gets the door object associated with a specific <see cref="UnityEngine.GameObject"/>, or creates a new one if there isn't one.
         /// </summary>
         /// <param name="gameObject">The base-game <see cref="UnityEngine.GameObject"/>.</param>
         /// <returns>The <see cref="Door"/> with the given name or <see langword="null"/> if not found.</returns>
         public static Door Get(GameObject gameObject) => gameObject is null ? null : Get(gameObject.GetComponentInChildren<DoorVariant>());
 
-        /// <summary>
-        /// Gets a <see cref="IEnumerable{T}"/> of <see cref="Door"/> filtered based on a predicate.
-        /// </summary>
-        /// <param name="predicate">The condition to satify.</param>
-        /// <returns>A <see cref="IEnumerable{T}"/> of <see cref="Door"/> which contains elements that satify the condition.</returns>
-        public static IEnumerable<Door> Get(Func<Door, bool> predicate) => List.Where(predicate);
-
-        /// <summary>
-        /// Gets a <see cref="Door"/> given the specified <see cref="DoorType"/>.
-        /// </summary>
-        /// <param name="doorType">The <see cref="DoorType"/> to search for.</param>
-        /// <returns>The <see cref="Door"/> with the given <see cref="DoorType"/> or <see langword="null"/> if not found.</returns>
-        public static Door Get(DoorType doorType) => List.FirstOrDefault(x => x.Type == doorType);
-
         /// <summary>
         /// Returns the closest <see cref="Door"/> to the given <paramref name="position"/>.
         /// </summary>
@@ -367,6 +389,13 @@ public static Door Random(ZoneType type = ZoneType.Unspecified, bool onlyUnbroke
             return doors[UnityEngine.Random.Range(0, doors.Count)];
         }
 
+        /// <summary>
+        /// Gets a <see cref="IEnumerable{T}"/> of <see cref="Door"/> filtered based on a predicate.
+        /// </summary>
+        /// <param name="predicate">The condition to satify.</param>
+        /// <returns>A <see cref="IEnumerable{T}"/> of <see cref="Door"/> which contains elements that satify the condition.</returns>
+        public static IEnumerable<Door> Get(Func<Door, bool> predicate) => List.Where(predicate);
+
         /// <summary>
         /// Locks all <see cref="Door">doors</see> given the specified <see cref="ZoneType"/>.
         /// </summary>

EXILED/Exiled.API/Features/Generator.cs

@@ -26,7 +26,7 @@ public class Generator : IWrapper<Scp079Generator>, IWorldSpace
         /// <summary>
         /// A <see cref="List{T}"/> of <see cref="Generator"/> on the map.
         /// </summary>
-        internal static readonly Dictionary<Scp079Generator, Generator> Scp079GeneratorToGenerator = new();
+        internal static readonly Dictionary<Scp079Generator, Generator> Scp079GeneratorToGenerator = new(new ComponentsEqualityComparer());
         private Room room;
 
         /// <summary>