Camera toy wrapper (northwood-studios#229)

* Isolated room creation from base game.

* Added camera toy wrapper

* Added camera property to camera toy wapper

---------

Co-authored-by: ced777ric <44529860+ced777ric@users.noreply.github.com>

Author: brayden-dowson

LabApi/Features/Wrappers/AdminToys/AdminToy.cs

@@ -27,6 +27,7 @@ internal static void Initialize()
         Register<ShootingTarget>(x => new ShootingTargetToy(x));
         Register<AdminToys.SpeakerToy>(x => new SpeakerToy(x));
         Register<InvisibleInteractableToy>(x => new InteractableToy(x));
+        Register<Scp079CameraToy>(x => new CameraToy(x));
     }
 
     /// <summary>

LabApi/Features/Wrappers/AdminToys/CameraToy.cs

@@ -0,0 +1,186 @@
+using AdminToys;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using UnityEngine;
+
+namespace LabApi.Features.Wrappers;
+
+/// <summary>
+/// The wrapper for the <see cref="Scp079CameraToy"/> class.
+/// </summary>
+public class CameraToy : AdminToy
+{
+    /// <summary>
+    /// Contains all the camera toys, accessible through their <see cref="Base"/>.
+    /// </summary>
+    public new static Dictionary<Scp079CameraToy, CameraToy> Dictionary { get; } = [];
+
+    /// <summary>
+    /// A reference to all instances of <see cref="CameraToy"/>.
+    /// </summary>
+    public new static IReadOnlyCollection<CameraToy> List => Dictionary.Values;
+
+    /// <summary>
+    /// An internal constructor to prevent external instantiation.
+    /// </summary>
+    /// <param name="baseCameraToy">The base <see cref="Scp079CameraToy"/> object.</param>
+    internal CameraToy(Scp079CameraToy baseCameraToy)
+        : base(baseCameraToy)
+    {
+        Dictionary.Add(baseCameraToy, this);
+        Base = baseCameraToy;
+    }
+
+    /// <summary>
+    /// An internal method to remove itself from the cache when the base object is destroyed.
+    /// </summary>
+    internal override void OnRemove()
+    {
+        base.OnRemove();
+        Dictionary.Remove(Base);
+    }
+
+    /// <summary>
+    /// The <see cref="Scp079CameraToy"/> object.
+    /// </summary>
+    public new Scp079CameraToy Base { get; }
+
+    /// <summary>
+    /// The camera instance associated with this toy.
+    /// </summary>
+    public Camera Camera => Camera.Get(Base.Camera);
+
+    /// <summary>
+    /// Gets or sets the label of the camera displayed to SCP-079 on HUD.
+    /// </summary>
+    public string Label
+    {
+        get => Base.Label;
+        set => Base.NetworkLabel = value;
+    }
+
+    /// <summary>
+    /// Gets or sets the room associated with this camera.
+    /// </summary>
+    /// <remarks>
+    /// Room will never be <see langword="null"/>.
+    /// This determines what cameras are visible to SCP-079 for what room.
+    /// </remarks>
+    public Room Room
+    {
+        get => Room.Get(Base.Room);
+        set => Base.NetworkRoom = value.Base;
+    }
+
+    /// <summary>
+    /// Gets or sets how high and low the camera can move from its initial rotation in degrees.
+    /// </summary>
+    /// <remarks>
+    /// X should be less than or equal to y. e.g. <c>Vector2(-10, 30)</c> means you can look up 10 degrees and down 30.
+    /// </remarks>
+    public Vector2 VerticalConstraints
+    {
+        get => Base.VerticalConstraint;
+        set => Base.NetworkVerticalConstraint = value;
+    }
+
+    /// <summary>
+    /// Gets or sets how left and right the camera can move from its initial rotation in degrees.
+    /// </summary>
+    /// <remarks>
+    /// X should be less than or equal to y. e.g. <c>Vector2(-10, 30)</c> means you can look left 10 degrees and right 30.
+    /// </remarks>
+    public Vector2 HorizontalConstraint
+    {
+        get => Base.HorizontalConstraint;
+        set => Base.NetworkHorizontalConstraint = value;
+    }
+
+    /// <summary>
+    /// Gets or set the min and max zoom level of the camera.
+    /// </summary>
+    /// <remarks>
+    /// Values range from 0.0 to 1.0, with zero being the minimum zoom, and 1 being the maximum zoom. 
+    /// X should be less than or equal to y.
+    /// </remarks>
+    public Vector2 ZoomConstraints
+    {
+        get => Base.ZoomConstraint;
+        set => Base.NetworkZoomConstraint = value;
+    }
+
+    /// <summary>
+    /// Creates a new camera toy.
+    /// </summary>
+    /// <param name="parent">The parent transform.</param>
+    /// <param name="networkSpawn">Whether to spawn the toy on the client.</param>
+    /// <returns>The created camera toy.</returns>
+    public static CameraToy Create(Transform? parent = null, bool networkSpawn = true)
+        => Create(Vector3.zero, parent, networkSpawn);
+
+    /// <summary>
+    /// Creates a new camera toy.
+    /// </summary>
+    /// <param name="position">The initial local position.</param>
+    /// <param name="parent">The parent transform.</param>
+    /// <param name="networkSpawn">Whether to spawn the toy on the client.</param>
+    /// <returns>The created camera toy.</returns>
+    public static CameraToy Create(Vector3 position, Transform? parent = null, bool networkSpawn = true)
+        => Create(position, Quaternion.identity, parent, networkSpawn);
+
+    /// <summary>
+    /// Creates a new camera toy.
+    /// </summary>
+    /// <param name="position">The initial local position.</param>
+    /// <param name="rotation">The initial local rotation.</param>
+    /// <param name="parent">The parent transform.</param>
+    /// <param name="networkSpawn">Whether to spawn the toy on the client.</param>
+    /// <returns>The created camera toy.</returns>
+    public static CameraToy Create(Vector3 position, Quaternion rotation, Transform? parent = null, bool networkSpawn = true)
+        => Create(position, rotation, Vector3.one, parent, networkSpawn);
+
+    /// <summary>
+    /// Creates a new camera toy.
+    /// </summary>
+    /// <param name="position">The initial local position.</param>
+    /// <param name="rotation">The initial local rotation.</param>
+    /// <param name="scale">The initial local scale.</param>
+    /// <param name="parent">The parent transform.</param>
+    /// <param name="networkSpawn">Whether to spawn the toy on the client.</param>
+    /// <returns>The created camera toy.</returns>
+    public static CameraToy Create(Vector3 position, Quaternion rotation, Vector3 scale, Transform? parent = null, bool networkSpawn = true)
+    {
+        CameraToy toy = Get(Create<Scp079CameraToy>(position, rotation, scale, parent));
+
+        if (networkSpawn)
+            toy.Spawn();
+
+        return toy;
+    }
+
+    /// <summary>
+    /// Gets the camera toy wrapper from the <see cref="Dictionary"/> or creates a new one if it doesn't exist and the provided <see cref="Scp079CameraToy"/> was not <see langword="null"/>.
+    /// </summary>
+    /// <param name="baseCameraToy">The <see cref="Base"/> of the camera toy.</param>
+    /// <returns>The requested camera toy or <see langword="null"/>.</returns>
+    [return: NotNullIfNotNull(nameof(baseCameraToy))]
+    public static CameraToy? Get(Scp079CameraToy? baseCameraToy)
+    {
+        if (baseCameraToy == null)
+            return null;
+
+        return Dictionary.TryGetValue(baseCameraToy, out CameraToy item) ? item : (CameraToy)CreateAdminToyWrapper(baseCameraToy);
+    }
+
+    /// <summary>
+    /// Tries to get the camera toy wrapper from the <see cref="Dictionary"/>.
+    /// </summary>
+    /// <param name="baseCameraToy">The <see cref="Base"/> of the camera toy.</param>
+    /// <param name="cameraToy">The requested camera toy.</param>
+    /// <returns>True if the camera toy exists, otherwise false.</returns>
+    public static bool TryGet(Scp079CameraToy? baseCameraToy, [NotNullWhen(true)] out CameraToy? cameraToy)
+    {
+        cameraToy = Get(baseCameraToy);
+        return cameraToy != null;
+    }
+}

LabApi/Features/Wrappers/Facility/Rooms/PocketDimension/PocketDimension.cs

@@ -71,7 +71,8 @@ public static float MaxPocketItemTriggerDelay
     internal PocketDimension(RoomIdentifier room) 
         : base(room) 
     {
-        Instance = this;
+        if (CanCache)
+            Instance = this;
     }
 
     /// <summary>

LabApi/Features/Wrappers/Facility/Rooms/Room.cs

@@ -39,8 +39,10 @@ internal static void Initialize()
     /// <param name="roomIdentifier">The identifier of the room.</param>
     internal Room(RoomIdentifier roomIdentifier)
     {
-        Dictionary.Add(roomIdentifier, this);
         Base = roomIdentifier;
+
+        if (CanCache)
+            Dictionary.Add(roomIdentifier, this);
     }
 
     /// <summary>
@@ -56,6 +58,11 @@ internal virtual void OnRemoved()
     /// </summary>
     public RoomIdentifier Base { get; }
 
+    /// <summary>
+    /// Gets whether the base room instance was destroyed.
+    /// </summary>
+    public bool IsDestroyed => Base == null || GameObject == null;
+
     /// <summary>
     /// The room's shape.
     /// </summary>
@@ -124,20 +131,26 @@ public IEnumerable<Door> Doors
     /// </summary>
     public IEnumerable<Player> Players => Player.List.Where(p => p.Room == this);
 
+    /// <summary>
+    /// Gets whether the room wrapper is allowed to be cached.
+    /// </summary>
+    protected bool CanCache => !IsDestroyed;
+
     /// <summary>
     /// Gets the room wrapper from the <see cref="Dictionary"/>, or creates a new one if it doesn't exist.
     /// </summary>
     /// <param name="roomIdentifier">The identifier of the room.</param>
     /// <returns>The requested room.</returns>
-    public static Room? Get(RoomIdentifier roomIdentifier)
+    [return: NotNullIfNotNull(nameof(roomIdentifier))]
+    public static Room? Get(RoomIdentifier? roomIdentifier)
     {
         if (roomIdentifier == null)
             return null;
 
-        if (!Dictionary.TryGetValue(roomIdentifier, out Room room))
-            return null;
+        if (Dictionary.TryGetValue(roomIdentifier, out Room room))
+            return room;
 
-        return room;
+        return CreateRoomWrapper(roomIdentifier);
     }
 
     /// <summary>
@@ -208,14 +221,36 @@ public static bool TryGetRoomAtPosition(Vector3 position, [NotNullWhen(true)] ou
     /// <returns>The room at the specified position or <see langword="null"/> if no room was found.</returns>
     public static Room? GetRoomAtPosition(Vector3 position) => TryGetRoomAtPosition(position, out Room? room) ? room : null;
 
+    /// <summary>
+    /// Creates a new wrapper from the base room object.
+    /// </summary>
+    /// <param name="roomIdentifier">The base <see cref="RoomIdentifier"/> object.</param>
+    /// <returns>The newly created wrapper.</returns>
+    protected static Room CreateRoomWrapper(RoomIdentifier roomIdentifier)
+    {
+        if (roomIdentifier.Name == RoomName.Pocket)
+            return new PocketDimension(roomIdentifier);
+        else if (roomIdentifier.Name == RoomName.Lcz914)
+            return new Scp914(roomIdentifier);
+        else
+            return new Room(roomIdentifier);
+    }
+
     /// <summary>
     /// Handles the creation of a room in the server.
     /// </summary>
     /// <param name="roomIdentifier">The <see cref="RoomIdentifier"/> of the room.</param>
-    // TODO: use factory instead.
     private static void AddRoom(RoomIdentifier roomIdentifier)
     {
-        _ = roomIdentifier.Name == RoomName.Pocket ? new PocketDimension(roomIdentifier) : new Room(roomIdentifier);
+        try
+        {
+            if (!Dictionary.ContainsKey(roomIdentifier))
+                _ = CreateRoomWrapper(roomIdentifier);
+        }
+        catch (System.Exception e)
+        {
+            Console.Logger.InternalError($"Failed to handle room creation with error: {e}");
+        }
     }
 
     /// <summary>
@@ -224,7 +259,14 @@ private static void AddRoom(RoomIdentifier roomIdentifier)
     /// <param name="roomIdentifier">The <see cref="RoomIdentifier"/> of the room.</param>
     private static void RemoveRoom(RoomIdentifier roomIdentifier)
     {
-        if (Dictionary.TryGetValue(roomIdentifier, out Room room))
-            room.OnRemoved();
+        try
+        {
+            if (Dictionary.TryGetValue(roomIdentifier, out Room room))
+                room.OnRemoved();
+        }
+        catch (System.Exception e)
+        {
+            Console.Logger.InternalError($"Failed to handle item destruction with error: {e}");
+        }
     }
 }

LabApi/Features/Wrappers/Facility/Rooms/Scp914/Scp914.cs

@@ -1,6 +1,5 @@
 using InventorySystem;
 using InventorySystem.Items;
-using InventorySystem.Items.Pickups;
 using LabApi.Features.Interfaces;
 using MapGeneration;
 using Scp914;
@@ -37,7 +36,8 @@ public class Scp914 : Room
     internal Scp914(RoomIdentifier roomIdentifier)
         : base(roomIdentifier)
     {
-        Instance = this;
+        if (CanCache)
+            Instance = this;
     }
 
     /// <summary>