Module:DropsLine: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary Tag: Reverted |
||
Line 86: | Line 86: | ||
p.commas = commas | p.commas = commas | ||
function adjust_rarity(rarity_value, adjustment) | function adjust_rarity(rarity_value, adjustment) | ||
if not rarity_value or not tonumber(rarity_value) then return nil end | if not rarity_value or not tonumber(rarity_value) then return nil end | ||
local adjusted_value = 1 / ((1 / rarity_value) * (1 - adjustment)) | local adjusted_value = 1 / ((1 / rarity_value) * (1 - adjustment)) | ||
return adjusted_value | return adjusted_value | ||
end | end | ||
Line 119: | Line 96: | ||
local frameArgs = frame.args | local frameArgs = frame.args | ||
-- Params and defaults | |||
local name,namenotes, | local name,namenotes, | ||
quantity,quantitynotes, | quantity,quantitynotes, | ||
Line 134: | Line 112: | ||
{args.version or args.Version,''}, | {args.version or args.Version,''}, | ||
} | } | ||
raritynotes = raritynotes .. citation | |||
local rolls = tonumber(args.rolls or args.Rolls) or false | local rolls = tonumber(args.rolls or args.Rolls) or false | ||
local rollstext = '' | local rollstext = '' | ||
Line 147: | Line 125: | ||
local _smwname = params.default_to(args.smwname,gemwname) | local _smwname = params.default_to(args.smwname,gemwname) | ||
-- Clean name | |||
local dropVers = '' | local cleanedName, dropVers = name, '' | ||
if _smwname:match(' ?%(%d%)$') then | if _smwname:match(' ?%(%d%)$') then | ||
cleanedName, dropVers = mw.ustring.match(gemwname, '^(.-) ?(%(%d%))$') | cleanedName, dropVers = mw.ustring.match(gemwname, '^(.-) ?(%(%d%))$') | ||
Line 178: | Line 156: | ||
rarity = params.ucflc(rarity) | rarity = params.ucflc(rarity) | ||
else | else | ||
rarity_value = rarity:gsub(',','') | rarity_value = rarity:gsub(',','') --temp place to put this without overriding rarity | ||
local rv1, rv2 = string.match(rarity_value, '([%d%.]+)/([%d%.]+)') | local rv1, rv2 = string.match(rarity_value, '([%d%.]+)/([%d%.]+)') | ||
if rv1 and rv2 then | if rv1 and rv2 then | ||
Line 192: | Line 170: | ||
alt_rarity = params.ucflc(alt_rarity) | alt_rarity = params.ucflc(alt_rarity) | ||
else | else | ||
alt_rarity_value = alt_rarity:gsub(',','') | alt_rarity_value = alt_rarity:gsub(',','') --temp place to put this without overriding rarity | ||
local rv1, rv2 = string.match(alt_rarity_value, '([%d%.]+)/([%d%.]+)') | local rv1, rv2 = string.match(alt_rarity_value, '([%d%.]+)/([%d%.]+)') | ||
if rv1 and rv2 then | if rv1 and rv2 then | ||
Line 235: | Line 213: | ||
gemw = false | gemw = false | ||
elseif isCoins then | elseif isCoins then | ||
-- coins override | |||
valueInfo = { | valueInfo = { | ||
alch = { | alch = { | ||
Line 246: | Line 225: | ||
} | } | ||
else | else | ||
-- find alch price | |||
if alch then | if alch then | ||
-- first check cache for alch value | |||
if cached_alch ~= nil then | if cached_alch ~= nil then | ||
valueInfo.alch = { | valueInfo.alch = { | ||
Line 253: | Line 234: | ||
} | } | ||
elseif gemw then | elseif gemw then | ||
-- then check gemw for alch value | |||
local hasgealch, gealchval = pcall(f_gealch,gemwname) | local hasgealch, gealchval = pcall(f_gealch,gemwname) | ||
if hasgealch then | if hasgealch then | ||
Line 264: | Line 246: | ||
end | end | ||
if not valueInfo.alch.has then | if not valueInfo.alch.has then | ||
alch = false | -- failed to find alch in GEMW or is on the no-ge list/override | ||
-- lookup in SMW | |||
if smwret and smwret.alch ~= nil then | |||
-- alch is defined, use it | |||
valueInfo.alch = { | |||
has = true, | |||
value = smwret.alch | |||
} | |||
else | |||
alch = false | |||
end | |||
end | end | ||
end | end | ||
-- find ge price | |||
if gemw then | if gemw then | ||
if geprice_frombulk ~= nil then | if geprice_frombulk ~= nil then | ||
Line 412: | Line 406: | ||
end | end | ||
-- Adjusted rarity for donator ranks | |||
local adjustments = { | |||
['Normal Donator'] = 0.15, | |||
['Super Donator'] = 0.25, | |||
['Extreme Donator'] = 0.30, | |||
['Legendary Donator'] = 0.35, | |||
['Royal Donator'] = 0.40 | |||
} | |||
for rank, adjustment in pairs(adjustments) do | |||
local adjusted_rarity = adjust_rarity(rarity_value, adjustment) | |||
local adjusted_rarity_text = adjusted_rarity and string.format('1/%.0f', 1/adjusted_rarity) or 'N/A' | |||
ret:tag('td') | |||
:addClass(rare_class) | |||
:wikitext(adjusted_rarity_text) | |||
end | end | ||
if #raritynotes > 3 then | if #raritynotes > 3 then | ||
rarity_cell:wikitext(raritynotes) | rarity_cell:wikitext(raritynotes) | ||
end | end | ||
Line 471: | Line 453: | ||
if ge_td_content == nil then | if ge_td_content == nil then | ||
ge_td_content = 'Not sold' | ge_td_content = 'Not sold' | ||
ge_td_title = 'This item cannot be traded on the | ge_td_title = 'This item cannot be traded on the Grand Exchange.' | ||
ge_td:addClass('table-na'):css('text-decoration', 'underline dotted') | ge_td:addClass('table-na'):css('text-decoration', 'underline dotted') | ||
end | end | ||
Line 481: | Line 463: | ||
local unrecognizedDropVersionCategory = '' | local unrecognizedDropVersionCategory = '' | ||
if onMain and useSmw and isNothing ~= true then | if onMain and useSmw and isNothing ~= true then | ||
-- SMW data omitted for brevity | |||
end | end | ||
Line 519: | Line 470: | ||
function qty(quantity, isNothing) | function qty(quantity, isNothing) | ||
-- Quantity parsing function omitted for brevity | |||
end | end | ||
function get_total(value,qhigh,qlow) | function get_total(value, qhigh, qlow) | ||
-- Value calculation function omitted for brevity | |||
end | end | ||
function categories(...) | function categories(...) | ||
-- Category function omitted for brevity | |||
end | end | ||
return p | return p |
Revision as of 00:43, 4 April 2024
Documentation for this module may be created at Module:DropsLine/doc
local p = {}
local params = require('Module:Paramtest')
local lang = mw.language.getContentLanguage()
local coins_image = require('Module:Coins image')
local curr_image = require('Module:Currency Image')
local yesno = require('Module:Yesno')
local var = mw.ext.VariablesLua
-- precalculated cached data
local droppeditem_data = mw.loadJsonData('Module:DropsLine/itemData.json')
local geprices_data = mw.loadJsonData('Module:GEPrices/data.json')
local highalch_data = mw.loadJsonData('Module:GEHighAlchs/data.json')
local ptitle = mw.title.getCurrentTitle()
local ns = ptitle.nsText
local title = ptitle.fullText
local pgTitle = ptitle.text
local _noted = ' <span class="dropsline-noted">(noted)</span>'
local coins_priceString = "%s Pkp"
local other_priceString = "%s Pkp"
--bg, txt, sort; acceptable non-quantity rarity names
local rarities = {
always = { 'table-bg-blue', 1 },
common = { 'table-bg-green', 16 },
uncommon = { 'table-bg-yellow', 64 },
rare = { 'table-bg-orange', 128 },
['very rare'] = { 'table-bg-red', 1024 },
random = { 'table-bg-pink', 4096 },
varies = { 'table-bg-pink', 4096 },
once = { 'table-bg-pink', 65536 },
conditional = { 'table-bg-pink', 65536 },
_default = { 'table-bg-grey', 65536 }
}
-- colour-code
local rarities_class = {
{ 1, 'table-bg-blue' },
{ 1/25, 'table-bg-green' },
{ 1/99.99, 'table-bg-yellow' },
{ 1/999.99, 'table-bg-orange' },
{ 1/9999999, 'table-bg-red' }
}
function get_rarity_class(val)
for i,v in ipairs(rarities_class) do
curr = v
if val >= v[1] then
break
end
end
return curr[2]
end
function commas(n)
if tonumber(n) then
return lang:formatNum(tonumber(n))
else
return n
end
end
function expr(t)
local noerr, val = pcall(mw.ext.ParserFunctions.expr, t)
if noerr then
return tonumber(val)
else
return false
end
end
function sigfig(n, f)
f = math.floor(f-1)
if n == 0 then return 0 end
local m = math.floor(math.log10(n))
f = math.max(m, f)
local v = n / (10^(m-f))
v = math.floor(v + 0.5) * 10^(m-f)
return v
end
p.sigfig = sigfig
p.commas = commas
function adjust_rarity(rarity_value, adjustment)
if not rarity_value or not tonumber(rarity_value) then return nil end
local adjusted_value = 1 / ((1 / rarity_value) * (1 - adjustment))
return adjusted_value
end
function p.main(frame)
local args = frame:getParent().args
local frameArgs = frame.args
-- Params and defaults
local name,namenotes,
quantity,quantitynotes,
rarity,alt_rarity,alt_rarity_endash,
raritynotes,citation,monVers = params.defaults{
{args.name or args.Name,'Item'},
{args.namenotes or args.Namenotes,''},
{args.quantity or args.Quantity,'Unknown'},
{args.quantitynotes or args.Quantitynotes,''},
{args.rarity or args.Rarity,'Unknown'},
{args.altrarity or args.AltRarity,''},
{args.altraritydash or args.AltRarityDash,''},
{args.raritynotes or args.Raritynotes,''},
{args.citation,''},
{args.version or args.Version,''},
}
raritynotes = raritynotes .. citation
local rolls = tonumber(args.rolls or args.Rolls) or false
local rollstext = ''
if rolls then
rollstext = rolls .. ' × '
end
local approx = yesno(args.approx or args.Approx or 'no', false)
local isCoins = name:lower() == 'coins'
local isNothing = name:lower() == 'nothing'
local altname = params.default_to(args.alt or args.Alt,name)
local gemwname = params.default_to(args.gemwname,name)
local _smwname = params.default_to(args.smwname,gemwname)
-- Clean name
local cleanedName, dropVers = name, ''
if _smwname:match(' ?%(%d%)$') then
cleanedName, dropVers = mw.ustring.match(gemwname, '^(.-) ?(%(%d%))$')
elseif _smwname:match(' ?%(p%+*%)$') then
cleanedName, dropVers = mw.ustring.match(_smwname, '^(.-) ?(%(p%+*%))$')
elseif _smwname:match('%#') then
cleanedName, dropVers = mw.ustring.match(_smwname, '^(.-)%#([%w%s%(%)]+)$')
else
cleanedName = mw.ustring.gsub(_smwname, ' %(%d%)$', '')
end
cleanedName = mw.text.trim(cleanedName)
dropVers = mw.text.trim(dropVers)
local smwname = cleanedName
if dropVers ~= '' then
smwname = cleanedName..'#'..dropVers
end
local useSmw = true
if params.has_content(args.smw) then
useSmw = args.smw:lower() ~= 'no'
end
if params.has_content(frameArgs.smw) then
useSmw = frameArgs.smw:lower() ~= 'no'
end
local rarity_value
if rarities[rarity:lower()] then
rarity = params.ucflc(rarity)
else
rarity_value = rarity:gsub(',','') --temp place to put this without overriding rarity
local rv1, rv2 = string.match(rarity_value, '([%d%.]+)/([%d%.]+)')
if rv1 and rv2 then
rarity = commas(rv1) .. '/' .. commas(rv2)
rarity_value = rv1/rv2
else
rarity_value = expr(rarity)
end
end
local alt_rarity_value
if rarities[alt_rarity:lower()] then
alt_rarity = params.ucflc(alt_rarity)
else
alt_rarity_value = alt_rarity:gsub(',','') --temp place to put this without overriding rarity
local rv1, rv2 = string.match(alt_rarity_value, '([%d%.]+)/([%d%.]+)')
if rv1 and rv2 then
alt_rarity = commas(rv1) .. '/' .. commas(rv2)
alt_rarity_value = rv1/rv2
else
alt_rarity_value = expr(alt_rarity)
end
end
quantity = mw.ustring.lower(quantity)
local gemw = yesno(args.gemw or 'yes', false)
local alch = yesno(args.alch or 'yes', false)
local cached_dropdata = droppeditem_data[smwname]
local cached_alch = nil
if type(cached_dropdata) == 'table' then
if cached_dropdata[1] ~= nil and cached_dropdata[2] ~= nil then
cached_alch = cached_dropdata[2]
elseif cached_dropdata[1] ~= nil then
cached_dropdata = cached_dropdata[1]
if type(cached_dropdata) == 'boolean' then
elseif type(cached_dropdata) == 'number' then
cached_alch = cached_dropdata
end
end
end
local geprice_frombulk = geprices_data[gemwname]
if not (type(geprice_frombulk) == 'number' and geprice_frombulk > 0) then
geprice_frombulk = nil
end
if cached_alch == nil then
cached_alch = highalch_data[gemwname]
if not (type(cached_alch) == 'number' and cached_alch > -1) then
cached_alch = nil
end
end
if isNothing then
gemw = false
elseif isCoins then
-- coins override
valueInfo = {
alch = {
has = true,
value = 1
},
ge = {
has = true,
value = 1
}
}
else
-- find alch price
if alch then
-- first check cache for alch value
if cached_alch ~= nil then
valueInfo.alch = {
has = true,
value = cached_alch
}
elseif gemw then
-- then check gemw for alch value
local hasgealch, gealchval = pcall(f_gealch,gemwname)
if hasgealch then
if gealchval > -1 then
valueInfo.alch = {
has = true,
value = tonumber(gealchval)
}
end
end
end
if not valueInfo.alch.has then
-- failed to find alch in GEMW or is on the no-ge list/override
-- lookup in SMW
if smwret and smwret.alch ~= nil then
-- alch is defined, use it
valueInfo.alch = {
has = true,
value = smwret.alch
}
else
alch = false
end
end
end
-- find ge price
if gemw then
if geprice_frombulk ~= nil then
valueInfo.ge = {
has = true,
value = geprice_frombulk
}
else
gemw = false
end
end
end
local image,image_n
if isCoins then
image_n = coins_image(quantity)
else
image_n = params.default_to(args.image or args.Image, name .. '.png')
image_n = mw.ustring.gsub(image_n, '#.+$', '.png')
end
if image_n:lower() == 'no' or params.is_empty(args.name or args.Name) then
image = ''
elseif isNothing then
image = '[[File:Bank filler.png|link=Nothing|alt=This does not exist.]]'
else
image = mw.ustring.format('[[File:%s|alt=%s: %s drops %s with rarity %s%s in quantity %s]]', image_n, name, image_n, title, name, rollstext, rarity, quantity)
end
local rdt = string.lower(args.rdt or '') == 'yes'
local ret = p._main(name,
altname,namenotes,
quantity,quantitynotes,
rarity,rarity_value,alt_rarity,alt_rarity_endash,alt_rarity_value,
raritynotes,image,
valueInfo,gemw,alch,alt,
isCoins,
isNothing,
frameArgs,monVers,
cleanedName,dropVers,smwname,
rdt,useSmw,
approx,rolls)
local cats = ''
local onMain = ns == '' or ns == 'RuneScape'
if onMain and useSmw then
cats = categories{name,quantity,rarity}
end
return ret..cats
end
function p._main(name,
altname,namenotes,
quantity,quantitynotes,
rarity,rarity_value,alt_rarity,alt_rarity_endash,alt_rarity_value,
raritynotes,image,
valueInfo,gemw,alch,alt,
isCoins,
isNothing,
frameArgs,monVers,
cleanedName,dropVers,smwname,
rdt,useSmw,
approx, rolls)
local total, alchtotal, vsort, vasort, _h, _l
quantity, _h, _l = qty(quantity, isNothing)
if valueInfo.ge.has then
total, vsort, totalavg = get_total(valueInfo.ge.value,_h,_l)
total = total or 'Not sold'
end
if type(vsort) ~= 'number' then
vsort = 0
end
if type(vasort) ~= 'number' then
vasort = 0
end
if #quantitynotes > 3 then
quantity = quantity..quantitynotes
end
local rare_class, rare_sort
if rarity_value == nil then
rare_class, rare_sort = unpack(rarities[rarity:lower()] or rarities._default)
elseif rarity_value == false then
rare_class, rare_sort = unpack(rarities._default)
else
rare_sort = 1/rarity_value
rare_class = get_rarity_class(rarity_value)
end
local rollstext = ''
if rolls then
rollstext = rolls .. ' × '
rare_sort = rare_sort / rolls
rare_class = get_rarity_class(math.min(1/rare_sort,0.99))
end
local tilde = ''
if approx then
tilde = '~'
end
local _r = rarity
local hasRowwideVersion = false
local tblVers = frameArgs.version
local versionKey = 'DEFAULT'
if params.has_content(tblVers) then
versionKey = tblVers
end
if params.has_content(monVers) then
versionKey = monVers
hasRowwideVersion = true
end
local quantityClassOverride = isNothing and 'table-na' or nil
local ret = mw.html.create('tr')
:css('text-align','center')
:tag('td')
:addClass('inventory-image')
:wikitext(image)
:done()
:tag('td')
:css('text-align','left')
:addClass('item-col')
:wikitext(string.format('%s',name,altname,#namenotes > 3 and namenotes or ''))
:done()
:tag('td')
:addClass(quantityClassOverride)
:attr('data-sort-value',_h)
:wikitext(quantity)
:done()
local rarity_cell = ret:tag('td')
local rarity_span = rarity_cell:tag('span')
rarity_span:wikitext(rollstext .. tilde .. rarity)
rarity_cell:attr('data-sort-value',rare_sort)
:addClass(rare_class)
if type(rarity_value) == 'number' then
rarity_cell:attr('title', rollstext .. tilde .. string.format('%.3g%%', 100 * rarity_value))
rarity_span:attr({
['data-drop-fraction'] = rollstext .. tilde .. rarity,
['data-drop-oneover'] = rollstext .. tilde .. '1/' .. commas(sigfig(1/rarity_value, 4)),
['data-drop-percent'] = rollstext .. tilde .. sigfig(100 * rarity_value, 3),
['data-drop-permil'] = rollstext .. tilde .. sigfig(1000 * rarity_value, 3),
['data-drop-permyriad'] = rollstext .. tilde .. sigfig(10000 * rarity_value, 3),
})
end
-- Adjusted rarity for donator ranks
local adjustments = {
['Normal Donator'] = 0.15,
['Super Donator'] = 0.25,
['Extreme Donator'] = 0.30,
['Legendary Donator'] = 0.35,
['Royal Donator'] = 0.40
}
for rank, adjustment in pairs(adjustments) do
local adjusted_rarity = adjust_rarity(rarity_value, adjustment)
local adjusted_rarity_text = adjusted_rarity and string.format('1/%.0f', 1/adjusted_rarity) or 'N/A'
ret:tag('td')
:addClass(rare_class)
:wikitext(adjusted_rarity_text)
end
if #raritynotes > 3 then
rarity_cell:wikitext(raritynotes)
end
local ge_td = ret:tag('td')
local ge_td_title, ge_td_content, alch_td_title, alch_td_content
if isNothing then
ge_td_content = 'N/A'
ge_td_title = 'This does not exist.'
ge_td:addClass('table-na'):css('text-decoration', 'underline dotted')
alch_td_content = 'N/A'
alch_td_title = 'This does not exist.'
alch_td:addClass('table-na'):css('text-decoration', 'underline dotted')
elseif isCoins then
local coinsStr = lang:plural(vsort, '', 's')
ge_td_title = mw.ustring.format(coins_priceString, total, coinsStr)
ge_td_content = total
alch_td_title = mw.ustring.format(coins_priceString, total, coinsStr)
alch_td_content = total
else
if valueInfo.ge.has then
ge_td_title = mw.ustring.format(other_priceString, commas(valueInfo.ge.value), lang:plural(valueInfo.ge.value, '', 's'))
ge_td_content = total
end
if valueInfo.alch.has then
alch_td_title = mw.ustring.format(other_priceString, commas(valueInfo.alch.value), lang:plural(valueInfo.alch.value, '', 's'))
alch_td_content = alchtotal
end
if ge_td_content == nil then
ge_td_content = 'Not sold'
ge_td_title = 'This item cannot be traded on the Grand Exchange.'
ge_td:addClass('table-na'):css('text-decoration', 'underline dotted')
end
end
ge_td:wikitext(ge_td_content):attr('title', ge_td_title)
local onMain = ns == '' or ns == 'RuneScape'
local unrecognizedDropVersionCategory = ''
if onMain and useSmw and isNothing ~= true then
-- SMW data omitted for brevity
end
return tostring(ret) .. unrecognizedDropVersionCategory
end
function qty(quantity, isNothing)
-- Quantity parsing function omitted for brevity
end
function get_total(value, qhigh, qlow)
-- Value calculation function omitted for brevity
end
function categories(...)
-- Category function omitted for brevity
end
return p