added spawnreason and flags

Bonjemus · Bonjemus · commit b8387ee90533 · 2025-06-13T12:48:51.000+02:00
diff --git a/EXILED/Exiled.CustomRoles/API/Features/CustomRole.cs b/EXILED/Exiled.CustomRoles/API/Features/CustomRole.cs
@@ -37,13 +37,16 @@ namespace Exiled.CustomRoles.API.Features
     /// </summary>
     public abstract class CustomRole
     {
-        private const float AddRoleDelay = 0.25f;
+        /// <summary>
+        /// The delay after which ammo and items are added to the player.
+        /// </summary>
+        public const float AddRoleItemAndAmmoDelay = 0.25f;
 
-        private static Dictionary<Type, CustomRole?> typeLookupTable = new();
+        private static readonly Dictionary<Type, CustomRole?> TypeLookupTable = new();
 
-        private static Dictionary<string, CustomRole?> stringLookupTable = new();
+        private static readonly Dictionary<string, CustomRole?> StringLookupTable = new();
 
-        private static Dictionary<uint, CustomRole?> idLookupTable = new();
+        private static readonly Dictionary<uint, CustomRole?> IdLookupTable = new();
 
         /// <summary>
         /// Gets a list of all registered custom roles.
@@ -144,7 +147,7 @@ public abstract class CustomRole
         /// <summary>
         /// Gets or sets a value indicating broadcast that will be shown to the player.
         /// </summary>
-        public virtual Broadcast Broadcast { get; set; } = new Broadcast();
+        public virtual Broadcast? Broadcast { get; set; } = new Broadcast();
 
         /// <summary>
         /// Gets or sets a value indicating whether players will receive a message for getting a custom item, when gaining it through the inventory config for this role.
@@ -183,9 +186,9 @@ public abstract class CustomRole
         /// <returns>The role, or <see langword="null"/> if it doesn't exist.</returns>
         public static CustomRole? Get(uint id)
         {
-            if (!idLookupTable.ContainsKey(id))
-                idLookupTable.Add(id, Registered?.FirstOrDefault(r => r.Id == id));
-            return idLookupTable[id];
+            if (!IdLookupTable.ContainsKey(id))
+                IdLookupTable.Add(id, Registered?.FirstOrDefault(r => r.Id == id));
+            return IdLookupTable[id];
         }
 
         /// <summary>
@@ -195,9 +198,9 @@ public abstract class CustomRole
         /// <returns>The role, or <see langword="null"/> if it doesn't exist.</returns>
         public static CustomRole? Get(Type t)
         {
-            if (!typeLookupTable.ContainsKey(t))
-                typeLookupTable.Add(t, Registered?.FirstOrDefault(r => r.GetType() == t));
-            return typeLookupTable[t];
+            if (!TypeLookupTable.ContainsKey(t))
+                TypeLookupTable.Add(t, Registered?.FirstOrDefault(r => r.GetType() == t));
+            return TypeLookupTable[t];
         }
 
         /// <summary>
@@ -207,9 +210,9 @@ public abstract class CustomRole
         /// <returns>The role, or <see langword="null"/> if it doesn't exist.</returns>
         public static CustomRole? Get(string name)
         {
-            if (!stringLookupTable.ContainsKey(name))
-                stringLookupTable.Add(name, Registered?.FirstOrDefault(r => r.Name == name));
-            return stringLookupTable[name];
+            if (!StringLookupTable.ContainsKey(name))
+                StringLookupTable.Add(name, Registered?.FirstOrDefault(r => r.Name == name));
+            return StringLookupTable[name];
         }
 
         /// <summary>
@@ -481,9 +484,9 @@ public static void ForceSyncSetPlayerFriendlyFire(CustomRole roleToSync, Player
         /// </summary>
         public virtual void Init()
         {
-            idLookupTable.Add(Id, this);
-            typeLookupTable.Add(GetType(), this);
-            stringLookupTable.Add(Name, this);
+            IdLookupTable.Add(Id, this);
+            TypeLookupTable.Add(GetType(), this);
+            StringLookupTable.Add(Name, this);
             SubscribeEvents();
         }
 
@@ -492,68 +495,75 @@ public virtual void Init()
         /// </summary>
         public virtual void Destroy()
         {
-            idLookupTable.Remove(Id);
-            typeLookupTable.Remove(GetType());
-            stringLookupTable.Remove(Name);
+            IdLookupTable.Remove(Id);
+            TypeLookupTable.Remove(GetType());
+            StringLookupTable.Remove(Name);
             UnsubscribeEvents();
         }
 
         /// <summary>
         /// Handles setup of the role, including spawn location, inventory and registering event handlers and add FF rules.
         /// </summary>
         /// <param name="player">The <see cref="Player"/> to add the role to.</param>
-        public virtual void AddRole(Player player)
+        public virtual void AddRole(Player player) => AddRole(player, SpawnReason.ForceClass, false, RoleSpawnFlags.All);
+
+        /// <summary>
+        /// Handles setup of the role, including spawn location, inventory and registering event handlers and add FF rules.
+        /// </summary>
+        /// <param name="player">The <see cref="Player"/> to add the role to.</param>
+        /// <param name="spawnReason">The <see cref="SpawnReason"/>.</param>
+        /// <param name="overrideFlags">Whether it should use <paramref name="overrideSpawnFlags"/> or not.</param>
+        /// <param name="overrideSpawnFlags">The <see cref="RoleSpawnFlags"/> to apply if <paramref name="overrideFlags"/> is <see langword="true"/>.</param>
+        public virtual void AddRole(Player player, SpawnReason spawnReason = SpawnReason.ForceClass, bool overrideFlags = false, RoleSpawnFlags overrideSpawnFlags = RoleSpawnFlags.All)
         {
             Log.Debug($"{Name}: Adding role to {player.Nickname}.");
             player.UniqueRole = Name;
 
-            if (Role != RoleTypeId.None)
+            RoleSpawnFlags keptSpawnFlags = overrideSpawnFlags;
+
+            if (Role == RoleTypeId.None)
             {
-                if (KeepPositionOnSpawn)
-                {
-                    if (KeepInventoryOnSpawn)
-                        player.Role.Set(Role, SpawnReason.ForceClass, RoleSpawnFlags.None);
-                    else
-                        player.Role.Set(Role, SpawnReason.ForceClass, RoleSpawnFlags.AssignInventory);
-                }
-                else
+                keptSpawnFlags = RoleSpawnFlags.None;
+            }
+            else
+            {
+                if (!overrideFlags)
                 {
-                    if (KeepInventoryOnSpawn && player.IsAlive)
-                        player.Role.Set(Role, SpawnReason.ForceClass, RoleSpawnFlags.UseSpawnpoint);
+                    if (KeepPositionOnSpawn)
+                        keptSpawnFlags = KeepInventoryOnSpawn ? RoleSpawnFlags.None : RoleSpawnFlags.AssignInventory;
                     else
-                        player.Role.Set(Role, SpawnReason.ForceClass, RoleSpawnFlags.All);
+                        keptSpawnFlags = KeepInventoryOnSpawn && player.IsAlive ? RoleSpawnFlags.UseSpawnpoint : RoleSpawnFlags.All;
                 }
+
+                player.Role.Set(Role, spawnReason, keptSpawnFlags);
             }
 
             player.UniqueRole = Name;
             TrackedPlayers.Add(player);
 
-            Timing.CallDelayed(
-                AddRoleDelay,
-                () =>
-                {
-                    if (!KeepInventoryOnSpawn)
+            if (keptSpawnFlags.HasFlag(RoleSpawnFlags.AssignInventory))
+            {
+                Timing.CallDelayed(
+                    AddRoleItemAndAmmoDelay,
+                    () =>
                     {
                         Log.Debug($"{Name}: Clearing {player.Nickname}'s inventory.");
                         player.ClearInventory();
-                    }
 
-                    foreach (string itemName in Inventory)
-                    {
-                        Log.Debug($"{Name}: Adding {itemName} to inventory.");
-                        TryAddItem(player, itemName);
-                    }
+                        foreach (string itemName in Inventory)
+                        {
+                            Log.Debug($"{Name}: Adding {itemName} to inventory.");
+                            TryAddItem(player, itemName);
+                        }
 
-                    if (Ammo.Count > 0)
-                    {
                         Log.Debug($"{Name}: Adding Ammo to {player.Nickname} inventory.");
                         foreach (AmmoType type in EnumUtils<AmmoType>.Values)
                         {
                             if (type != AmmoType.None)
                                 player.SetAmmo(type, Ammo.ContainsKey(type) ? Ammo[type] == ushort.MaxValue ? InventoryLimits.GetAmmoLimit(type.GetItemType(), player.ReferenceHub) : Ammo[type] : (ushort)0);
                         }
-                    }
-                });
+                    });
+            }
 
             Log.Debug($"{Name}: Setting health values.");
             player.Health = MaxHealth;
@@ -563,9 +573,7 @@ public virtual void AddRole(Player player)
                 fpcRole.Gravity = Gravity.Value;
             Vector3 position = GetSpawnPosition();
             if (position != Vector3.zero)
-            {
                 player.Position = position;
-            }
 
             Log.Debug($"{Name}: Setting player info");
 
@@ -580,7 +588,7 @@ public virtual void AddRole(Player player)
 
             ShowMessage(player);
             ShowBroadcast(player);
-            RoleAdded(player);
+            RoleAdded(player, spawnReason, keptSpawnFlags);
             player.TryAddCustomRoleFriendlyFire(Name, CustomRoleFFMultiplier);
 
             if (!string.IsNullOrEmpty(ConsoleMessage))
@@ -611,56 +619,49 @@ public virtual void AddRole(Player player)
         /// Removes the role from a specific player and FF rules.
         /// </summary>
         /// <param name="player">The <see cref="Player"/> to remove the role from.</param>
-        public virtual void RemoveRole(Player player)
+        public virtual void RemoveRole(Player player) => RemoveRole(player, SpawnReason.ForceClass, RoleSpawnFlags.All);
+
+        /// <summary>
+        /// Removes the role from a specific player and FF rules.
+        /// </summary>
+        /// <param name="player">The <see cref="Player"/> to remove the role from.</param>
+        /// <param name="spawnReason">The <see cref="SpawnReason"/>.</param>
+        /// <param name="roleSpawnFlags">The <see cref="RoleSpawnFlags"/> to apply.</param>
+        public virtual void RemoveRole(Player player, SpawnReason spawnReason = SpawnReason.ForceClass, RoleSpawnFlags roleSpawnFlags = RoleSpawnFlags.All)
         {
-            if (!TrackedPlayers.Contains(player))
+            if (!TrackedPlayers.Remove(player))
                 return;
+
             Log.Debug($"{Name}: Removing role from {player.Nickname}");
-            TrackedPlayers.Remove(player);
             player.CustomInfo = string.Empty;
             player.InfoArea |= PlayerInfoArea.Role | PlayerInfoArea.Nickname;
             player.Scale = Vector3.one;
             if (CustomAbilities is not null)
             {
                 foreach (CustomAbility ability in CustomAbilities)
-                {
                     ability.RemoveAbility(player);
-                }
             }
 
-            RoleRemoved(player);
+            RoleRemoved(player, spawnReason, roleSpawnFlags);
             player.UniqueRole = string.Empty;
             player.TryRemoveCustomeRoleFriendlyFire(Name);
 
             if (RemovalKillsPlayer)
-                player.Role.Set(RoleTypeId.Spectator);
+                player.Role.Set(RoleTypeId.Spectator, spawnReason, roleSpawnFlags);
         }
 
         /// <summary>
         /// Tries to add <see cref="RoleTypeId"/> to CustomRole FriendlyFire rules.
         /// </summary>
         /// <param name="roleToAdd"> Role to add. </param>
         /// <param name="ffMult"> Friendly fire multiplier. </param>
-        public void SetFriendlyFire(RoleTypeId roleToAdd, float ffMult)
-        {
-            if (CustomRoleFFMultiplier.ContainsKey(roleToAdd))
-            {
-                CustomRoleFFMultiplier[roleToAdd] = ffMult;
-            }
-            else
-            {
-                CustomRoleFFMultiplier.Add(roleToAdd, ffMult);
-            }
-        }
+        public void SetFriendlyFire(RoleTypeId roleToAdd, float ffMult) => CustomRoleFFMultiplier[roleToAdd] = ffMult;
 
         /// <summary>
         /// Wrapper to call <see cref="SetFriendlyFire(RoleTypeId, float)"/>.
         /// </summary>
         /// <param name="roleFF"> Role with FF to add even if it exists. </param>
-        public void SetFriendlyFire(KeyValuePair<RoleTypeId, float> roleFF)
-        {
-            SetFriendlyFire(roleFF.Key, roleFF.Value);
-        }
+        public void SetFriendlyFire(KeyValuePair<RoleTypeId, float> roleFF) => SetFriendlyFire(roleFF.Key, roleFF.Value);
 
         /// <summary>
         /// Tries to add <see cref="RoleTypeId"/> to CustomRole FriendlyFire rules.
@@ -671,9 +672,7 @@ public void SetFriendlyFire(KeyValuePair<RoleTypeId, float> roleFF)
         public bool TryAddFriendlyFire(RoleTypeId roleToAdd, float ffMult)
         {
             if (CustomRoleFFMultiplier.ContainsKey(roleToAdd))
-            {
                 return false;
-            }
 
             CustomRoleFFMultiplier.Add(roleToAdd, ffMult);
             return true;
@@ -719,9 +718,7 @@ public bool TryAddFriendlyFire(Dictionary<RoleTypeId, float> ffRules, bool overw
             if (!overwrite)
             {
                 foreach (KeyValuePair<RoleTypeId, float> roleFF in temporaryFriendlyFireRules)
-                {
                     TryAddFriendlyFire(roleFF);
-                }
             }
 
             DictionaryPool<RoleTypeId, float>.Pool.Return(temporaryFriendlyFireRules);
@@ -898,12 +895,30 @@ protected virtual void UnsubscribeEvents()
         /// Shows the spawn broadcast to the player.
         /// </summary>
         /// <param name="player">The <see cref="Player"/> to show the message to.</param>
-        protected virtual void ShowBroadcast(Player player) => player.Broadcast(Broadcast);
+        protected virtual void ShowBroadcast(Player player)
+        {
+            if (Broadcast != null && Broadcast.Duration > 0 && !string.IsNullOrEmpty(Broadcast.Content))
+                player.Broadcast(Broadcast);
+        }
+
+        /// <summary>
+        /// Called after the role has been added to the player.
+        /// </summary>
+        /// <param name="player">The <see cref="Player"/> the role was added to.</param>
+        /// <param name="spawnReason">The <see cref="SpawnReason"/>.</param>
+        /// <param name="roleSpawnFlags">The <see cref="RoleSpawnFlags"/> to apply.</param>
+        protected virtual void RoleAdded(Player player, SpawnReason spawnReason, RoleSpawnFlags roleSpawnFlags)
+        {
+#pragma warning disable CS0618
+            RoleAdded(player);
+#pragma warning restore CS0618
+        }
 
         /// <summary>
         /// Called after the role has been added to the player.
         /// </summary>
         /// <param name="player">The <see cref="Player"/> the role was added to.</param>
+        [Obsolete("Use RoleAdded(Player, SpawnReason, RoleSpawnFlags) instead.")]
         protected virtual void RoleAdded(Player player)
         {
         }
@@ -912,6 +927,20 @@ protected virtual void RoleAdded(Player player)
         /// Called 1 frame before the role is removed from the player.
         /// </summary>
         /// <param name="player">The <see cref="Player"/> the role was removed from.</param>
+        /// <param name="spawnReason">The <see cref="SpawnReason"/>.</param>
+        /// <param name="roleSpawnFlags">The <see cref="RoleSpawnFlags"/> to apply.</param>
+        protected virtual void RoleRemoved(Player player, SpawnReason spawnReason, RoleSpawnFlags roleSpawnFlags)
+        {
+#pragma warning disable CS0618
+            RoleRemoved(player);
+#pragma warning restore CS0618
+        }
+
+        /// <summary>
+        /// Called 1 frame before the role is removed from the player.
+        /// </summary>
+        /// <param name="player">The <see cref="Player"/> the role was removed from.</param>
+        [Obsolete("Use RoleRemoved(Player, SpawnReason, RoleSpawnFlags) instead.")]
         protected virtual void RoleRemoved(Player player)
         {
         }
@@ -925,13 +954,13 @@ private void OnInternalChangingNickname(ChangingNicknameEventArgs ev)
         private void OnInternalSpawned(SpawnedEventArgs ev)
         {
             if (!IgnoreSpawnSystem && SpawnChance > 0 && !Check(ev.Player) && ev.Player.Role.Type == Role && Loader.Random.NextDouble() * 100 <= SpawnChance)
-                AddRole(ev.Player);
+                AddRole(ev.Player, ev.Reason, false);
         }
 
         private void OnInternalChangingRole(ChangingRoleEventArgs ev)
         {
             if (ev.IsAllowed && ev.Reason != SpawnReason.Destroyed && Check(ev.Player) && ((ev.NewRole == RoleTypeId.Spectator && !KeepRoleOnDeath) || (ev.NewRole != RoleTypeId.Spectator && !KeepRoleOnChangingRole)))
-                RemoveRole(ev.Player);
+                RemoveRole(ev.Player, ev.Reason, ev.SpawnFlags);
         }
 
         private void OnSpawningRagdoll(SpawningRagdollEventArgs ev)
@@ -942,4 +971,4 @@ private void OnSpawningRagdoll(SpawningRagdollEventArgs ev)
 
         private void OnDestroying(DestroyingEventArgs ev) => RemoveRole(ev.Player);
     }
-}
+}
