Sort the Calculations Tab breakdown lists by value (#7211)

* Sort the CalcBreakdownControl list by value.

There is already a sort by type, but this is not used for a lot of
breakdowns. Applying a sort by value should make it easier to read the
breakdown without disrupting the sort by type.

* Sort the CalcBreakdownControl taking in consideration boolean values.

Some breakdowns can contain a mix of `number` and `boolean`. e.g. the skill buffs breakdown if you have a golem active will have a `Condition: have golem` with value of `true`.

The values in this kind of breakdown are pretty sparse and sorting them in a coherent way is not easy, so for the sake of this PR we can just keep skip(return false) when comparing number and boolean.

* Use a copy of the modList in CalcBreakdownControl

If we try to sort on the original modlist, we'll actually change the order of the values in memory and next time we sort again, some of the mods can move position.

Using a copy of the table--which will be discarded after use--will prevent this.

* Sort generic breakdown and slots

Breakdowns can also accept direct breakdown tables and slots values. These also need to be sorted by value.

Author: duiker101

src/Classes/CalcBreakdownControl.lua

@@ -148,12 +148,19 @@ function CalcBreakdownClass:AddBreakdownSection(sectionData)
 	end
 
 	if breakdown.rowList and #breakdown.rowList > 0 then
+		-- sort by the first column (the value)
+		local rowList = copyTable(breakdown.rowList, true)
+		local colKey = breakdown.colList[1].key
+		table.sort(rowList, function(a, b)
+			return a[colKey] > b[colKey]
+		end)
+		
 		-- Generic table
 		local section = {
 			type = "TABLE",
 			label = breakdown.label,
 			footer = breakdown.footer,
-			rowList = breakdown.rowList,
+			rowList = rowList,
 			colList = breakdown.colList,
 		}
 		t_insert(self.sectionList, section)
@@ -225,6 +232,10 @@ function CalcBreakdownClass:AddBreakdownSection(sectionData)
 			rowList = breakdown.slots
 		end
 
+		table.sort(rowList, function(a, b)
+			return a['base'] > b['base']
+		end)
+		
 		local section = { 
 			type = "TABLE",
 			rowList = rowList,
@@ -260,8 +271,8 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 	cfg.actor = sectionData.actor
 	local rowList
 	local modStore = (sectionData.enemy and actor.enemy.modDB) or (sectionData.cfg and actor.mainSkill.skillModList) or actor.modDB
-	if modList then	
-		rowList = modList
+	if modList then
+		rowList = copyTable(modList)
 	else
 		if type(sectionData.modName) == "table" then
 			rowList = modStore:Tabulate(sectionData.modType, cfg, unpack(sectionData.modName))
@@ -289,6 +300,17 @@ function CalcBreakdownClass:AddModSection(sectionData, modList)
 	}
 	t_insert(self.sectionList, section)
 
+	table.sort(rowList, function(a, b)
+		-- Sort Modifiers by descending value
+		if type(a.value) == 'number' and type(b.value) == 'number' then
+			return b.value < a.value
+		end
+		if type(a.value) == 'boolean' and type(b.value) == 'boolean' then
+			return a.value and not b.value
+		end
+		return false
+	end)
+
 	if not modList and not sectionData.modType then
 		-- Sort modifiers by type
 		for i, row in ipairs(rowList) do
@@ -726,4 +748,4 @@ function CalcBreakdownClass:OnKeyUp(key)
 		self.controls.scrollBar:Scroll(-1)
 	end
 	return self
-end
+end