Locker API

Exiled.API/Features/Lockers/Chamber.cs

@@ -0,0 +1,174 @@
+// -----------------------------------------------------------------------
+// <copyright file="Chamber.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Lockers
+{
+    using System.Collections.Generic;
+    using System.Linq;
+
+    using Exiled.API.Enums;
+    using Exiled.API.Features.Pickups;
+    using Exiled.API.Interfaces;
+    using MapGeneration.Distributors;
+    using UnityEngine;
+
+    /// <summary>
+    /// A wrapper for <see cref="LockerChamber"/>.
+    /// </summary>
+    public class Chamber : IWrapper<LockerChamber>
+    {
+        /// <summary>
+        /// <see cref="Dictionary{TKey,TValue}"/> with <see cref="LockerChamber"/> and <see cref="Chamber"/>.
+        /// </summary>
+        internal static readonly Dictionary<LockerChamber, Chamber> Chambers = new();
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Chamber"/> class.
+        /// </summary>
+        /// <param name="chamber"><see cref="LockerChamber"/> instance.</param>
+        public Chamber(LockerChamber chamber)
+        {
+            Base = chamber;
+
+            Chambers.Add(chamber, this);
+        }
+
+        /// <summary>
+        /// Gets the list with all chambers.
+        /// </summary>
+        public static IReadOnlyCollection<Chamber> List => Chambers.Values;
+
+        /// <inheritdoc/>
+        public LockerChamber Base { get; }
+
+        /// <summary>
+        /// Gets or sets a list with all pickups that should be spawned when door will be opened first time.
+        /// </summary>
+        public IEnumerable<Pickup> ToBeSpawned
+        {
+            get => Base._toBeSpawned.Select(Pickup.Get);
+            set
+            {
+                Base._toBeSpawned.Clear();
+
+                foreach (var pickup in value)
+                    Base._toBeSpawned.Add(pickup.Base);
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the list with all pickups in chamber.
+        /// </summary>
+        public IEnumerable<Pickup> AllPickups
+        {
+            get => Base._content.Select(Pickup.Get);
+            set
+            {
+                Base._content.Clear();
+
+                foreach (var pickup in value)
+                    Base._content.Add(pickup.Base);
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the list with all spawnpoints.
+        /// </summary>
+        /// <remarks>
+        /// Will be used if <see cref="UseMultipleSpawnpoints"/> is <see langword="true"/>.
+        /// </remarks>
+        public IEnumerable<Transform> Spawnpoints
+        {
+            get => Base._spawnpoints;
+            set => Base._spawnpoints = value.ToArray();
+        }
+
+        /// <summary>
+        /// Gets or sets the list with <see cref="ItemType"/> which can be spawned in this chamber.
+        /// </summary>
+        public IEnumerable<ItemType> AcceptableTypes
+        {
+            get => Base.AcceptableItems;
+            set => Base.AcceptableItems = value.ToArray();
+        }
+
+        /// <summary>
+        /// Gets or sets required permissions to open this chamber.
+        /// </summary>
+        public KeycardPermissions RequiredPermissions
+        {
+            get => (KeycardPermissions)Base.RequiredPermissions;
+            set => Base.RequiredPermissions = (Interactables.Interobjects.DoorUtils.KeycardPermissions)value;
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether or not multiple spawnpoint system should be used.
+        /// </summary>
+        /// <remarks>
+        /// If true, spawnpoint system will use <see cref="Spawnpoints"/>. Otherwise, <see cref="Spawnpoint"/>.
+        /// </remarks>
+        public bool UseMultipleSpawnpoints
+        {
+            get => Base._useMultipleSpawnpoints;
+            set => Base._useMultipleSpawnpoints = value;
+        }
+
+        /// <summary>
+        /// Gets or sets a spawnpoint for items in locker chamber.
+        /// </summary>
+        /// <remarks>
+        /// Will be used if <see cref="UseMultipleSpawnpoints"/> is <see langword="false"/>.
+        /// </remarks>
+        public Transform Spawnpoint
+        {
+            get => Base._spawnpoint;
+            set => Base._spawnpoint = value;
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether or not items should be spawned as soon as they are initialised.
+        /// </summary>
+        public bool InitiallySpawn
+        {
+            get => Base._spawnOnFirstChamberOpening;
+            set => Base._spawnOnFirstChamberOpening = value;
+        }
+
+        /// <summary>
+        /// Gets or sets the amount of time before a player can interact with the chamber again.
+        /// </summary>
+        public float Cooldown
+        {
+            get => Base._targetCooldown;
+            set => Base._targetCooldown = value;
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether or not the chamber can currently be interacted with.
+        /// </summary>
+        public bool CanInteract => Base.CanInteract;
+
+        /// <summary>
+        /// Gets the locker where this chamber is located.
+        /// </summary>
+        public Locker Locker => Locker.Get(x => x.Chambers.Contains(this)).FirstOrDefault();
+
+        /// <summary>
+        /// Spawns a specified item from <see cref="AcceptableTypes"/>.
+        /// </summary>
+        /// <param name="type"><see cref="ItemType"/> from <see cref="AcceptableTypes"/>.</param>
+        /// <param name="amount">Amount of items that should be spawned.</param>
+        public void SpawnItem(ItemType type, int amount) => Base.SpawnItem(type, amount);
+
+        /// <summary>
+        /// Gets the chamber by it's <see cref="LockerChamber"/>.
+        /// </summary>
+        /// <param name="chamber"><see cref="LockerChamber"/>.</param>
+        /// <returns><see cref="Chamber"/>.</returns>
+        internal static Chamber Get(LockerChamber chamber) => Chambers.TryGetValue(chamber, out var chmb) ? chmb : new(chamber);
+    }
+}

Exiled.API/Features/Lockers/Locker.cs

@@ -0,0 +1,97 @@
+// -----------------------------------------------------------------------
+// <copyright file="Locker.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Lockers
+{
+    using System.Collections.Generic;
+    using System.Linq;
+
+    using Exiled.API.Features.Core;
+    using Exiled.API.Interfaces;
+    using MapGeneration.Distributors;
+    using UnityEngine;
+
+    using BaseLocker = MapGeneration.Distributors.Locker;
+
+    /// <summary>
+    /// Represents a basic locker.
+    /// </summary>
+    public class Locker : TypeCastObject<Locker>, IWrapper<BaseLocker>
+    {
+        /// <summary>
+        /// <see cref="Dictionary{TKey,TValue}"/> with <see cref="BaseLocker"/> and <see cref="Locker"/>.
+        /// </summary>
+        internal static readonly Dictionary<BaseLocker, Locker> BaseToExiledLockers = new();
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Locker"/> class.
+        /// </summary>
+        /// <param name="locker">The <see cref="BaseLocker"/> instance.</param>
+        public Locker(BaseLocker locker)
+        {
+            Base = locker;
+            Chambers = locker.Chambers.Select(x => new Chamber(x)).ToList();
+
+            BaseToExiledLockers.Add(locker, this);
+        }
+
+        /// <summary>
+        /// Gets the list with all <see cref="Locker"/>.
+        /// </summary>
+        public static IReadOnlyCollection<Locker> List => BaseToExiledLockers.Values;
+
+        /// <inheritdoc/>
+        public BaseLocker Base { get; }
+
+        /// <summary>
+        /// Gets or sets list of all <see cref="LockerLoot"/> in this locker.
+        /// </summary>
+        public IEnumerable<LockerLoot> Loot
+        {
+            get => Base.Loot;
+            set => Base.Loot = value.ToArray();
+        }
+
+        /// <summary>
+        /// Gets the list with all <see cref="Chambers"/> in this locker.
+        /// </summary>
+        public IReadOnlyCollection<Chamber> Chambers { get; }
+
+        /// <summary>
+        /// Gets the <see cref="Locker"/> by it's basegame analog.
+        /// </summary>
+        /// <param name="locker"><see cref="BaseLocker"/> instance.</param>
+        /// <returns><see cref="Locker"/> instance.</returns>
+        public static Locker Get(BaseLocker locker) => BaseToExiledLockers.TryGetValue(locker, out var lk)
+            ? lk
+            : locker switch
+            {
+                PedestalScpLocker psl => new PedestalLocker(psl),
+                _ => new Locker(locker)
+            };
+
+        /// <summary>
+        /// Gets the list of <see cref="Locker"/> which matches predicate.
+        /// </summary>
+        /// <param name="predicate">Predicate to match.</param>
+        /// <returns>List of <see cref="Locker"/> which matches predicate.</returns>
+        public static IEnumerable<Locker> Get(System.Func<Locker, bool> predicate) => List.Where(predicate);
+
+        /// <summary>
+        /// Interacts with a specific chamber.
+        /// </summary>
+        /// <param name="chamber">Chamber. If <see langword="null"/>, will interact with random.</param>
+        /// <param name="player">Player who interacts.</param>
+        public void Interact(Chamber chamber = null, Player player = null) => Base.ServerInteract(player?.ReferenceHub, (byte)(chamber == null ? Random.Range(0, Chambers.Count + 1) : Chambers.ToList().IndexOf(chamber)));
+
+        /// <summary>
+        /// Fills chamber.
+        /// </summary>
+        /// <param name="chamber">Chamber to fill.</param>
+        public void FillChamber(Chamber chamber) => Base.FillChamber(chamber.Base);
+    }
+}

Exiled.API/Features/Lockers/PedestalLocker.cs

@@ -0,0 +1,31 @@
+// -----------------------------------------------------------------------
+// <copyright file="PedestalLocker.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Features.Lockers
+{
+    using Exiled.API.Interfaces;
+    using MapGeneration.Distributors;
+
+    /// <summary>
+    /// Represents a pedestal.
+    /// </summary>
+    public class PedestalLocker : Locker, IWrapper<PedestalScpLocker>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PedestalLocker"/> class.
+        /// </summary>
+        /// <param name="locker"><see cref="PedestalScpLocker"/> instance.</param>
+        public PedestalLocker(PedestalScpLocker locker)
+            : base(locker)
+        {
+            Base = locker;
+        }
+
+        /// <inheritdoc/>
+        public new PedestalScpLocker Base { get; }
+    }
+}

Exiled.API/Features/Map.cs

@@ -48,7 +48,8 @@ public static class Map
         /// <summary>
         /// A list of <see cref="Locker"/>s on the map.
         /// </summary>
-        internal static readonly List<Locker> LockersValue = new(35);
+        // ReSharper disable once CollectionNeverUpdated.Global
+        internal static readonly List<Locker> LockersValue = new(35); // TODO: Remove
 
         /// <summary>
         /// A list of <see cref="PocketDimensionTeleport"/>s on the map.
@@ -114,8 +115,9 @@ public static Scp939AmnesticCloudInstance AmnesticCloudPrefab
         public static ReadOnlyCollection<PocketDimensionTeleport> PocketDimensionTeleports { get; } = TeleportsValue.AsReadOnly();
 
         /// <summary>
-        /// Gets all <see cref="Locker"/> objects.
+        /// Gets all <see cref="Lockers.Locker"/> objects.
         /// </summary>
+        [Obsolete("Use Locker::List instead.")]
         public static ReadOnlyCollection<Locker> Lockers { get; } = LockersValue.AsReadOnly();
 
         /// <summary>
@@ -221,8 +223,15 @@ public static void TurnOffAllLights(float duration, IEnumerable<ZoneType> zoneTy
         /// Gets a random <see cref="Locker"/>.
         /// </summary>
         /// <returns><see cref="Locker"/> object.</returns>
+        [Obsolete("Use GetRandomExiledLocker() instead.")]
         public static Locker GetRandomLocker() => Lockers.GetRandomValue();
 
+        /// <summary>
+        /// Gets a random <see cref="Features.Lockers.Locker"/>.
+        /// </summary>
+        /// <returns><see cref="Features.Lockers.Locker"/> object.</returns>
+        public static Lockers.Locker GetRandomExiledLocker() => Features.Lockers.Locker.List.GetRandomValue();
+
         /// <summary>
         /// Gets a random <see cref="Pickup"/>.
         /// </summary>
@@ -375,6 +384,8 @@ internal static void ClearCache()
             Firearm.ItemTypeToFirearmInstance.Clear();
             Firearm.BaseCodesValue.Clear();
             Firearm.AvailableAttachmentsValue.Clear();
+            Features.Lockers.Locker.BaseToExiledLockers.Clear();
+            Features.Lockers.Chamber.Chambers.Clear();
         }
     }
 }

Exiled.API/Features/Player.cs

@@ -21,6 +21,7 @@ namespace Exiled.API.Features
     using Exiled.API.Features.Doors;
     using Exiled.API.Features.Hazards;
     using Exiled.API.Features.Items;
+    using Exiled.API.Features.Lockers;
     using Exiled.API.Features.Pickups;
     using Exiled.API.Features.Pools;
     using Exiled.API.Features.Roles;
@@ -2992,11 +2993,11 @@ public void Teleport(object obj, Vector3 offset)
                     else
                         Log.Warn($"{nameof(Teleport)}: {Assembly.GetCallingAssembly().GetName().Name}: Invalid role teleport (role is missing Owner).");
                     break;
-                case Locker locker:
-                    Teleport(locker.transform.position + Vector3.up + offset);
+                case Lockers.Locker locker:
+                    Teleport(locker.Base.transform.position + Vector3.up + offset);
                     break;
-                case LockerChamber chamber:
-                    Teleport(chamber._spawnpoint.position + Vector3.up + offset);
+                case Lockers.Chamber chamber:
+                    Teleport(chamber.UseMultipleSpawnpoints ? chamber.Spawnpoints.ElementAt(Random.Range(0, chamber.Spawnpoints.Count() - 1)).transform.position : chamber.Spawnpoint.transform.position + Vector3.up + offset);
                     break;
                 case ElevatorChamber elevator:
                     Teleport(elevator.transform.position + Vector3.up + offset);
@@ -3040,11 +3041,11 @@ public void RandomTeleport(Type type)
                 nameof(Player) => Dictionary.Values.GetRandomValue(),
                 nameof(Pickup) => Pickup.BaseToPickup.GetRandomValue().Value,
                 nameof(Ragdoll) => Ragdoll.List.GetRandomValue(),
-                nameof(Locker) => Map.GetRandomLocker(),
+                nameof(MapGeneration.Distributors.Locker) or nameof(Lockers.Locker) => Map.GetRandomExiledLocker(),
                 nameof(Generator) => Generator.List.GetRandomValue(),
                 nameof(Window) => Window.List.GetRandomValue(),
                 nameof(Scp914) => Scp914.Scp914Controller,
-                nameof(LockerChamber) => Map.GetRandomLocker().Chambers.GetRandomValue(),
+                nameof(LockerChamber) or nameof(Chamber) => Map.GetRandomExiledLocker().Chambers.GetRandomValue(),
                 _ => null,
             };