severely improved debug logs and minor tweaks

Author: Mikihero

Common Utilities/Config.cs

@@ -138,6 +138,7 @@ public class Config : IConfig
         };
 
         [Description("The list of custom 914 recipies. Original is the item being upgraded, New is the item to upgrade to, and Chance is the percent chance of the upgrade happening. You can specify multiple upgrade choices for the same item. For custom items use the item's name.")]
+        // This should be named Scp914ItemChanGes instead of ChanCes (capitalized to show the difference), consider changing at some point (breaking change)
         public Dictionary<Scp914KnobSetting, List<ItemUpgradeChance>> Scp914ItemChances { get; set; } = new()
         {
             {

Common Utilities/EventHandlers/MapHandlers.cs

@@ -22,19 +22,23 @@ public class MapHandlers
 
     public void OnUpgradingPickup(UpgradingPickupEventArgs ev)
     {
-        if (config.Scp914ItemChances.TryGetValue(ev.KnobSetting, out List<ItemUpgradeChance> outItemUpgradeChances))
+        if (config.Scp914ItemChances != null && config.Scp914ItemChances.TryGetValue(ev.KnobSetting, out List<ItemUpgradeChance> outItemUpgradeChances))
         {
+            Log.Debug($"{nameof(OnUpgradingPickup)}: Found valid config entries, filtering...");
+
             List<ItemUpgradeChance> itemUpgradeChances = outItemUpgradeChances
                 .Where(x => 
                     x.Original == ev.Pickup.Type.ToString() 
-                    || (CustomItem.TryGet(ev.Pickup, out CustomItem item) && item!.Name == x.Original))
+                    || (CustomItem.TryGet(ev.Pickup, out CustomItem item) && item.Name == x.Original))
                 .ToList();
 
+            Log.Debug($"{nameof(OnUpgradingPickup)}: Fnished filtering, found {itemUpgradeChances.Count} match(es).");
+            
             double rolledChance = Utils.RollChance(itemUpgradeChances);
 
             foreach ((string sourceItem, string destinationItem, double chance, int count) in itemUpgradeChances)
             {
-                Log.Debug($"{nameof(OnUpgradingPickup)}: SCP-914 is trying to upgrade a {ev.Pickup.Type}. {sourceItem} -> {destinationItem} ({chance}). Should process: {rolledChance <= chance} ({rolledChance})");
+                Log.Debug($"{nameof(OnUpgradingPickup)}: SCP-914 is trying to upgrade a {ev.Pickup.Type}. {sourceItem} -> {destinationItem} (x{count}); {rolledChance} <= {chance} ({rolledChance <= chance})");
 
                 if (rolledChance <= chance)
                 {
@@ -66,19 +70,23 @@ public void OnUpgradingPickup(UpgradingPickupEventArgs ev)
 
     public void OnUpgradingInventoryItem(UpgradingInventoryItemEventArgs ev)
     {
-        if (config.Scp914ItemChances.TryGetValue(ev.KnobSetting, out List<ItemUpgradeChance> outItemUpgradeChances))
+        if (config.Scp914ItemChances != null && config.Scp914ItemChances.TryGetValue(ev.KnobSetting, out List<ItemUpgradeChance> outItemUpgradeChances))
         {
+            Log.Debug($"{nameof(OnUpgradingInventoryItem)}: Found valid config entries, filtering...");
+
             List<ItemUpgradeChance> itemUpgradeChances = outItemUpgradeChances
                 .Where(x => 
                     x.Original == ev.Item.Type.ToString() 
-                    || (CustomItem.TryGet(ev.Item, out CustomItem item) && item!.Name == x.Original))
+                    || (CustomItem.TryGet(ev.Item, out CustomItem item) && item.Name == x.Original))
                 .ToList();
 
+            Log.Debug($"{nameof(OnUpgradingInventoryItem)}: Finished filtering, found {itemUpgradeChances.Count} match(es).");
+
             double rolledChance = Utils.RollChance(itemUpgradeChances);
 
             foreach ((string sourceItem, string destinationItem, double chance, int count) in itemUpgradeChances)
             {
-                Log.Debug($"{nameof(OnUpgradingInventoryItem)}: {ev.Player.Nickname} is attempting to upgrade hit {ev.Item.Type}. {sourceItem} -> {destinationItem} ({chance}). Should process: {rolledChance <= chance} ({rolledChance})");
+                Log.Debug($"{nameof(OnUpgradingInventoryItem)}: {ev.Player.Nickname} is attempting to upgrade an inventory item(s) {ev.Item.Type}. {sourceItem} -> {destinationItem} (x{count}); {rolledChance} <= {chance} ({rolledChance <= chance})");
 
                 if (rolledChance <= chance)
                 {
@@ -110,20 +118,20 @@ public void OnUpgradingPlayer(UpgradingPlayerEventArgs ev)
     {
         if (config.Scp914ClassChanges != null && config.Scp914ClassChanges.TryGetValue(ev.KnobSetting, out var outPlayerUpgradeChances))
         {
-            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)} found valid config entries, filtering....");
+            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)}: Found valid config entries, filtering...");
             List<PlayerUpgradeChance> playerUpgradeChances = outPlayerUpgradeChances
                 .Where(x => 
                     x.Original == ev.Player.Role.Type.ToString()
                     || (CustomRole.TryGet(ev.Player, out IReadOnlyCollection<CustomRole> customRoles) && customRoles.Select(r => r.Name).Contains(x.Original)))
                 .ToList();
 
-            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)} filtered entries. Found {playerUpgradeChances.Count} matches.");
+            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)}: Finished filtering, found {playerUpgradeChances.Count} match(es).");
 
             double rolledChance = Utils.RollChance(playerUpgradeChances);
 
             foreach ((string sourceRole, string destinationRole, double chance, bool keepInventory, bool keepHealth) in playerUpgradeChances)
             {
-                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)} {ev.Player.Nickname} ({ev.Player.Role}) is trying to upgrade his class. sourceRole: {sourceRole}; destinationRole: {destinationRole}; chance: {chance}; rolledChance: {rolledChance}; keepInventory: {keepHealth}; keepHealth: {keepHealth};");
+                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914ClassChanges)}: {ev.Player.Nickname} ({ev.Player.Role.Type}) is trying to upgrade his class. {sourceRole} -> {destinationRole}; keepInventory: {keepHealth}; keepHealth: {keepHealth}; {rolledChance} <= {chance} ({rolledChance <= chance})");
                 if (rolledChance <= chance)
                 {
                     float originalHealth = ev.Player.Health;
@@ -177,15 +185,15 @@ public void OnUpgradingPlayer(UpgradingPlayerEventArgs ev)
 
         if (config.Scp914EffectChances != null && config.Scp914EffectChances.ContainsKey(ev.KnobSetting) && (ev.Player.Role.Side != Side.Scp || !config.ScpsImmuneTo914Effects))
         {
-            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914EffectChances)} found valid config entries.");
+            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914EffectChances)}: Found valid config entries.");
 
             IEnumerable<Scp914EffectChance> scp914EffectChances = config.Scp914EffectChances[ev.KnobSetting];
 
             double rolledChance = Utils.RollChance(scp914EffectChances);
 
             foreach ((EffectType effect, double chance, float duration) in scp914EffectChances)
             {
-                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914EffectChances)} {ev.Player.Nickname} is trying to gain an effect through SCP-914. effect: {effect}; chance: {chance}; rolledChance: {rolledChance};");
+                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914EffectChances)}: {ev.Player.Nickname} is trying to gain an effect through SCP-914 {effect} ({duration}s); {rolledChance} <= {chance} ({rolledChance <= chance})");
 
                 if (rolledChance <= chance)
                 {
@@ -201,15 +209,15 @@ public void OnUpgradingPlayer(UpgradingPlayerEventArgs ev)
 
         if (config.Scp914TeleportChances != null && config.Scp914TeleportChances.ContainsKey(ev.KnobSetting))
         {
-            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914TeleportChances)} found valid config entries.");
+            Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914TeleportChances)}: Found valid config entries.");
 
             IEnumerable<Scp914TeleportChance> scp914TeleportChances = config.Scp914TeleportChances[ev.KnobSetting];
 
             double rolledChance = Utils.RollChance(scp914TeleportChances);
 
             foreach ((RoomType roomType, List<RoomType> ignoredRooms, Vector3 offset, double chance, float damage, ZoneType zone) in config.Scp914TeleportChances[ev.KnobSetting])
             {
-                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914TeleportChances)} {ev.Player.Nickname} is trying to be teleported by 914. zone: {zone}; room: {roomType}; offset: {offset}; chance: {chance}; rolledChance: {rolledChance};");
+                Log.Debug($"{nameof(OnUpgradingPlayer)} : {nameof(config.Scp914TeleportChances)}: {ev.Player.Nickname} is trying to be teleported by 914. {roomType} + {offset}; {zone} + {ignoredRooms.Count} ignored rooms; damage: {damage}; {rolledChance} <= {chance} ({rolledChance <= chance})");
 
                 if (rolledChance <= chance)
                 {

Common Utilities/EventHandlers/PlayerHandlers.cs

@@ -1,3 +1,5 @@
+using System.Collections.Specialized;
+
 namespace Common_Utilities.EventHandlers;
 
 #pragma warning disable IDE0018
@@ -36,6 +38,7 @@ public void OnChangingRole(ChangingRoleEventArgs ev)
         }
 
         // no clue why this works while in ChangingRole instead of spawned but if it ain't broke don't fix it
+        // answering my previous question, (obviously) it works because we're setting ev.Items which are yet to be given to the player
         if (config.StartingInventories.ContainsKey(ev.NewRole) && !ev.ShouldPreserveInventory)
         {
             if (ev.Items == null)
@@ -147,10 +150,13 @@ public List<ItemType> GetStartingInventory(RoleTypeId role, Player player = null
     {
         List<ItemType> items = new();
 
+        Log.Debug($"{nameof(GetStartingInventory)} Iterating through slots...");
         // iterate through slots
         for (int i = 0; i < config.StartingInventories[role].UsedSlots; i++)
         {
-#pragma warning disable SA1119
+            Log.Debug($"\n{nameof(GetStartingInventory)} Iterating slot {i + 1}");
+            Log.Debug($"{nameof(GetStartingInventory)} Checking groups...");
+            
             // item chances for that slot
             List<ItemChance> itemChances = config.StartingInventories[role][i]
                 .Where(x => 
@@ -159,15 +165,14 @@ public List<ItemType> GetStartingInventory(RoleTypeId role, Player player = null
                     || x.Group == "none" 
                     || (ServerStatic.PermissionsHandler._groups.TryGetValue(x.Group, out var group) && group == player.Group))
                 .ToList();
-#pragma warning restore SA1119
 
-            double rolledChance = Utils.RollChance(itemChances);
+            Log.Debug($"{nameof(GetStartingInventory)} Finished checking groups, found {itemChances.Count} valid itemChances.");
 
-            Log.Debug($"[StartItems] RolledChance ({rolledChance})/{itemChances.Sum(val => val.Chance)}");
+            double rolledChance = Utils.RollChance(itemChances);
 
             foreach ((string item, double chance) in itemChances)
             {
-                Log.Debug($"[StartItems] Probability ({rolledChance})/{chance}");
+                Log.Debug($"{nameof(GetStartingInventory)} Trying to assign to slot {i + 1} for {role}; item: {item}; {rolledChance} <= {chance} ({rolledChance <= chance}).");
 
                 if (rolledChance <= chance)
                 {
@@ -182,18 +187,20 @@ public List<ItemType> GetStartingInventory(RoleTypeId role, Player player = null
                         if (player != null)
                             customItem!.Give(player);
                         else
-                            Log.Warn($"{nameof(GetStartingInventory)}: Tried to give {customItem!.Name} to a null player.");
+                            Log.Warn($"{nameof(GetStartingInventory)} Tried to give {customItem!.Name} to a null player.");
 
                         break;
                     }
 
-                    Log.Warn($"{nameof(GetStartingInventory)}: {item} is not a valid ItemType or CustomItem! It is being skipped in inventory decisions.");
+                    Log.Warn($"{nameof(GetStartingInventory)} Skipping {item} as it is not a valid ItemType or CustomItem!");
                 }
 
                 if (config.AdditiveProbabilities) 
                     rolledChance -= chance;
             }
         }
+        
+        Log.Debug($"{nameof(GetStartingInventory)} Finished iterating slots.");
 
         return items;
     }

Common Utilities/Utils.cs

@@ -6,15 +6,15 @@
 
 public static class Utils
 {
-    public static double RollChance(IEnumerable<IChanceObject> scp914EffectChances)
+    public static int RollChance(IEnumerable<IChanceObject> scp914EffectChances)
     {
-        double rolledChance;
+        double rolledChance = Plugin.Random.NextDouble();
 
         if (Plugin.Instance.Config.AdditiveProbabilities)
-            rolledChance = Plugin.Random.NextDouble() * scp914EffectChances.Sum(x => x.Chance);
+            rolledChance *= scp914EffectChances.Sum(x => x.Chance);
         else
-            rolledChance = Plugin.Random.NextDouble() * 100;
+            rolledChance *= 100;
 
-        return rolledChance;
+        return (int)rolledChance;
     }
 }