Module:Droprate: Difference between revisions

Latest revision as of 01:28, 3 June 2025

HR 0-224

HR 225+

Inferno

Monsters_Bosses

Monster_GhostKing_Misc

QuestItemDefaultCommon

EventCurrency

Rolls: 3

Drop rates
Luck grade	Probability	Probability per item	Item count
6	55%	0.9483%	58
7	45%	0.7759%	58

Loot Table
Name	Luck Grade	Rarity	Item Count
Crusader Armor	6	Legend	1
Crusader Armor	7	Unique	1
Owl Pendant	6	Legend	1
Owl Pendant	7	Unique	1
Troubadour Outfit	6	Legend	1
Troubadour Outfit	7	Unique	1
Studded Leather	6	Legend	1
Studded Leather	7	Unique	1
Rondel Dagger	6	Legend	1
Rondel Dagger	7	Unique	1
Champion Armor	6	Legend	1
Champion Armor	7	Unique	1
Necklace of Peace	6	Legend	1
Necklace of Peace	7	Unique	1
Badger Pendant	6	Legend	1
Badger Pendant	7	Unique	1
Arcane Garb	6	Legend	1
Arcane Garb	7	Unique	1
Dark Cuirass	6	Legend	1
Dark Cuirass	7	Unique	1
Fine Cuirass	6	Legend	1
Fine Cuirass	7	Unique	1
Warden Outfit	6	Legend	1
Warden Outfit	7	Unique	1
Bloodwoven Robe	6	Legend	1
Bloodwoven Robe	7	Unique	1
Ox Pendant	6	Legend	1
Ox Pendant	7	Unique	1
Hatchet	6	Legend	1
Hatchet	7	Unique	1
Monkey Pendant	6	Legend	1
Monkey Pendant	7	Unique	1
Adventurer Tunic	6	Legend	1
Adventurer Tunic	7	Unique	1
Ornate Jazerant	6	Legend	1
Ornate Jazerant	7	Unique	1
Castillon Dagger	6	Legend	1
Castillon Dagger	7	Unique	1
Stiletto Dagger	6	Legend	1
Stiletto Dagger	7	Unique	1
Light Aketon	6	Legend	1
Light Aketon	7	Unique	1
Regal Gambeson	6	Legend	1
Regal Gambeson	7	Unique	1
Battle Axe	6	Legend	1
Battle Axe	7	Unique	1
Grand Brigandine	6	Legend	1
Grand Brigandine	7	Unique	1
Ritual Robe	6	Legend	1
Ritual Robe	7	Unique	1
Darkgrove Robe	6	Legend	1
Darkgrove Robe	7	Unique	1
Felling Axe	6	Legend	1
Felling Axe	7	Unique	1
Occultist Robe	6	Legend	1
Occultist Robe	7	Unique	1
Occultist Tunic	6	Legend	1
Occultist Tunic	7	Unique	1
Ring of Vitality	6	Legend	1
Ring of Vitality	7	Unique	1
Oracle Robe	6	Legend	1
Oracle Robe	7	Unique	1
Ring of Resolve	6	Legend	1
Ring of Resolve	7	Unique	1
Frock	6	Legend	1
Frock	7	Unique	1
Ring of Finesse	6	Legend	1
Ring of Finesse	7	Unique	1
Marauder Outfit	6	Legend	1
Marauder Outfit	7	Unique	1
Pourpoint	6	Legend	1
Pourpoint	7	Unique	1
Wind Locket	6	Legend	1
Wind Locket	7	Unique	1
Double Axe	6	Legend	1
Double Axe	7	Unique	1
Dark Plate Armor	6	Legend	1
Dark Plate Armor	7	Unique	1
Doublet	6	Legend	1
Doublet	7	Unique	1
Wanderer Attire	6	Legend	1
Wanderer Attire	7	Unique	1
Templar Armor	6	Legend	1
Templar Armor	7	Unique	1
Ring of Wisdom	6	Legend	1
Ring of Wisdom	7	Unique	1
Kris Dagger	6	Legend	1
Kris Dagger	7	Unique	1
Mystic Vestments	6	Legend	1
Mystic Vestments	7	Unique	1
Torq of Soul	6	Legend	1
Torq of Soul	7	Unique	1
Padded Tunic	6	Legend	1
Padded Tunic	7	Unique	1
Bear Pendant	6	Legend	1
Bear Pendant	7	Unique	1
Ring of Quickness	6	Legend	1
Ring of Quickness	7	Unique	1
Ring of Courage	6	Legend	1
Ring of Courage	7	Unique	1
Rat Pendant	6	Legend	1
Rat Pendant	7	Unique	1
Heavy Gambeson	6	Legend	1
Heavy Gambeson	7	Unique	1
Ring of Survival	6	Legend	1
Ring of Survival	7	Unique	1
Phoenix Choker	6	Legend	1
Phoenix Choker	7	Unique	1
Horseman's Axe	6	Legend	1
Horseman's Axe	7	Unique	1
Northern Full Tunic	6	Legend	1
Northern Full Tunic	7	Unique	1
Frost Amulet	6	Legend	1
Frost Amulet	7	Unique	1
Fox Pendant	6	Legend	1
Fox Pendant	7	Unique	1

--[[
Terminology:
- Dungeon: A specific area in the game where players can explore and fight monsters.  Synonymous with "queue".
- Dungeon grade: A numeric code representing a specific dungeon mode and map combination.
	- Mode: The type of dungeon, such as PvE or LR or HR.
	- Map: The specific area within the dungeon, such as Goblin Caves or Ice Cavern.
- Loot table: A combination of loot drop and drop rate data and roll count
	- Loot drop table: A collection of items and the rarity therein that can be rolled for a loot table.
	- Drop rate table: Contains the rates at which certain luck grades are rolled.
		- Luck grade: A property which determines which items are rolled from within the loot drop table.
	- Roll count: The number of times the loot table is rolled.
- Loot drop group: table of all the loot tables for each specific dungeon grade. It also contains loot drop tables and drop rate tables.

For an easier time following the code, the functions each have a docstring.
Use Lua by Sumneko on VSCode to view workspace function signatures and type hints.

#TODO
	Change code to handle props and loose loot as well.
]]--


local p = {}
local utils = require("Module:Utilities")


local modes = {
	["Default"] = "0",
	["PvE"] = "10",
	["LR 0-124"] = "20",
	["LR 125+"] = "21",
	["HR 0-224"] = "30",
	["HR 225+"] = "40"
}
local maps = {
	["Default"] = "0",
	["Goblin Caves"] = "01",
	["Ice Cavern"] = "11",
	["Ice Abyss"] = "12",
	["Ruins"] = "21",
	["Crypts"] = "22",
	["Inferno"] = "23"
}
-- Convert one two strings to a numeric code. Note that the returned strings are concatenated, so the order matters.
-- - @param a: string (optional) - associated with either a mode or a map string
-- - @param b: string (optional) - associated with either a mode or a map string
-- - @return: string - number representing the dungeon mode or map or both
-- - - e.g. ("") -> ""
-- - - e.g. ("Gibberish") -> ""
-- - - e.g. ("PvE") -> "10"
-- - - e.g. ("Goblin Caves") -> "01"
-- - - e.g. ("PvE","Goblin Caves") -> "1001"
local function interpret_dungeon_strings(a,b)
	-- Convert the input strings to their corresponding numeric codes, if they exist
	a = modes[tostring(a)] or maps[tostring(a)]
	b = modes[tostring(b)] or maps[tostring(b)]

	-- If strings weren't matched, default to empty strings instead of nil
	if a == nil then a = '' end
	if b == nil then b = '' end

	-- Default cases cannot be paired with other modes or maps, so return "0" if either is "Default"
	if a == "Default" or b == "Default" then
		return "0"
	else
		return a..b
	end
end


local dungeon_grades = {
	["0"] = {"Default","Default"},

	["1001"] = {"PvE","Goblin Caves"},
	["1011"] = {"PvE","Ice Cavern"},
	["1012"] = {"PvE","Ice Abyss"},
	["1021"] = {"PvE","Ruins"},
	["1022"] = {"PvE","Crypts"},
	["1023"] = {"PvE","Inferno"},

	["2001"] = {"LR 0-124","Goblin Caves"},
	["2011"] = {"LR 0-124","Ice Cavern"},
	["2012"] = {"LR 0-124","Ice Abyss"},
	["2021"] = {"LR 0-124","Ruins"},
	["2022"] = {"LR 0-124","Crypts"},
	["2023"] = {"LR 0-124","Inferno"},

	["2101"] = {"LR 125+","Goblin Caves"},
	["2111"] = {"LR 125+","Ice Cavern"},
	["2112"] = {"LR 125+","Ice Abyss"},
	["2121"] = {"LR 125+","Ruins"},
	["2122"] = {"LR 125+","Crypts"},
	["2123"] = {"LR 125+","Inferno"},

	["3001"] = {"HR 0-224","Goblin Caves"},
	["3011"] = {"HR 0-224","Ice Cavern"},
	["3012"] = {"HR 0-224","Ice Abyss"},
	["3021"] = {"HR 0-224","Ruins"},
	["3022"] = {"HR 0-224","Crypts"},
	["3023"] = {"HR 0-224","Inferno"},

	["4001"] = {"HR 225+","Goblin Caves"},
	["4011"] = {"HR 225+","Ice Cavern"},
	["4012"] = {"HR 225+","Ice Abyss"},
	["4021"] = {"HR 225+","Ruins"},
	["4022"] = {"HR 225+","Crypts"},
	["4023"] = {"HR 225+","Inferno"}
}
-- Convert a numeric dungeon grade to its corresponding mode and map strings
-- - @param grade: string - integer corresponding to a specific mode and map
-- - @return: string, string - pair of strings corresponding to the mode and map
-- - - e.g. (0) -> "Default", "Default"; (4023) -> "HR 225+", "Inferno"
-- - - e.g. (5318008) -> "Default", "Default"; ("test") -> "Default", "Default"
local function interpret_dungeon_grade(dungeon_grade)
	if dungeon_grade == nil or dungeon_grades[dungeon_grade] == nil then
		return dungeon_grades["0"][1], dungeon_grades["0"][2]
	end

	return dungeon_grades[dungeon_grade][1], dungeon_grades[dungeon_grade][2]
end


-- Interpret a list of dungeon grades and return the corresponding tree
-- - @param dungeon_grades: table - ideally the dungeon grades are numericall ordered
-- - - Example: {1001, 2001, 4023}
-- - @return: table - a 2-level tree structure with order lists
-- - - Example: {["mode_order"] = {"PvE", "HR 225+""},
--				["PvE"] = {["map_order"] = {"Goblin Caves", "Ice Cavern"}, ["Goblin Caves"] = true, ["Ice Cavern"] = true},
--				["HR 225+"] = {["map_order"] = {"Ice Cavern", "Ice Abyss"}, ["Ice Cavern"] = true, ["Ice Abyss"] = true}}
local function get_dungeon_tree(ordered_dungeon_grades)
	if ordered_dungeon_grades == nil then return {} end

	local tree = {}
	tree.order = {}

	for _,dungeon_grade in ipairs(ordered_dungeon_grades) do
		local mode,map = interpret_dungeon_grade(tostring(dungeon_grade))
		
		if tree[mode] == nil then
			tree[mode] = {}
			tree[mode].order = {}
			table.insert(tree.order,mode)
		end
		if tree[mode][map] == nil then
			tree[mode][map] = true
			table.insert(tree[mode].order,map)
		end
	end

	return tree
end


-- Create a div header with a class based on the id and an optional display argument
-- - @param id: string - represents the id of the div
-- - @param is_displayed: boolean - indicates whether the div should be displayed or hidden
-- - @return: string - the HTML div header
-- - - e.g. '\<div class="0-data" style="display:none;">'
-- - - e.g. '\<div class="0-data">
local function create_div_header(id_prefix, id, is_displayed)
	local interpretation = interpret_dungeon_strings(id)
	if interpretation == ''  then interpretation = id end

	if is_displayed then
		return '<div class="'..id_prefix..interpretation..'-data">'
	else
		return '<div class="'..id_prefix..interpretation..'-data" style="display:none;">'
	end
end


-- Create a tab toggle element with a specific id, number, and content
-- - @param data_tabid: string - determines which class to toggle when the toggle is clicked
-- - @param data_tab: string - determines the toggle group, among which only one can be selected at a time
-- - @param content: string - the content of the tab toggle
-- - @param selected_tab: boolean - if true, the tab will be displayed as selected
-- - @return: string - the HTML tab toggle element
-- - - Example: \<div class="selected-tab tab-toggle tab" data-tabid="0" data-tab="PvE">PvE\</div>
local function create_tab_toggle(data_tab_id, data_tab, content, selected_tab)
	if selected_tab then
		return '<div class="selected-tab tab-toggle tab" data-tabid="'..data_tab_id..'" data-tab="'..data_tab..'">'..content..'</div>'
	else
		return '<div class="tab-toggle tab" data-tabid="'..data_tab_id..'" data-tab="'..data_tab..'">'..content..'</div>'
	end
end


-- Create tab toggles from a list of tabs.
-- - @param tab_list: table - list of content to be displayed for tab toggles.
-- - - e.g. {"PvE", "LR 0-124", "LR 125+", "HR 0-224", "HR 225+"}.
-- - @param tab_id: string - the id of the tab toggle group. Must be unique per tab toggle group.
-- - - e.g. "0" for the first level of tabs, or 11 for second level in the first group.
local function create_tab_toggles_from_list(tab_list, tab_id)
	if tab_list == nil then return '' end

	local wikitext = ''
	for i,tab in ipairs(tab_list) do
		local interpretation = interpret_dungeon_strings(tab)
		if interpretation == ''  then interpretation = tab end

		wikitext = wikitext..create_tab_toggle(tab_id, tab_id..interpretation, tab, i==1)
	end

	return wikitext
end


-- Round a number to a specified decimal place value
local function round(number, decimal_places)
	return tonumber(("%."..(decimal_places or 0).."f"):format(number))
end


-- Create a drop rate table from drop rate data and loot drop item counts
-- - @param drop_rate_data: table - contains drop rate data keyed by luck grade
-- - @param loot_drop_item_counts: table - contains item counts keyed by luck grade
-- - @return: string - the HTML drop rate table
local function create_drop_rate_wikitext(drop_rate_data, loot_drop_item_counts)
	local droprate_table = '<table cellspacing="0" class="loottable stripedtable sortable jquery-tablesorter mw-collapsible" style="width:100%"><caption>Drop rates&nbsp;</caption>'
		..'<tr><th style="width:5%">Luck grade</th><th style="width:5%">Probability</th><th style="width:5%">Probability per item</th><th style="width:5%">Item count</th></tr>'

	for luckgrade = 1,8 do
		local probability = drop_rate_data[luckgrade]
		local item_count = loot_drop_item_counts[luckgrade]
		if probability ~= nil and item_count ~= nil then
			droprate_table = droprate_table
				.."<tr class='cr"..luckgrade.."'>"
					.."<td><b>"..luckgrade.."</b></td>"
					.."<td><b>".. 100*probability.."%</b></td>"
					.."<td><b>"..round(100*probability/item_count,4).."%</b></td>"
					.."<td><b>"..item_count.."</b></td>"
				.."</tr>"
		end
	end

	return droprate_table..'</table><br>'
end


-- Clean an ID string by removing the "I[dD]_..._" prefix and any trailing numbers
local function clean_loot_table_id(loot_table_id)
	local cleaned_id = loot_table_id:gsub("I[dD]_%a*_","")
	cleaned_id = cleaned_id:gsub("_%d+$", "")
	return cleaned_id
end


-- Get the loot table ids for a specific dungeon grade
-- - @param loot_tables: table - contains array of severl loot drop, drop rate, roll count pairs.
-- - @return: table - array of loot drop rate ids
local function get_loot_table_ids(loot_tables)
	local drop_rate_ids = {}
	for _, loot_table in ipairs(loot_tables) do
		table.insert(drop_rate_ids, clean_loot_table_id(loot_table.drop_rate_id))
	end
	return drop_rate_ids
end


-- Get the luck grades for a specific drop rate table
-- - @param drop_rate_table: table - contains drop rate data keyed by luck grade
-- - @return: table - contains luck grades keyed by their numeric value
local function get_luck_grades(drop_rate_table)
	local luck_grades = {}
	for i = 1,8 do
		if drop_rate_table[i] then luck_grades[i]=true end
	end
	return luck_grades
end


-- Create a loot table from loot drop and drop rate data
-- - @param items: table - contains item data keyed by item name
-- - - e.g. {["Unobtainium Ore"] = {{luck_grade = 9, rarity = 9, count = 2}, {luck_grade = 9, rarity = 9, count = 10}}, 
--           ["Mithril Ore"] = {{luck_grade = 8, rarity = 8, count = 1}, {luck_grade = 8, rarity = 8, count = 8}}}
-- - @param luck_grades: table - contains luck grades keyed by their numeric value
-- - - e.g. {3=true, 5=true, 7=true, 8=true}
-- - @return: string - the HTML loot table
local function create_loot_drop_wikitext(items,luck_grades)
	local wikitext = '<table cellspacing="0" class="loottable stripedtable sortable jquery-tablesorter mw-collapsible" style="width:100%">'
		..'<caption>Loot Table&nbsp;</caption>'
		..'<tr><th style="width:5%">Name</th><th style="width:5%">Luck Grade</th><th style="width:5%">Rarity</th><th style="width:5%">Item Count</th></tr>'

	for item_name, item_data in pairs(items) do
		local rowspan = 0
		for _,item_record in ipairs(item_data) do
			if luck_grades[item_record.luck_grade] then rowspan = rowspan + 1 end
		end

		-- Track how many rows have been created for this item; this is typically a subset of the entire record array
		local record_row_index = 1 -- this is incremented at the end of the loop's if block
		for _, item_record in ipairs(item_data) do
			if luck_grades[item_record.luck_grade] then
				local luck_grade = item_record.luck_grade
				local rarity_num = item_record.rarity
				local item_count = item_record.count

				local rarity_name = utils.rarity_num_to_name(rarity_num)
				if rarity_name == nil then return "rarity_num of '" .. rarity_num .. "' was converted to a nil rarity_name." end

				local rowspan_td_cell = ""
				-- if first, record's td must span all records rows and have an appropriate iconbox
				if record_row_index == 1 then
					if rowspan > 1 then
						rowspan_td_cell = "<td rowspan='" .. rowspan .. "'>"
					else
						rowspan_td_cell = "<td>" -- no rowspan needed for items with only one record
					end
					-- create the td element containing the iconbox
					rowspan_td_cell = rowspan_td_cell
							.."<div class='iconbox'>"
								.."<div class='rarity"..rarity_num.." rounded relative'>"
									.."[[File:"..item_name..".png|x80px|link="..item_name.."]]"
								.."</div>"
								.."[["..item_name.."|<b class=cr"..rarity_num..">"..item_name.."</b>]]"
							.."</div>"
						.."</td>"
				end

				-- Add the row to the resulting table
				wikitext = wikitext
					.."<tr>"
						..rowspan_td_cell
						.."<td class='cr"..luck_grade.."'><b>"..luck_grade.."</b></td>"
						.."<td class='cr"..rarity_num.."'><b>"..rarity_name.."</b></td>"
						.."<td>"..item_count.."</td>"
					.."</tr>"

				record_row_index = record_row_index + 1
			end
		end
	end

	return wikitext..'</table><br>'
end

-- Create the wikitext containing loot tables specific to a monster/prop/loose loot
-- - @param LDG: table
-- - @return: string - the wikitext containing tab toggles and loot tables
local function create_wikitext(LDG,dungeon_tree)
	local wikitext = create_tab_toggles_from_list(dungeon_tree.order,"0") -- mode toggles
	for i,mode in ipairs(dungeon_tree.order) do -- modes - 4 nodes
		wikitext = wikitext
			..create_div_header("0", mode, i == 1)
			..create_tab_toggles_from_list(dungeon_tree[mode].order,"1"..i) -- map toggles

		for j,map in ipairs(dungeon_tree[mode].order) do -- maps - 1 to 6 nodes
			local dungeon_grade = tonumber(interpret_dungeon_strings(mode, map)) -- e.g. "1001" for "PvE", "Goblin Caves"

			wikitext = wikitext
				..create_div_header("1"..i, map, j == 1) -- prefix "1", the tab toggle's depth, to create a unique identifier
				..create_tab_toggles_from_list(get_loot_table_ids(LDG.loot_drop_groups.data[dungeon_grade]),"2"..i..j) -- loot table toggles

			for k,loot_table in ipairs(LDG.loot_drop_groups.data[dungeon_grade]) do -- 1 to 6 nodes
				wikitext = wikitext
					..create_div_header("2"..i..j, clean_loot_table_id(loot_table.drop_rate_id), k == 1)

						..'<span style="margin:20px 0px 20px 30px; font-size:24px">Rolls: '..loot_table.roll_count..'</span>'

						..create_drop_rate_wikitext(
							LDG.drop_rates[loot_table.drop_rate_id],
							LDG.loot_drops[loot_table.loot_drop_id].items_per_luck_grade)

						..create_loot_drop_wikitext(
							LDG.loot_drops[loot_table.loot_drop_id].items_data,
							get_luck_grades(LDG.drop_rates[loot_table.drop_rate_id]))

					..'</div>' -- close the content div
			end
			wikitext = wikitext..'</div>' -- close the map div
		end
		wikitext = wikitext..'</div>' -- close the mode div
	end

	return wikitext
end


-- Get the localized string and grade from a page name
local function get_localized_string_and_grade(page_name)
	-- Get the last word in the page name, which is expected to be the grade
	local grade = page_name:reverse():match("[^%s]+"):reverse()
	if grade == "Elite" or grade == "Nightmare" then
		local localized_string,_ = page_name:gsub(" "..grade,"")
		return localized_string, grade
	else
		return page_name, "Common"
	end
end


-- #TODO make this function more generic, so it can be used for props and loose loot as well.
-- Currently only formatted for Data:Monster.json
local function get_object_data(page_name, id_type)
	local data
	if id_type == "Monster" then
		data = mw.loadJsonData("Data:Monster.json")
	elseif id_type == "Prop" then
		data = mw.loadJsonData("Data:Prop.json")
	elseif id_type == "Loose_loot" then
		data = mw.loadJsonData("Data:Loose_loot.json")
	else
		return nil -- Invalid id_type
	end

	local localized_string, grade = get_localized_string_and_grade(page_name)
	local id = data.monster_localized_names[localized_string][grade]

	return mw.loadJsonData("Data:"..data.monster_ids[id].loot_drop_group_id..".json"), get_dungeon_tree(data.monster_ids[id].dungeon_grade_order)
end

-- Create a loot table for a specific monster, prop, or loose loot
-- - @param frame: table
-- - - frame.args[1]: string - {{PAGENAME}} or localized string + grade
-- - - frame.args[2]: string - type of the object, either "Monster", "Prop", or "Loose_loot"
function p.loot_tables(frame)
	-- -- frame.args[1] will always be the localized string of either a monster, prop, or loose loot.
	local LDG, dungeon_tree = get_object_data(frame.args[1], frame.args[2])
	if LDG == nil then return "LootDropGroup file could not be found." end

	return create_wikitext(LDG, dungeon_tree)
end

return p

Luck grade	Probability	Probability per item	Item count
1	10.5%	10.5%	1
2	37.5%	12.5%	3
3	48%	12%	4
5	2%	2%	1
6	2%	2%	1

Luck grade	Probability	Probability per item	Item count
1	96%	24%	4
2	2%	0.25%	8
3	1%	0.25%	4
4	1%	0.2%	5

Luck grade	Probability	Probability per item	Item count
1	96%	24%	4
2	2%	0.25%	8
3	1%	0.25%	4
4	1%	0.2%	5

Home

General

Mechanics

Items

Dungeon

Map

Tools

Module:Droprate: Difference between revisions

Latest revision as of 01:28, 3 June 2025

Loot Table
Name	Luck Grade	Rarity	Item Count
Cursed Crown	5	Epic	1
Ghostly Essence	5	Epic	1

Loot Table
Name	Luck Grade	Rarity	Item Count
Cursed Crown	5	Epic	1
Ghostly Essence	5	Epic	1