Merge pull request #3 from ExMod-Team/dev

Dev

Author: louis1706

EXILED/Exiled.API/Enums/ScenesType.cs

@@ -0,0 +1,47 @@
+// -----------------------------------------------------------------------
+// <copyright file="ScenesType.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>
+    /// Unique identifier for the different types of Scenes the client and server can load.
+    /// </summary>
+    public enum ScenesType
+    {
+        /// <summary>
+        /// The facility itself.
+        /// </summary>
+        Facility,
+
+        /// <summary>
+        /// The current main menu.
+        /// ! Will cause crash when trying joining servers !
+        /// </summary>
+        NewMainMenu,
+
+        /// <summary>
+        /// The old main menu.
+        /// </summary>
+        MainMenuRemastered,
+
+        /// <summary>
+        /// The old server list.
+        /// </summary>
+        FastMenu,
+
+        /// <summary>
+        /// The loading Screen.
+        /// ! Will cause crash when trying joining servers !
+        /// </summary>
+        PreLoader,
+
+        /// <summary>
+        /// A black menu before loading the <see cref="NewMainMenu"/>.
+        /// </summary>
+        Loader,
+    }
+}

EXILED/Exiled.API/Extensions/MirrorExtensions.cs

@@ -15,6 +15,7 @@ namespace Exiled.API.Extensions
     using System.Reflection.Emit;
     using System.Text;
 
+    using Exiled.API.Enums;
     using Features;
     using Features.Pools;
 
@@ -355,6 +356,111 @@ public static void MessageTranslated(this Player player, string words, string tr
             }
         }
 
+        /// <summary>
+        /// Moves object for the player.
+        /// </summary>
+        /// <param name="player">Target to send.</param>
+        /// <param name="identity">The <see cref="Mirror.NetworkIdentity"/> to move.</param>
+        /// <param name="pos">The position to change.</param>
+        public static void MoveNetworkIdentityObject(this Player player, NetworkIdentity identity, Vector3 pos)
+        {
+            identity.gameObject.transform.position = pos;
+            ObjectDestroyMessage objectDestroyMessage = new()
+            {
+                netId = identity.netId,
+            };
+
+            player.Connection.Send(objectDestroyMessage, 0);
+            SendSpawnMessageMethodInfo?.Invoke(null, new object[] { identity, player.Connection });
+        }
+
+        /// <summary>
+        /// Sends to the player a Fake Change Scene.
+        /// </summary>
+        /// <param name="player">The player to send the Scene.</param>
+        /// <param name="newSceneName">The new Scene the client will load.</param>
+        public static void SendFakeSceneLoading(this Player player, ScenesType newSceneName)
+        {
+            SceneMessage message = new()
+            {
+                sceneName = newSceneName.ToString(),
+            };
+
+            player.Connection.Send(message);
+        }
+
+        /// <summary>
+        /// Emulation of the method SCP:SL uses to change scene.
+        /// </summary>
+        /// <param name="scene">The new Scene the client will load.</param>
+        public static void ChangeSceneToAllClients(ScenesType scene)
+        {
+            SceneMessage message = new()
+            {
+                sceneName = scene.ToString(),
+            };
+
+            NetworkServer.SendToAll(message);
+        }
+
+        /// <summary>
+        /// Scales an object for the specified player.
+        /// </summary>
+        /// <param name="player">Target to send.</param>
+        /// <param name="identity">The <see cref="Mirror.NetworkIdentity"/> to scale.</param>
+        /// <param name="scale">The scale the object needs to be set to.</param>
+        public static void ScaleNetworkIdentityObject(this Player player, NetworkIdentity identity, Vector3 scale)
+        {
+            identity.gameObject.transform.localScale = scale;
+            ObjectDestroyMessage objectDestroyMessage = new()
+            {
+                netId = identity.netId,
+            };
+
+            player.Connection.Send(objectDestroyMessage, 0);
+            SendSpawnMessageMethodInfo?.Invoke(null, new object[] { identity, player.Connection });
+        }
+
+        /// <summary>
+        /// Moves object for all the players.
+        /// </summary>
+        /// <param name="identity">The <see cref="NetworkIdentity"/> to move.</param>
+        /// <param name="pos">The position to change.</param>
+        public static void MoveNetworkIdentityObject(this NetworkIdentity identity, Vector3 pos)
+        {
+            identity.gameObject.transform.position = pos;
+            ObjectDestroyMessage objectDestroyMessage = new()
+            {
+                netId = identity.netId,
+            };
+
+            foreach (Player ply in Player.List)
+            {
+                ply.Connection.Send(objectDestroyMessage, 0);
+                SendSpawnMessageMethodInfo?.Invoke(null, new object[] { identity, ply.Connection });
+            }
+        }
+
+        /// <summary>
+        /// Scales an object for all players.
+        /// </summary>
+        /// <param name="identity">The <see cref="Mirror.NetworkIdentity"/> to scale.</param>
+        /// <param name="scale">The scale the object needs to be set to.</param>
+        public static void ScaleNetworkIdentityObject(this NetworkIdentity identity, Vector3 scale)
+        {
+            identity.gameObject.transform.localScale = scale;
+            ObjectDestroyMessage objectDestroyMessage = new()
+            {
+                netId = identity.netId,
+            };
+
+            foreach (Player ply in Player.List)
+            {
+                ply.Connection.Send(objectDestroyMessage, 0);
+                SendSpawnMessageMethodInfo?.Invoke(null, new object[] { identity, ply.Connection });
+            }
+        }
+
         /// <summary>
         /// Send fake values to client's <see cref="SyncVarAttribute"/>.
         /// </summary>
@@ -363,6 +469,7 @@ public static void MessageTranslated(this Player player, string words, string tr
         /// <param name="targetType"><see cref="NetworkBehaviour"/>'s type.</param>
         /// <param name="propertyName">Property name starting with Network.</param>
         /// <param name="value">Value of send to target.</param>
+        [Obsolete("Use overload with type-template instead.")]
         public static void SendFakeSyncVar(this Player target, NetworkIdentity behaviorOwner, Type targetType, string propertyName, object value)
         {
             if (!target.IsConnected)
@@ -386,6 +493,38 @@ void CustomSyncVarGenerator(NetworkWriter targetWriter)
             }
         }
 
+        /// <summary>
+        /// Send fake values to client's <see cref="SyncVarAttribute"/>.
+        /// </summary>
+        /// <typeparam name="T">Target SyncVar property type.</typeparam>
+        /// <param name="target">Target to send.</param>
+        /// <param name="behaviorOwner"><see cref="NetworkIdentity"/> of object that owns <see cref="NetworkBehaviour"/>.</param>
+        /// <param name="targetType"><see cref="NetworkBehaviour"/>'s type.</param>
+        /// <param name="propertyName">Property name starting with Network.</param>
+        /// <param name="value">Value of send to target.</param>
+        public static void SendFakeSyncVar<T>(this Player target, NetworkIdentity behaviorOwner, Type targetType, string propertyName, T value)
+        {
+            if (!target.IsConnected)
+                return;
+
+            NetworkWriterPooled writer = NetworkWriterPool.Get();
+            NetworkWriterPooled writer2 = NetworkWriterPool.Get();
+            MakeCustomSyncWriter(behaviorOwner, targetType, null, CustomSyncVarGenerator, writer, writer2);
+            target.Connection.Send(new EntityStateMessage
+            {
+                netId = behaviorOwner.netId,
+                payload = writer.ToArraySegment(),
+            });
+
+            NetworkWriterPool.Return(writer);
+            NetworkWriterPool.Return(writer2);
+            void CustomSyncVarGenerator(NetworkWriter targetWriter)
+            {
+                targetWriter.WriteULong(SyncVarDirtyBits[$"{targetType.Name}.{propertyName}"]);
+                WriterExtensions[typeof(T)]?.Invoke(null, new object[2] { targetWriter, value });
+            }
+        }
+
         /// <summary>
         /// Force resync to client's <see cref="SyncVarAttribute"/>.
         /// </summary>

EXILED/Exiled.API/Features/Items/Armor.cs

@@ -15,7 +15,6 @@ namespace Exiled.API.Features.Items
     using Exiled.API.Interfaces;
 
     using InventorySystem.Items.Armor;
-
     using PlayerRoles;
 
     using Structs;
@@ -110,6 +109,11 @@ public float StaminaUseMultiplier
             set => Base._staminaUseMultiplier = value;
         }
 
+        /// <summary>
+        /// Gets or sets the stamina regen multiplier.
+        /// </summary>
+        public float StaminaRegenMultiplier { get; set; } = 1f;
+
         /// <summary>
         /// Gets or sets how much the users movement speed should be affected when wearing this armor. (higher values = slower movement).
         /// </summary>
@@ -153,6 +157,7 @@ public IEnumerable<BodyArmor.ArmorCategoryLimitModifier> CategoryLimits
             StaminaUseMultiplier = StaminaUseMultiplier,
             RemoveExcessOnDrop = RemoveExcessOnDrop,
             CategoryLimits = CategoryLimits,
+            StaminaRegenMultiplier = StaminaRegenMultiplier,
             AmmoLimits = AmmoLimits,
             VestEfficacy = VestEfficacy,
             HelmetEfficacy = HelmetEfficacy,
@@ -168,6 +173,7 @@ internal override void ReadPickupInfo(Pickup pickup)
                 VestEfficacy = armorPickup.VestEfficacy;
                 RemoveExcessOnDrop = armorPickup.RemoveExcessOnDrop;
                 StaminaUseMultiplier = armorPickup.StaminaUseMultiplier;
+                StaminaRegenMultiplier = armorPickup.StaminaRegenMultiplier;
                 AmmoLimits = armorPickup.AmmoLimits;
                 CategoryLimits = armorPickup.CategoryLimits;
             }

EXILED/Exiled.API/Features/Map.cs

@@ -54,6 +54,8 @@ public static class Map
 
         private static AmbientSoundPlayer ambientSoundPlayer;
 
+        private static SqueakSpawner squeakSpawner;
+
         /// <summary>
         /// Gets the tantrum prefab.
         /// </summary>
@@ -104,11 +106,28 @@ public static int Seed
             }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether decontamination is enabled.
+        /// </summary>
+        public static bool IsDecontaminationEnabled
+        {
+            get => DecontaminationController.Singleton.NetworkDecontaminationOverride == DecontaminationController.DecontaminationStatus.None;
+            set =>
+                DecontaminationController.Singleton.NetworkDecontaminationOverride = value
+                    ? DecontaminationController.DecontaminationStatus.None
+                    : DecontaminationController.DecontaminationStatus.Disabled;
+        }
+
         /// <summary>
         /// Gets the <see cref="global::AmbientSoundPlayer"/>.
         /// </summary>
         public static AmbientSoundPlayer AmbientSoundPlayer => ambientSoundPlayer ??= ReferenceHub.HostHub.GetComponent<AmbientSoundPlayer>();
 
+        /// <summary>
+        /// Gets the <see cref="global::SqueakSpawner"/>.
+        /// </summary>
+        public static SqueakSpawner SqueakSpawner => squeakSpawner ??= Object.FindObjectOfType<SqueakSpawner>();
+
         /// <summary>
         /// Broadcasts a message to all <see cref="Player">players</see>.
         /// </summary>
@@ -152,7 +171,7 @@ public static void ShowHint(string message, float duration = 3f)
         public static void ClearBroadcasts() => Server.Broadcast.RpcClearElements();
 
         /// <summary>
-        /// Starts the light containment zone decontamination process.
+        /// Forces the light containment zone decontamination process.
         /// </summary>
         public static void StartDecontamination() => DecontaminationController.Singleton.ForceDecontamination();
 
@@ -362,6 +381,19 @@ public static void PlayGunSound(Vector3 position, ItemType firearmType, byte max
             msg.SendToAuthenticated();
         }
 
+        /// <summary>
+        /// Spawns mice inside the <see cref="RoomType.EzShelter"/>.
+        /// </summary>
+        /// <param name="mice">The type of mice you want to spawn..</param>
+        public static void SpawnMice(byte mice = 1)
+        {
+            if (mice > SqueakSpawner.mice.Length)
+                throw new ArgumentOutOfRangeException($"Mouse type must be between 1 and {SqueakSpawner.mice.Length}.");
+
+            SqueakSpawner.NetworksyncSpawn = mice;
+            SqueakSpawner.SyncMouseSpawn(0, SqueakSpawner.NetworksyncSpawn);
+        }
+
         /// <summary>
         /// Clears the lazy loading game object cache.
         /// </summary>

EXILED/Exiled.API/Features/Pickups/BodyArmorPickup.cs

@@ -98,6 +98,11 @@ public int VestEfficacy
         /// </summary>
         public float StaminaUseMultiplier { get; set; }
 
+        /// <summary>
+        /// Gets or sets the stamina regen multiplier.
+        /// </summary>
+        public float StaminaRegenMultiplier { get; set; }
+
         /// <summary>
         /// Gets how much the users movement speed should be affected when wearing this armor. (higher values = slower movement).
         /// </summary>
@@ -129,6 +134,7 @@ internal override void ReadItemInfo(Item item)
                 vestEfficacy = armoritem.VestEfficacy;
                 RemoveExcessOnDrop = armoritem.RemoveExcessOnDrop;
                 StaminaUseMultiplier = armoritem.StaminaUseMultiplier;
+                StaminaRegenMultiplier = armoritem.StaminaRegenMultiplier;
                 AmmoLimits = armoritem.AmmoLimits;
                 CategoryLimits = armoritem.CategoryLimits;
             }
@@ -144,6 +150,7 @@ protected override void InitializeProperties(ItemBase itemBase)
                 vestEfficacy = armoritem.VestEfficacy;
                 RemoveExcessOnDrop = !armoritem.DontRemoveExcessOnDrop;
                 StaminaUseMultiplier = armoritem._staminaUseMultiplier;
+                StaminaRegenMultiplier = armoritem.StaminaRegenMultiplier;
                 AmmoLimits = armoritem.AmmoLimits.Select(limit => (ArmorAmmoLimit)limit);
                 CategoryLimits = armoritem.CategoryLimits;
             }

EXILED/Exiled.API/Features/Pickups/Pickup.cs

@@ -133,6 +133,7 @@ internal Pickup(ItemType type)
         public PickupStandardPhysics PhysicsModule
         {
             get => Base.PhysicsModule as PickupStandardPhysics;
+            [Obsolete("Unsafe.")]
             set
             {
                 Base.PhysicsModule.DestroyModule();