Bring melee stat displays closer to reality

Our current melee stat displays leave much to be desired:

* The "Melee DPS" stat shown prominently for pawns is an unpatched
  vanilla stat, which doesn't take CE's damage scaling into account.
* The stuff a weapon is made of isn't factored into stats, which
  impacts not just damage and cooldown but also the chance to pick
  a given tool relative to other tools.
* The armor penetration stat shown for humans doesn't consider the
  wielded weapon.

So:
* Patch the MeleeDPS stat to use our StatWorker.
* In StatWorker_MeleeDamageAverage and StatWorker_MeleeArmorPenetration,
  use the pawn's list of melee verbs when computing the stat for a pawn,
  since the available verbs impact their weighting relative to each
  other. For instance, a pawn wielding a club may still choose to fight
  with fists some % of the time, but won't do so if wielding a
  masterwork longsword.
* Always obtain melee verbs from `VerbUtility.GetAllVerbProperties`
  when computing stats for a single weapon (which may be wielded by a pawn),
  so that damage, cooldown and tool use chance can be computed via
  `VerbProperties` helpers that take stuffing into account.
* Show the chance to use a given tool in the armor penetration stat
  explainer for clarity.

Author: mszabo-wikia

Patches/Core/Stats/Stats.xml

@@ -485,13 +485,28 @@
 		</value>
 	</Operation>
 
-	<Operation Class="PatchOperationReplace">
+  <Operation Class="PatchOperationReplace">
+    <xpath>Defs/StatDef[defName="MeleeWeapon_AverageDPS"]/category</xpath>
+    <value>
+      <category>Weapon</category>
+    </value>
+  </Operation>
+
+
+  <Operation Class="PatchOperationReplace">
 		<xpath>Defs/StatDef[defName="MeleeWeapon_AverageDPS"]/displayPriorityInCategory</xpath>
 		<value>
-			<displayPriorityInCategory>6</displayPriorityInCategory>
+      <displayPriorityInCategory>7</displayPriorityInCategory>
 		</value>
 	</Operation>
 
+  <Operation Class="PatchOperationReplace">
+    <xpath>Defs/StatDef[defName="MeleeDPS"]/workerClass</xpath>
+    <value>
+      <workerClass>CombatExtended.StatWorker_MeleeDamageAverage</workerClass>
+    </value>
+  </Operation>
+
 	<!-- Melee AP -->
 
 	<Operation Class="PatchOperationReplace">
@@ -508,4 +523,19 @@
 		</value>
 	</Operation>
 
+  <Operation Class="PatchOperationReplace">
+    <xpath>Defs/StatDef[defName="MeleeWeapon_AverageArmorPenetration"]/category</xpath>
+    <value>
+      <category>Weapon</category>
+    </value>
+  </Operation>
+
+
+  <Operation Class="PatchOperationReplace">
+    <xpath>Defs/StatDef[defName="MeleeWeapon_AverageArmorPenetration"]/displayPriorityInCategory</xpath>
+    <value>
+      <displayPriorityInCategory>8</displayPriorityInCategory>
+    </value>
+  </Operation>
+
 </Patch>

Source/CombatExtended/CombatExtended/StatWorkers/StatWorker_MeleeArmorPenetration.cs

@@ -17,114 +17,183 @@ public override string GetStatDrawEntryLabel(StatDef stat, float value, ToString
 
     public override string GetExplanationUnfinalized(StatRequest req, ToStringNumberSense numberSense)
     {
-        var tools = (req.Def as ThingDef)?.tools;
-
-        if (tools.NullOrEmpty())
+        if (req.Def is not ThingDef thingDef)
         {
             return base.GetExplanationUnfinalized(req, numberSense);
         }
+
+        var pawn = GetCurrentWielder(req);
+
+        var skillFactor = GetSkillFactor(pawn);
+        var otherFactors = GetOtherFactors(pawn);
+
         var stringBuilder = new StringBuilder();
-        var penetrationFactor = GetPenetrationFactor(req);
-        var skillFactor = GetSkillFactor(req);
-        stringBuilder.AppendLine("CE_WeaponPenetrationFactor".Translate() + ": " + penetrationFactor.ToStringByStyle(ToStringStyle.PercentZero));
+
         if (Mathf.Abs(skillFactor - 1f) > 0.001f)
         {
             stringBuilder.AppendLine("CE_WeaponPenetrationSkillFactor".Translate() + ": " + skillFactor.ToStringByStyle(ToStringStyle.PercentZero));
         }
 
         stringBuilder.AppendLine();
 
-        foreach (ToolCE tool in tools)
+        if (req.Thing is Pawn)
         {
-            var maneuvers = DefDatabase<ManeuverDef>.AllDefsListForReading.Where(d => tool.capacities.Contains(d.requiredCapacity));
-            var maneuverString = "(";
-            foreach (var maneuver in maneuvers)
-            {
-                maneuverString += maneuver.ToString() + "/";
-            }
-            maneuverString = maneuverString.TrimmedToLength(maneuverString.Length - 1) + ")";
-            stringBuilder.AppendLine("  " + "Tool".Translate() + ": " + tool.ToString() + " " + maneuverString);
-            var otherFactors = GetOtherFactors(req).Aggregate(1f, (x, y) => x * y);
-            if (Mathf.Abs(otherFactors - 1f) > 0.001f)
+            var meleeVerbs = pawn.meleeVerbs.GetUpdatedAvailableVerbsList(terrainTools: false);
+            var cumulativeWeights = meleeVerbs.Sum(verbEntry => verbEntry.GetSelectionWeight(null));
+            foreach (var verbEntry in meleeVerbs)
             {
-                stringBuilder.AppendLine("   " + "CE_WeaponPenetrationOtherFactors".Translate() + ": " + otherFactors.ToStringByStyle(ToStringStyle.PercentZero));
-            }
+                var penetrationFactor =
+                    verbEntry.verb.EquipmentSource?.GetStatValue(CE_StatDefOf.MeleePenetrationFactor) ?? 1f;
+                var chance = verbEntry.GetSelectionWeight(null) / cumulativeWeights;
 
-            stringBuilder.Append(string.Format("    {0}: {1} x {2}",
-                                                   "CE_DescSharpPenetration".Translate(),
-                                                   tool.armorPenetrationSharp.ToStringByStyle(ToStringStyle.FloatMaxTwo),
-                                                   penetrationFactor.ToStringByStyle(ToStringStyle.FloatMaxThree)));
-            if (Mathf.Abs(skillFactor - 1f) > 0.001f)
-            {
-                stringBuilder.Append(string.Format(" x {0}", skillFactor.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+                if (chance > 0)
+                {
+                    ShowExplanationForVerb(
+                        stringBuilder,
+                        verbEntry.verb.tool,
+                        verbEntry.verb.maneuver,
+                        skillFactor,
+                        otherFactors,
+                        penetrationFactor,
+                        chance
+                    );
+                }
             }
-            if (Mathf.Abs(otherFactors - 1f) > 0.001f)
+        }
+        else
+        {
+            var penetrationFactor = GetPenetrationFactor(req);
+            var meleeVerbPropsWithSource = AllMeleeVerbPropsWithSource(thingDef);
+            var cumulativeWeights = meleeVerbPropsWithSource.Sum(vps => AdjustedMeleeSelectionWeight(vps, pawn, req));
+            foreach (var vps in meleeVerbPropsWithSource)
             {
-                stringBuilder.Append(string.Format(" x {0}", otherFactors.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+                var chance = AdjustedMeleeSelectionWeight(vps, pawn, req) / cumulativeWeights;
+                ShowExplanationForVerb(
+                    stringBuilder,
+                    vps.tool,
+                    vps.maneuver,
+                    skillFactor,
+                    otherFactors,
+                    penetrationFactor,
+                    chance
+                );
             }
-            stringBuilder.AppendLine(string.Format(" = {0} {1}",
-                                                    (tool.armorPenetrationSharp * penetrationFactor * skillFactor * otherFactors).ToStringByStyle(ToStringStyle.FloatMaxTwo),
-                                                    "CE_mmRHA".Translate()));
+        }
 
+        return stringBuilder.ToString();
+    }
 
-            stringBuilder.Append(string.Format("    {0}: {1} x {2}",
-                                                   "CE_DescBluntPenetration".Translate(),
-                                                   tool.armorPenetrationBlunt.ToStringByStyle(ToStringStyle.FloatMaxTwo),
-                                                   penetrationFactor.ToStringByStyle(ToStringStyle.FloatMaxThree)));
-            if (Mathf.Abs(skillFactor - 1f) > 0.001f)
-            {
-                stringBuilder.Append(string.Format(" x {0}", skillFactor.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
-            }
-            if (Mathf.Abs(otherFactors - 1f) > 0.001f)
-            {
-                stringBuilder.Append(string.Format(" x {0}", otherFactors.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
-            }
-            stringBuilder.AppendLine(string.Format(" = {0} {1}",
-                                                   (tool.armorPenetrationBlunt * penetrationFactor * skillFactor * otherFactors).ToStringByStyle(ToStringStyle.FloatMaxTwo),
-                                                   "CE_MPa".Translate()));
-            stringBuilder.AppendLine();
+    private void ShowExplanationForVerb(StringBuilder stringBuilder, Tool verbTool, ManeuverDef maneuver,
+        float skillFactor,
+        float otherFactors,
+        float penetrationFactor,
+        float chance)
+    {
+        if (verbTool is not ToolCE tool)
+        {
+            return;
         }
-        return stringBuilder.ToString();
+
+        var maneuverString = "(" + maneuver + ")";
+        stringBuilder.AppendLine("  " + "Tool".Translate() + ": " + tool.ToString() + " " + maneuverString);
+
+
+        stringBuilder.AppendLine("   " + "CE_WeaponPenetrationFactor".Translate() + ": " + penetrationFactor.ToStringByStyle(ToStringStyle.PercentZero));
+
+        if (Mathf.Abs(otherFactors - 1f) > 0.001f)
+        {
+            stringBuilder.AppendLine("   " + "CE_WeaponPenetrationOtherFactors".Translate() + ": " + otherFactors.ToStringByStyle(ToStringStyle.PercentZero));
+        }
+
+        stringBuilder.Append(string.Format("    {0}: {1} x {2}",
+                                               "CE_DescSharpPenetration".Translate(),
+                                               tool.armorPenetrationSharp.ToStringByStyle(ToStringStyle.FloatMaxTwo),
+                                               penetrationFactor.ToStringByStyle(ToStringStyle.FloatMaxThree)));
+        if (Mathf.Abs(skillFactor - 1f) > 0.001f)
+        {
+            stringBuilder.Append(string.Format(" x {0}", skillFactor.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+        }
+        if (Mathf.Abs(otherFactors - 1f) > 0.001f)
+        {
+            stringBuilder.Append(string.Format(" x {0}", otherFactors.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+        }
+        stringBuilder.AppendLine(string.Format(" = {0} {1}",
+                                                (tool.armorPenetrationSharp * penetrationFactor * skillFactor * otherFactors).ToStringByStyle(ToStringStyle.FloatMaxTwo),
+                                                "CE_mmRHA".Translate()));
+
+
+        stringBuilder.Append(string.Format("    {0}: {1} x {2}",
+                                               "CE_DescBluntPenetration".Translate(),
+                                               tool.armorPenetrationBlunt.ToStringByStyle(ToStringStyle.FloatMaxTwo),
+                                               penetrationFactor.ToStringByStyle(ToStringStyle.FloatMaxThree)));
+        if (Mathf.Abs(skillFactor - 1f) > 0.001f)
+        {
+            stringBuilder.Append(string.Format(" x {0}", skillFactor.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+        }
+        if (Mathf.Abs(otherFactors - 1f) > 0.001f)
+        {
+            stringBuilder.Append(string.Format(" x {0}", otherFactors.ToStringByStyle(ToStringStyle.FloatMaxTwo)));
+        }
+        stringBuilder.AppendLine(string.Format(" = {0} {1}",
+                                               (tool.armorPenetrationBlunt * penetrationFactor * skillFactor * otherFactors).ToStringByStyle(ToStringStyle.FloatMaxTwo),
+                                               "CE_MPa".Translate()));
+        stringBuilder.AppendLine("    " + "CE_ChanceFactor".Translate() + ": " + chance.ToStringByStyle(ToStringStyle.FloatMaxTwo));
+        stringBuilder.AppendLine();
     }
 
     public override string GetExplanationFinalizePart(StatRequest req, ToStringNumberSense numberSense, float finalVal)
     {
         return "StatsReport_FinalValue".Translate() + ": " + GetFinalDisplayValue(req);
     }
 
-    private string GetFinalDisplayValue(StatRequest optionalReq)
+    private string GetFinalDisplayValue(StatRequest req)
     {
-        var tools = (optionalReq.Def as ThingDef)?.tools;
-        if (tools.NullOrEmpty())
-        {
-            return "";
-        }
-        if (tools.Any(x => !(x is ToolCE)))
+        if (req.Def is not ThingDef thingDef)
         {
-            Log.Error($"Trying to get stat MeleeArmorPenetration from {optionalReq.Def.defName} which has no support for Combat Extended.");
             return "";
         }
 
-        float totalSelectionWeight = 0f;
-        foreach (Tool tool in tools)
+        var pawn = GetCurrentWielder(req);
+        var otherFactors = GetOtherFactors(pawn);
+        var skillFactor = GetSkillFactor(pawn);
+
+        float totalAveragePenSharp;
+        float totalAveragePenBlunt;
+
+        if (req.Thing is Pawn)
         {
-            totalSelectionWeight += tool.chanceFactor;
+            var meleeVerbs = pawn.meleeVerbs.GetUpdatedAvailableVerbsList(terrainTools: false);
+
+            totalAveragePenSharp = meleeVerbs.AverageWeighted(
+                verbEntry => verbEntry.GetSelectionWeight(null),
+                verbEntry => verbEntry.verb.tool is ToolCE tool ? tool.armorPenetrationSharp * otherFactors * verbEntry.verb.EquipmentSource?.GetStatValue(CE_StatDefOf.MeleePenetrationFactor) ?? 1f : 0f
+                );
+            totalAveragePenBlunt = meleeVerbs.AverageWeighted(
+                verbEntry => verbEntry.GetSelectionWeight(null),
+                verbEntry => verbEntry.verb.tool is ToolCE tool ? tool.armorPenetrationBlunt * otherFactors * verbEntry.verb.EquipmentSource?.GetStatValue(CE_StatDefOf.MeleePenetrationFactor) ?? 1f : 0f
+            );
         }
-        float totalAveragePenSharp = 0f;
-        float totalAveragePenBlunt = 0f;
-        foreach (ToolCE tool in tools)
+        else
         {
-            var weightFactor = tool.chanceFactor / totalSelectionWeight;
-            var otherFactors = GetOtherFactors(optionalReq).Aggregate(1f, (x, y) => x * y);
-            totalAveragePenSharp += weightFactor * tool.armorPenetrationSharp * otherFactors;
-            totalAveragePenBlunt += weightFactor * tool.armorPenetrationBlunt * otherFactors;
+            var verbPropsWithSource = AllMeleeVerbPropsWithSource(thingDef);
+            totalAveragePenSharp = verbPropsWithSource.AverageWeighted(
+                vps => AdjustedMeleeSelectionWeight(vps, pawn, req),
+                vps => vps.tool is ToolCE tool ? tool.armorPenetrationSharp * otherFactors : 0f
+            );
+            totalAveragePenBlunt = verbPropsWithSource.AverageWeighted(
+                vps => AdjustedMeleeSelectionWeight(vps, pawn, req),
+                vps => vps.tool is ToolCE tool ? tool.armorPenetrationBlunt * otherFactors : 0f
+            );
+
+            var penetrationFactor = GetPenetrationFactor(req);
+
+            totalAveragePenSharp *= penetrationFactor;
+            totalAveragePenBlunt *= penetrationFactor;
         }
-        var penetrationFactor = GetPenetrationFactor(optionalReq);
-        var skillFactor = GetSkillFactor(optionalReq);
 
-        return (totalAveragePenSharp * penetrationFactor * skillFactor).ToStringByStyle(ToStringStyle.FloatMaxTwo) + " " + "CE_mmRHA".Translate()
+        return (totalAveragePenSharp * skillFactor).ToStringByStyle(ToStringStyle.FloatMaxTwo) + " " + "CE_mmRHA".Translate()
                + ", "
-               + (totalAveragePenBlunt * penetrationFactor * skillFactor).ToStringByStyle(ToStringStyle.FloatMaxTwo) + " " + "CE_MPa".Translate();
+               + (totalAveragePenBlunt * skillFactor).ToStringByStyle(ToStringStyle.FloatMaxTwo) + " " + "CE_MPa".Translate();
     }
 
     private float GetPenetrationFactor(StatRequest req)
@@ -144,30 +213,23 @@ private float GetPenetrationFactor(StatRequest req)
     }
     public const float skillFactorPerLevel = (25f / 19f) / 100f;
     public const float powerForOtherFactors = 0.75f;
-    private float GetSkillFactor(StatRequest req)
+    private float GetSkillFactor(Pawn pawn)
     {
         var skillFactor = 1f;
-        if (req.Thing is Pawn pawn && pawn.skills != null)
+        if (pawn?.skills != null)
         {
             skillFactor += skillFactorPerLevel * (pawn.skills.GetSkill(SkillDefOf.Melee).Level - 1);
         }
-        else
-        {
-            var thingHolder = (req.Thing?.ParentHolder as Pawn_EquipmentTracker)?.pawn;
-            if (thingHolder != null && thingHolder.skills != null)
-            {
-                skillFactor += skillFactorPerLevel * (thingHolder.skills.GetSkill(SkillDefOf.Melee).Level - 1);
-            }
-        }
         return skillFactor;
     }
-    private IEnumerable<float> GetOtherFactors(StatRequest req)
+    private float GetOtherFactors(Pawn pawn)
     {
-        var pawn = req.Thing as Pawn ?? (req.Thing?.ParentHolder as Pawn_EquipmentTracker)?.pawn;
         if (pawn != null)
         {
-            yield return Mathf.Pow(pawn.ageTracker.CurLifeStage.meleeDamageFactor, powerForOtherFactors);
-            yield return Mathf.Pow(pawn.GetStatValue(StatDefOf.MeleeDamageFactor, true, -1), powerForOtherFactors);
+            return Mathf.Pow(pawn.ageTracker.CurLifeStage.meleeDamageFactor, powerForOtherFactors) *
+                   Mathf.Pow(pawn.GetStatValue(StatDefOf.MeleeDamageFactor, true, -1), powerForOtherFactors);
         }
+
+        return 1f;
     }
 }