Locker API

Exiled.API/Features/Lockers/Chamber.cs

@@ -0,0 +1,171 @@
+// -----------------------------------------------------------------------
+// <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>
+    {
+        internal static 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 a time before player can again interact chamber.
+        /// </summary>
+        public float Cooldown
+        {
+            get => Base._targetCooldown;
+            set => Base._targetCooldown = value;
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether or not player can interact with chamber now.
+        /// </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,89 @@
+// -----------------------------------------------------------------------
+// <copyright file="Locker.cs" company="Exiled Team">
+// Copyright (c) Exiled Team. All rights reserved.
+// Licensed under the CC BY-SA 3.0 license.
+// </copyright>
+// -----------------------------------------------------------------------
+
+using System;
+
+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;
+
+    public class Locker : TypeCastObject<Locker>, IWrapper<BaseLocker>
+    {
+        internal static Dictionary<BaseLocker, Locker> BaseToExiledLockers = new();
+
+        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(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,28 @@
+// -----------------------------------------------------------------------
+// <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;
+
+    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

@@ -5,6 +5,8 @@
 // </copyright>
 // -----------------------------------------------------------------------
 
+using Exiled.API.Features.Lockers;
+
 namespace Exiled.API.Features
 {
     using System;
@@ -25,7 +27,6 @@
     using Items;
     using LightContainmentZoneDecontamination;
     using MapGeneration;
-    using MapGeneration.Distributors;
     using Mirror;
     using PlayerRoles;
     using PlayerRoles.PlayableScps.Scp173;
@@ -116,9 +117,9 @@
         public static ReadOnlyCollection<PocketDimensionTeleport> PocketDimensionTeleports => ReadOnlyTeleportsValue;
 
         /// <summary>
-        /// Gets all <see cref="Locker"/> objects.
+        /// Gets all <see cref="Lockers.Locker"/> objects.
         /// </summary>
-        public static ReadOnlyCollection<Locker> Lockers => ReadOnlyLockersValue;
+        public static ReadOnlyCollection<Lockers.Locker> Lockers => ReadOnlyLockersValue;
 
         /// <summary>
         /// Gets all <see cref="AdminToy"/> objects.

Exiled.API/Features/Player.cs

@@ -3005,11 +3005,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);
@@ -3044,7 +3044,7 @@ public void Teleport(object obj, Vector3 offset)
         /// <param name="type">Object for teleport.</param>
         public void RandomTeleport(Type type)
         {
-            LockerChamber[] chambers;
+            Lockers.Chamber[] chambers;
 
             object randomObject = type.Name switch
             {
@@ -3059,7 +3059,7 @@ public void RandomTeleport(Type type)
                 nameof(Generator) => Generator.List.ElementAt(Random.Range(0, Generator.Scp079GeneratorToGenerator.Count)),
                 nameof(Window) => Window.List.ElementAt(Random.Range(0, Window.BreakableWindowToWindow.Count)),
                 nameof(Scp914) => Scp914.Scp914Controller,
-                nameof(LockerChamber) => (chambers = Map.GetRandomLocker().Chambers)[Random.Range(0, chambers.Length)],
+                nameof(Lockers.Chamber) => (chambers = Map.GetRandomLocker().Chambers.ToArray())[Random.Range(0, chambers.Length)],
                 _ => null,
             };
 

Exiled.CustomItems/API/Features/CustomItem.cs

@@ -5,6 +5,8 @@
 // </copyright>
 // -----------------------------------------------------------------------
 
+using Exiled.API.Features.Lockers;
+
 namespace Exiled.CustomItems.API.Features
 {
     using System;
@@ -681,7 +683,7 @@ public virtual uint Spawn(IEnumerable<SpawnPoint> spawnPoints, uint limit)
                             continue;
                         }
 
-                        Locker locker =
+                        Exiled.API.Features.Lockers.Locker locker =
                             Map.Lockers[
                                 Loader.Random.Next(Map.Lockers.Count)];
 
@@ -703,15 +705,19 @@ public virtual uint Spawn(IEnumerable<SpawnPoint> spawnPoints, uint limit)
                             continue;
                         }
 
-                        LockerChamber chamber = locker.Chambers[Loader.Random.Next(Mathf.Max(0, locker.Chambers.Length - 1))];
+                        Chamber chamber = locker.Chambers.ElementAt(Loader.Random.Next(Mathf.Max(0, locker.Chambers.Count - 1)));
 
                         if (chamber is null)
                         {
                             Log.Debug($"{nameof(Spawn)}: chamber is null");
                             continue;
                         }
 
-                        Vector3 position = chamber._spawnpoint.transform.position;
+                        Vector3 position = chamber.Spawnpoint.transform.position;
+
+                        if (chamber.UseMultipleSpawnpoints)
+                            position = chamber.Spawnpoints.ElementAt(Loader.Random.Next(Mathf.Max(0, chamber.Spawnpoints.Count() - 1))).transform.position;
+
                         Spawn(position, null);
                         Log.Debug($"Spawned {Name} at {position} ({spawnPoint.Name})");