Difference between revisions of "Module:Spell"

From CrawlWiki
Jump to: navigation, search
m (Better section titles when grouping by level.)
(Add tables sorted by book or flag. Don't link to school if grouping by one.)
Line 1: Line 1:
 
local p = {}
 
local p = {}
 
local data = mw.loadData('Module: Table of spells')
 
local data = mw.loadData('Module: Table of spells')
local spell_names = {}
 
for k in pairs(data) do
 
  table.insert(spell_names, k)
 
end
 
table.sort(spell_names)
 
  
 
local function table_has_value(t, v)
 
local function table_has_value(t, v)
   for _,x in pairs(t) do if x == v then return true end end
+
   if t ~= nil then
 +
    for _,x in pairs(t) do if x == v then return true end end
 +
  end
 
   return false
 
   return false
 +
end
 +
 +
local function table_keys_sorted(t)
 +
  local keys = {}
 +
  for k in pairs(t) do
 +
    table.insert(keys, k)
 +
  end
 +
  table.sort(keys)
 +
  return keys
 +
end
 +
 +
local function names_by_level()
 +
  local names = table_keys_sorted(data)
 +
  table.sort(names, function(a, b)
 +
    if data[a].level == data[b].level then
 +
      return a < b
 +
    else
 +
      return data[a].level < data[b].level
 +
    end
 +
  end)
 +
  return names
 
end
 
end
  
Line 53: Line 71:
 
end
 
end
  
local function format_schools(schools)
+
local function format_schools(schools, no_link_for)
 
   local ret = ''
 
   local ret = ''
   for _,school in pairs(schools) do
+
   for _,school in ipairs(schools) do
     ret = ret .. spell_school_link(school) .. '/'
+
     if school == no_link_for then
 +
      ret = ret .. school .. '/'
 +
    else
 +
      ret = ret .. spell_school_link(school) .. '/'
 +
    end
 
   end
 
   end
 
   return ret:sub(1, -2)
 
   return ret:sub(1, -2)
Line 90: Line 112:
 
end
 
end
  
local function spell_table_line(name, info)
+
local function spell_table_line(name, info, no_link_for)
 
   return '|[[File:' .. name:lower() .. '.png]]\n' ..
 
   return '|[[File:' .. name:lower() .. '.png]]\n' ..
 
         '|style="padding-left:1em"|[[' .. name .. ']]\n' ..
 
         '|style="padding-left:1em"|[[' .. name .. ']]\n' ..
         '|' .. format_schools(info['schools']) .. '\n' ..
+
         '|' .. format_schools(info['schools'], no_link_for) .. '\n' ..
 
         '|' .. info['level'] .. '\n' ..
 
         '|' .. info['level'] .. '\n' ..
 
         '|' .. info['cap'] .. '\n' ..
 
         '|' .. info['cap'] .. '\n' ..
Line 108: Line 130:
 
   local ret = '==Spells==\n' .. spell_table_header()
 
   local ret = '==Spells==\n' .. spell_table_header()
 
   local c = nil
 
   local c = nil
   for _, name in ipairs(spell_names) do
+
   for _, name in ipairs(table_keys_sorted(data)) do
 
       if name:sub(1, 1) ~= c then
 
       if name:sub(1, 1) ~= c then
 
         c = name:sub(1, 1)
 
         c = name:sub(1, 1)
Line 120: Line 142:
 
function p.spell_table_by_level(frame)
 
function p.spell_table_by_level(frame)
 
   local school = frame.args[1]
 
   local school = frame.args[1]
   if school == "" then
+
   if school == '' then
 
     school = nil
 
     school = nil
 
   end
 
   end
Line 126: Line 148:
 
   for level=1,9 do
 
   for level=1,9 do
 
     local found = false
 
     local found = false
     for _, name in ipairs(spell_names) do if data[name]["level"] == level then
+
     for _, name in ipairs(table_keys_sorted(data)) do
      if school == nil or table_has_value(data[name]['schools'], school) then
+
      if data[name]['level'] == level then
        if not found then
+
        if school == nil or table_has_value(data[name]['schools'], school) then
          found = true
+
          if not found then
          ret = ret .. spell_table_section('Level ' .. level)
+
            found = true
 +
            ret = ret .. spell_table_section('Level ' .. level)
 +
          end
 +
          ret = ret .. spell_table_line(name, data[name], school)
 
         end
 
         end
        ret = ret .. spell_table_line(name, data[name])
 
 
       end
 
       end
     end end
+
     end
 
   end
 
   end
 
   return ret .. '|}\n'
 
   return ret .. '|}\n'
Line 140: Line 164:
  
 
function p.spell_table_by_school(frame)
 
function p.spell_table_by_school(frame)
  table.sort(spell_names, function(a, b)
 
    if data[a].level == data[b].level then
 
      return a < b
 
    else
 
      return data[a].level < data[b].level
 
    end
 
  end)
 
 
   local schools = { 'Air', 'Charms', 'Conjuration', 'Earth', 'Fire', 'Hexes',
 
   local schools = { 'Air', 'Charms', 'Conjuration', 'Earth', 'Fire', 'Hexes',
 
     'Ice', 'Necromancy', 'Poison', 'Summoning', 'Translocation',
 
     'Ice', 'Necromancy', 'Poison', 'Summoning', 'Translocation',
Line 152: Line 169:
  
 
   local ret = '==Spells==\n' .. spell_table_header()
 
   local ret = '==Spells==\n' .. spell_table_header()
   for _,school in pairs(schools) do
+
   for _,school in ipairs(schools) do
 
     ret = ret .. spell_table_section(school)
 
     ret = ret .. spell_table_section(school)
     for _, name in ipairs(spell_names) do
+
     for _, name in ipairs(names_by_level(data)) do
 
       if table_has_value(data[name]['schools'], school) then
 
       if table_has_value(data[name]['schools'], school) then
 +
        ret = ret .. spell_table_line(name, data[name], school)
 +
      end
 +
    end
 +
  end
 +
  return ret .. '|}\n'
 +
end
 +
 +
function p.spell_table_by_book(frame)
 +
  local books = {}
 +
  for _,spell in pairs(data) do if spell['books'] ~= nil then
 +
    for _,book in pairs(spell['books']) do
 +
      books[book] = true
 +
    end
 +
  end end
 +
 +
  local ret = '==Spells==\n' .. spell_table_header()
 +
  for _,book in ipairs(table_keys_sorted(books)) do
 +
    ret = ret .. spell_table_section('[[' .. book .. ']]')
 +
    for _, name in ipairs(names_by_level(data)) do
 +
      if table_has_value(data[name]['books'], book) then
 +
        ret = ret .. spell_table_line(name, data[name])
 +
      end
 +
    end
 +
  end
 +
  return ret .. '|}\n'
 +
end
 +
 +
function p.spell_table_by_flag(frame)
 +
  local flags = {}
 +
  for _,spell in pairs(data) do if spell['flags'] ~= nil then
 +
    for _,flag in pairs(spell['flags']) do
 +
      flags[flag] = true
 +
    end
 +
  end end
 +
 +
  local ret = '==Spells==\n' .. spell_table_header()
 +
 +
  ret = ret .. spell_table_section('No flags')
 +
  for _, name in ipairs(names_by_level(data)) do
 +
    if data[name]['flags'] == nil then
 +
      ret = ret .. spell_table_line(name, data[name])
 +
    end
 +
  end
 +
 +
  for _,flag in ipairs(table_keys_sorted(flags)) do
 +
    ret = ret .. spell_table_section(flag) ..
 +
      '| colspan=9 |' ..
 +
      frame:expandTemplate{title = 'SpellFlagDesc ' .. flag, args = {}} ..
 +
      '\n|----\n'
 +
    for _, name in ipairs(names_by_level(data)) do
 +
      if table_has_value(data[name]['flags'], flag) then
 
         ret = ret .. spell_table_line(name, data[name])
 
         ret = ret .. spell_table_line(name, data[name])
 
       end
 
       end

Revision as of 16:30, 30 January 2016

This module generates the spell tables.

Requires: Module:Table of spells


local p = {}
local data = mw.loadData('Module: Table of spells')

local function table_has_value(t, v)
  if t ~= nil then
    for _,x in pairs(t) do if x == v then return true end end
  end
  return false
end

local function table_keys_sorted(t)
  local keys = {}
  for k in pairs(t) do
    table.insert(keys, k)
  end
  table.sort(keys)
  return keys
end

local function names_by_level()
  local names = table_keys_sorted(data)
  table.sort(names, function(a, b)
    if data[a].level == data[b].level then
      return a < b
    else
      return data[a].level < data[b].level
    end
  end)
  return names
end

local function spell_table_header()
  return [=[{| class="prettytable"
!|Icon
!|Name
!|Schools
!|Level
!|Power<br>cap
!|Range
!|Noise
!|Flags
!|Books
|----
]=]
end

local function spell_table_section(heading)
  return '! colspan=9 style="text-align:left"|\n' ..
         '====' .. heading .. '====\n' ..
         '|----\n'
end

local function spell_school_link(school)
  local skill = nil
  if school == 'Poison' or school == 'Air' or school == 'Fire' or
     school == 'Ice' or school == 'Earth' then
    skill = school .. ' Magic'
  elseif school:sub(-1) ~= 'y' and school:sub(-1) ~= 's' then
      -- "Necromancy" isn't pluralised as a skill,
      -- and "Hexes" and "Charms" are already
      -- pluralized as a magic school.  The others
      -- are singular as a school, plural as a skill.
      skill = school .. 's'
  end

  if skill ~= nil then
    return '[[' .. skill .. '|' .. school .. ']]'
  else
    return '[[' .. school .. ']]'
  end
end

local function format_schools(schools, no_link_for)
  local ret = ''
  for _,school in ipairs(schools) do
    if school == no_link_for then
      ret = ret .. school .. '/'
    else
      ret = ret .. spell_school_link(school) .. '/'
    end
  end
  return ret:sub(1, -2)
end

local function format_range(range)
  if range == nil then
    return ''
  elseif type(range) == 'table' then
    return range[1] .. '-' .. range[2]
  else
    return range
  end
end

local function format_flags(flags)
  if flags == nil then
    return ''
  end
  local ret = ''
  for _,flag in ipairs(flags) do
    ret = ret .. flag .. ', '
  end
  return ret:sub(1, -3)
end

local function format_books(books)
  local ret = ''
  for _,book in ipairs(books) do
    ret = ret .. '[[' .. book .. ']]<br>'
  end
  return ret:sub(1, -5)
end

local function spell_table_line(name, info, no_link_for)
  return '|[[File:' .. name:lower() .. '.png]]\n' ..
         '|style="padding-left:1em"|[[' .. name .. ']]\n' ..
         '|' .. format_schools(info['schools'], no_link_for) .. '\n' ..
         '|' .. info['level'] .. '\n' ..
         '|' .. info['cap'] .. '\n' ..
         '|' .. format_range(info['range']) .. '\n' ..
         '|' .. info['noise'] .. '\n' ..
         '|' .. format_flags(info['flags']) .. '\n' ..
         '|' .. format_books(info['books']) .. '\n' ..
         '|----\n'
end

function p.spell_table(frame)
  local alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

  local ret = '==Spells==\n' .. spell_table_header()
  local c = nil
  for _, name in ipairs(table_keys_sorted(data)) do
      if name:sub(1, 1) ~= c then
        c = name:sub(1, 1)
        ret = ret .. spell_table_section(c)
      end
      ret = ret .. spell_table_line(name, data[name])
  end
  return ret .. '|}\n'
end

function p.spell_table_by_level(frame)
  local school = frame.args[1]
  if school == '' then
    school = nil
  end
  local ret = '==Spells==\n' .. spell_table_header()
  for level=1,9 do
    local found = false
    for _, name in ipairs(table_keys_sorted(data)) do
      if data[name]['level'] == level then
        if school == nil or table_has_value(data[name]['schools'], school) then
          if not found then
            found = true
            ret = ret .. spell_table_section('Level ' .. level)
          end
          ret = ret .. spell_table_line(name, data[name], school)
        end
      end
    end
  end
  return ret .. '|}\n'
end

function p.spell_table_by_school(frame)
  local schools = { 'Air', 'Charms', 'Conjuration', 'Earth', 'Fire', 'Hexes',
    'Ice', 'Necromancy', 'Poison', 'Summoning', 'Translocation',
    'Transmutation' }

  local ret = '==Spells==\n' .. spell_table_header()
  for _,school in ipairs(schools) do
    ret = ret .. spell_table_section(school)
    for _, name in ipairs(names_by_level(data)) do
      if table_has_value(data[name]['schools'], school) then
        ret = ret .. spell_table_line(name, data[name], school)
      end
    end
  end
  return ret .. '|}\n'
end

function p.spell_table_by_book(frame)
  local books = {}
  for _,spell in pairs(data) do if spell['books'] ~= nil then
    for _,book in pairs(spell['books']) do
      books[book] = true
    end
  end end

  local ret = '==Spells==\n' .. spell_table_header()
  for _,book in ipairs(table_keys_sorted(books)) do
    ret = ret .. spell_table_section('[[' .. book .. ']]')
    for _, name in ipairs(names_by_level(data)) do
      if table_has_value(data[name]['books'], book) then
        ret = ret .. spell_table_line(name, data[name])
      end
    end
  end
  return ret .. '|}\n'
end

function p.spell_table_by_flag(frame)
  local flags = {}
  for _,spell in pairs(data) do if spell['flags'] ~= nil then
    for _,flag in pairs(spell['flags']) do
      flags[flag] = true
    end
  end end

  local ret = '==Spells==\n' .. spell_table_header()

  ret = ret .. spell_table_section('No flags')
  for _, name in ipairs(names_by_level(data)) do
    if data[name]['flags'] == nil then
      ret = ret .. spell_table_line(name, data[name])
    end
  end

  for _,flag in ipairs(table_keys_sorted(flags)) do
    ret = ret .. spell_table_section(flag) ..
      '| colspan=9 |' ..
      frame:expandTemplate{title = 'SpellFlagDesc ' .. flag, args = {}} ..
      '\n|----\n'
    for _, name in ipairs(names_by_level(data)) do
      if table_has_value(data[name]['flags'], flag) then
        ret = ret .. spell_table_line(name, data[name])
      end
    end
  end
  return ret .. '|}\n'
end

return p