Module:Magic: Difference between revisions

4,205 bytes added ,  7 December 2020
Added pieces necessary for building Template:SpellBox
(Added ability to get all spells for a given rune.)
(Added pieces necessary for building Template:SpellBox)
Line 3: Line 3:
local MagicData = mw.loadData('Module:Magic/data')
local MagicData = mw.loadData('Module:Magic/data')


local Areas = require('Module:CombatAreas')
local Shared = require('Module:Shared')
local Shared = require('Module:Shared')
local Icons = require('Module:Icons')
local Icons = require('Module:Icons')
local Items = require('Module:Items')


function processSpell(section, index)
function processSpell(section, index)
Line 15: Line 17:
function p.getSpell(name, type)
function p.getSpell(name, type)
   local section = type
   local section = type
   if type == nil or type == 'Spell' or type == 'Standard' then
   if type == 'Spell' or type == 'Standard' then
     section = 'Spells'
     section = 'Spells'
   elseif type == 'Curse' then
   elseif type == 'Curse' then
Line 25: Line 27:
   end
   end
    
    
   if MagicData[section] ~= nil then
   if section == nil then
    local result = nil
    for i, section in Shared.skpairs(MagicData) do
     for i, spell in pairs(MagicData[section]) do
      for j, spell in Shared.skpairs(section) do
        if spell.name == name then
          return processSpell(i, j)
        end
      end
    end
  elseif section ~= nil and MagicData[section] ~= nil then
     for i, spell in Shared.skpairs(MagicData[section]) do
       if spell.name == name then
       if spell.name == name then
         result = processSpell(section, i)
         return processSpell(section, i)
       end
       end
     end
     end
    return result
   else
   else
     return nil
     return nil
Line 55: Line 63:
     return nil
     return nil
   end
   end
end
function p.getTypeString(type)
  if type == 'Auroras' then
    return 'Aurora'
  elseif type == 'Curses' then
    return 'Curse'
  elseif type == 'AltMagic' then
    return 'Alt. Magic'
  elseif type == 'Spells' then
    return "Combat Spell"
  elseif type == 'Ancient' then
    return 'Ancient Magick'
  end
end
function p._getSpellIcon(spell, size)
  if size == nil then size = 50 end
  if spell.type == 'Auroras' then
    return Icons.Icon({spell.name, type='aurora', notext=true, size=size})
  elseif spell.type == 'Curses' then
    return Icons.Icon({spell.name, type='curse', notext=true, size=size})
  else
    return Icons.Icon({spell.name, type='spell', notext=true, size=size})
  end
end
function p._getSpellRequirements(spell)
  local result = ''
  result = result..Icons._SkillReq('Magic', spell.magicLevelRequired)
  if spell.requiredItem ~= nil and spell.requiredItem >= 0 then
    local reqItem = Items.getItemByID(spell.requiredItem)
    result = result..'<br/>'..Icons.Icon({reqItem.name, type='item', notext=true})..' equipped'
  end
  if spell.requiredDungeonCompletion ~= nil then
    local dung = Areas.getAreaByID('dungeon', spell.requiredDungeonCompletion[1])
    result = result..'<br/>'..Icons.Icon({dung.name, type='dungeon', notext=true, qty=spell.requiredDungeonCompletion[2]})..' Clears'
  end
  return result
end
function p._getSpellRunes(spell)
  local result = ''
  for i, req in Shared.skpairs(spell.runesRequired) do
    local rune = Items.getItemByID(req.id)
    if i > 1 then result = result..', ' end
    result = result..Icons.Icon({rune.name, type='item', notext=true, qty=req.qty})
  end
  if spell.runesRequiredAlt ~= nil then
    result = result.."<br/>'''OR'''<br/>"
    for i, req in pairs(spell.runesRequiredAlt) do
      local rune = Items.getItemByID(req.id)
      if i > 1 then result = result..', ' end
      result = result..Icons.Icon({rune.name, type='item', notext=true, qty=req.qty})
    end
  end
  return result
end
function p.getSpellRunes(frame)
  local spellName = frame.args ~= nil and frame.args[1] or frame
  local spell = p.getSpell(spellName)
  if spell == nil then
    return "ERROR: No spell named "..spellName.." exists in the data module"
  end
  return p._getSpellRunes(spell)
end
function p._getSpellStat(spell, stat)
  if stat == 'bigIcon' then
    return p._getSpellIcon(spell, 250)
  elseif stat == 'icon' then
    return p._getSpellIcon(spell)
  elseif stat == 'requirements' then
    return p._getSpellRequirements(spell)
  elseif stat == 'runes' then
    return p._getSpellRunes(spell)
  elseif stat == 'type' then
    return p.getTypeString(spell.type)
  end
  return spell[stat]
end
function p.getSpellStat(frame)
  local spellName = frame.args ~= nil and frame.args[1] or frame[1]
  local statName = frame.args ~= nil and frame.args[2] or frame[2]
  local spell = p.getSpell(spellName)
  if spell == nil then
    return "ERROR: No spell named "..spellName.." found"
  end
  return p._getSpellStat(spell, statName)
end
function p.getOtherSpellBoxText(frame)
  local spellName = frame.args ~= nil and frame.args[1] or frame
  local spell = p.getSpell(spellName)
  if spell == nil then
    return "ERROR: No spell named "..spellName.." found"
  end
  local result = ''
  if spell.type == 'Spells' then
    result = result..'|-\r\n|Max Hit: '..(spell.maxHit * 10)
  end
  if spell.description ~= nil then
    result = result..'\r\n|-\r\n|Description:<br/>'..spell.description
  end
  return result
end
function p._getSpellCategories(spell)
  local result = '[[Category:Spells]]'
  result = result..'[[Category:'..p.getTypeString(spell.type)..']]'
  return result
end
function p.getSpellCategories(frame)
  local spellName = frame.args ~= nil and frame.args[1] or frame
  local spell = p.getSpell(spellName)
  if spell == nil then
    return "ERROR: No spell named "..spellName.." found"
  end
  return p._getSpellCategories(spell)
end
end