Difference between revisions of "Module:Spell"

From CrawlWiki
Jump to: navigation, search
m (Use page title if no arg with spell info.)
m (Lua syntax)
 
(14 intermediate revisions by 5 users not shown)
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 RANGE_LOS = 7
  
−
local function table_keys_sorted(t)
+
local function table_keys_sorted(t, f)
 
   local keys = {}
 
   local keys = {}
 
   for k in pairs(t) do
 
   for k in pairs(t) do
 
     table.insert(keys, k)
 
     table.insert(keys, k)
 
   end
 
   end
−
   table.sort(keys)
+
   table.sort(keys, f)
 
   return keys
 
   return keys
 +
end
 +
 +
local function empty_table(t)
 +
  for _ in pairs(t) do
 +
    return false
 +
  end
 +
  return true
 
end
 
end
  
Line 44: Line 52:
 
end
 
end
  
−
local function spell_school_link(school)
+
local function format_schools(frame, schools, no_link_for)
−
  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 = ''
 
   local ret = ''
−
   for school in pairs(schools) do
+
   for _, school in ipairs(table_keys_sorted(schools)) do
 
     if school == no_link_for then
 
     if school == no_link_for then
 
       ret = ret .. school .. '/'
 
       ret = ret .. school .. '/'
 
     else
 
     else
−
       ret = ret .. spell_school_link(school) .. '/'
+
       ret = ret ..
 +
        frame:expandTemplate{title = 'schoollink', args = {school}} .. '/'
 
     end
 
     end
 
   end
 
   end
Line 80: Line 69:
 
     return ''
 
     return ''
 
   elseif range.min == range.max then
 
   elseif range.min == range.max then
−
     return range.min
+
     if range.min == RANGE_LOS then
 +
      return 'LOS'
 +
    else
 +
      return range.min
 +
    end
 
   else
 
   else
 
     return range.min .. '-' .. range.max
 
     return range.min .. '-' .. range.max
Line 90: Line 83:
 
     return ''
 
     return ''
 
   else
 
   else
−
     return math.max(noise.casting, noise.effect)
+
     return math.max(string.match(noise.casting, "%d+"), string.match(noise.effect, "%d+"))
 
   end
 
   end
 
end
 
end
  
 
local function format_flag(flag)
 
local function format_flag(flag)
−
   if flag == 'MR_CHECK' then
+
   if flag:upper() == 'WL_CHECK' then
−
     return 'MR check'
+
     return 'Will check'
 
   else
 
   else
 
     return flag:gsub('_', ' '):lower():gsub('^%l', string.upper)
 
     return flag:gsub('_', ' '):lower():gsub('^%l', string.upper)
Line 102: Line 95:
 
end
 
end
  
−
local function format_flags(flags)
+
local function format_flags(flags, ignored)
 
   if flags == nil then
 
   if flags == nil then
 
     return ''
 
     return ''
 
   end
 
   end
 
   local ret = ''
 
   local ret = ''
−
   for flag in pairs(flags) do
+
   for _, flag in ipairs(table_keys_sorted(flags)) do
−
     ret = ret .. format_flag(flag) .. ', '
+
     if not ignored or not ignored[flag] then
 +
      ret = ret .. format_flag(flag) .. ', '
 +
    end
 
   end
 
   end
 
   return ret:sub(1, -3)
 
   return ret:sub(1, -3)
 +
end
 +
 +
local function compare_books(a, b)
 +
  return a:lower():gsub('^book of ', ''):gsub('^a ', ''):gsub('^the ', '') <
 +
    b:lower():gsub('^book of ', ''):gsub('^a ', ''):gsub('^the ', '')
 
end
 
end
  
 
local function format_books(books)
 
local function format_books(books)
 
   local ret = ''
 
   local ret = ''
−
   for book in pairs(books) do
+
   for _, book in ipairs(table_keys_sorted(books, compare_books)) do
−
     ret = ret .. '[[' .. book .. ']]<br>'
+
     ret = ret .. '[[' .. book:gsub('^%l', string.upper) .. ']]<br>'
 
   end
 
   end
 
   return ret:sub(1, -5)
 
   return ret:sub(1, -5)
 
end
 
end
  
−
local function spell_table_line(name, info, no_link_for)
+
local function spell_table_line(frame, 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'], no_link_for) .. '\n' ..
+
         '|' .. format_schools(frame, info['schools'], no_link_for) .. '\n' ..
 
         '|' .. info['level'] .. '\n' ..
 
         '|' .. info['level'] .. '\n' ..
−
         '|' .. info['power cap'] .. '\n' ..
+
         '|' .. (info['power cap'] == 0 and 'N/A' or info['power cap']) ..
 +
        '\n' ..
 
         '|' .. format_range(info['range']) .. '\n' ..
 
         '|' .. format_range(info['range']) .. '\n' ..
 
         '|' .. format_noise(info['noise']) .. '\n' ..
 
         '|' .. format_noise(info['noise']) .. '\n' ..
Line 144: Line 145:
 
       ret = ret .. spell_table_section(c)
 
       ret = ret .. spell_table_section(c)
 
     end
 
     end
−
     ret = ret .. spell_table_line(name, data[name])
+
     ret = ret .. spell_table_line(frame, name, data[name])
 
   end
 
   end
 
   return ret .. '|}'
 
   return ret .. '|}'
Line 164: Line 165:
 
             ret = ret .. spell_table_section('Level ' .. level)
 
             ret = ret .. spell_table_section('Level ' .. level)
 
           end
 
           end
−
           ret = ret .. spell_table_line(name, data[name], school)
+
           ret = ret .. spell_table_line(frame, name, data[name], school)
 
         end
 
         end
 
       end
 
       end
Line 173: Line 174:
  
 
function p.spell_table_by_school(frame)
 
function p.spell_table_by_school(frame)
−
   local schools = { 'Air', 'Charms', 'Conjuration', 'Earth', 'Fire', 'Hexes',
+
   local schools = {}
−
     'Ice', 'Necromancy', 'Poison', 'Summoning', 'Translocation',
+
  for _,spell in pairs(data) do
−
     'Transmutation' }
+
     for school in pairs(spell['schools']) do
 +
      schools[school] = true
 +
     end
 +
  end
  
 
   local ret = '==Spells==\n' .. spell_table_header()
 
   local ret = '==Spells==\n' .. spell_table_header()
−
   for _,school in ipairs(schools) do
+
   for _,school in ipairs(table_keys_sorted(schools)) do
−
     ret = ret .. spell_table_section(spell_school_link(school))
+
     ret = ret .. spell_table_section(
 +
      frame:expandTemplate{title = 'schoollink', args = {school}})
 
     for _, name in ipairs(names_by_level(data)) do
 
     for _, name in ipairs(names_by_level(data)) do
 
       if data[name]['schools'][school] then
 
       if data[name]['schools'][school] then
−
         ret = ret .. spell_table_line(name, data[name], school)
+
         ret = ret .. spell_table_line(frame, name, data[name], school)
 
       end
 
       end
 
     end
 
     end
Line 198: Line 203:
  
 
   local ret = '==Spells==\n' .. spell_table_header()
 
   local ret = '==Spells==\n' .. spell_table_header()
−
   for _,book in ipairs(table_keys_sorted(books)) do
+
   for _,book in ipairs(table_keys_sorted(books, compare_books)) do
−
     ret = ret .. spell_table_section('[[' .. book .. ']]')
+
     ret = ret ..
 +
      spell_table_section('[[' .. book:gsub('^%l', string.upper) .. ']]')
 
     for _, name in ipairs(names_by_level(data)) do
 
     for _, name in ipairs(names_by_level(data)) do
 
       if data[name]['books'][book] then
 
       if data[name]['books'][book] then
−
         ret = ret .. spell_table_line(name, data[name])
+
         ret = ret .. spell_table_line(frame, name, data[name])
 
       end
 
       end
 
     end
 
     end
Line 221: Line 227:
 
   ret = ret .. spell_table_section('No flags')
 
   ret = ret .. spell_table_section('No flags')
 
   for _, name in ipairs(names_by_level(data)) do
 
   for _, name in ipairs(names_by_level(data)) do
−
     if next(data[name]['flags']) == nil then
+
     if empty_table(data[name]['flags']) then
−
       ret = ret .. spell_table_line(name, data[name])
+
       ret = ret .. spell_table_line(frame, name, data[name])
 
     end
 
     end
 
   end
 
   end
  
−
   for _,flag in ipairs(table_keys_sorted(flags)) do
+
   for _, flag in ipairs(table_keys_sorted(flags)) do
 
     ret = ret .. spell_table_section(format_flag(flag)) ..
 
     ret = ret .. spell_table_section(format_flag(flag)) ..
 
       '| colspan=9 |' ..
 
       '| colspan=9 |' ..
Line 234: Line 240:
 
     for _, name in ipairs(names_by_level(data)) do
 
     for _, name in ipairs(names_by_level(data)) do
 
       if data[name]['flags'][flag] then
 
       if data[name]['flags'][flag] then
−
         ret = ret .. spell_table_line(name, data[name])
+
         ret = ret .. spell_table_line(frame, name, data[name])
 
       end
 
       end
 
     end
 
     end
 
   end
 
   end
 
   return ret .. '|}'
 
   return ret .. '|}'
 +
end
 +
 +
local function format_hated_by(spell)
 +
  local output = ''
 +
  if spell.flags.HASTY then
 +
    output = output .. '[[Cheibriados]][[Category:Hasty Spells]]<br>'
 +
  end
 +
  if spell.flags.UNHOLY or spell.schools.Necromancy then
 +
    output = output .. '[[Elyvilon]]<br>'
 +
  end
 +
  if spell.flags.UNHOLY or spell.schools.Necromancy then
 +
    output = output .. '[[The Shining One]]<br>'
 +
  end
 +
  if spell.flags.CHAOTIC or spell.flags.UNCLEAN or spell.flags.UNHOLY or
 +
    spell.schools.Necromancy then
 +
    output = output .. '[[Zin]]'
 +
    if spell.flags.UNCLEAN then
 +
      output = output .. '[[Category:Unclean Spells]]'
 +
    end
 +
    if spell.flags.CHAOTIC then
 +
      output = output .. '[[Category:Chaotic Spells]]'
 +
    end
 +
    if spell.flags.UNHOLY then
 +
      output = output .. '[[Category:Evil Spells]]'
 +
    end
 +
    output = output .. '<br>'
 +
  end
 +
  return output:sub(1, -5)
 +
end
 +
 +
local function format_targetting(flags)
 +
  local style = nil
 +
  if flags.DIR then
 +
    style = 'Direction'
 +
  elseif flags.DIR_OR_TARGET then
 +
    style = 'Target or direction'
 +
  elseif flags.TARGET then
 +
    style = 'Smite'
 +
  end
 +
  if style then
 +
    if flags.OBJ and flags.NOT_SELF then
 +
      return style .. ' (object, not self)'
 +
    elseif flags.OBJ then
 +
      return style .. ' (object)'
 +
    elseif flags.NOT_SELF then
 +
      return style .. ' (not self)'
 +
    end
 +
  end
 +
  return style
 
end
 
end
  
 
function p.spell_info(frame)
 
function p.spell_info(frame)
 
   local name = frame.args[1]
 
   local name = frame.args[1]
−
   if not name or name == "" then
+
   if not name or name == '' then
 
     name = mw.title.getCurrentTitle().text
 
     name = mw.title.getCurrentTitle().text
 
   end
 
   end
Line 254: Line 309:
 
   args.name = spell.name
 
   args.name = spell.name
 
   args.level = spell.level
 
   args.level = spell.level
−
  args.school1 = ''
 
−
  args.school2 = ''
 
−
  args.school3 = ''
 
 
   for i,school in ipairs(table_keys_sorted(spell.schools)) do
 
   for i,school in ipairs(table_keys_sorted(spell.schools)) do
−
     args["school" .. i] = spell_school_link(school)
+
     args['school' .. i] =
 +
      frame:expandTemplate{title = 'schoollink', args = {school}} ..
 +
      '[[Category:' .. school .. ' Spells]]'
 
     i = i + 1
 
     i = i + 1
 
   end
 
   end
Line 264: Line 318:
 
   args.castingnoise = spell.noise.casting
 
   args.castingnoise = spell.noise.casting
 
   args.spellnoise = spell.noise.effect
 
   args.spellnoise = spell.noise.effect
 +
  args['power cap'] = spell['power cap'] == 0 and 'N/A' or spell['power cap']
 +
  args['summons limit'] = spell['summons limit']
 +
  args.targetting = format_targetting(spell.flags)
 +
  args.range = format_range(spell.range)
 +
  args['hated by'] = format_hated_by(spell)
 +
  args.flags = format_flags(spell.flags, {
 +
    CHAOTIC = true,
 +
    CORPSE_VIOLATING = true,
 +
    DIR = true,
 +
    DIR_OR_TARGET = true,
 +
    HASTY = true,
 +
    MONS_ABJURE = true,
 +
    NEEDS_TRACER = true,
 +
    NOT_SELF = true,
 +
    OBJ = true,
 +
    TARGET = true,
 +
    UNCLEAN = true,
 +
    UNHOLY = true,
 +
  })
  
 
   local infobox = frame:expandTemplate{title = 'spell', args = args}
 
   local infobox = frame:expandTemplate{title = 'spell', args = args}

Latest revision as of 19:37, 11 May 2025

This module generates the spell tables.

Requires: Module:Table of spells 

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

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

local function empty_table(t)
  for _ in pairs(t) do
    return false
  end
  return true
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 format_schools(frame, schools, no_link_for)
  local ret = ''
  for _, school in ipairs(table_keys_sorted(schools)) do
    if school == no_link_for then
      ret = ret .. school .. '/'
    else
      ret = ret ..
        frame:expandTemplate{title = 'schoollink', args = {school}} .. '/'
    end
  end
  return ret:sub(1, -2)
end

local function format_range(range)
  if range == nil then
    return ''
  elseif range.min == range.max then
    if range.min == RANGE_LOS then
      return 'LOS'
    else
      return range.min
    end
  else
    return range.min .. '-' .. range.max
  end
end

local function format_noise(noise)
  if noise == nil then
    return ''
  else
    return math.max(string.match(noise.casting, "%d+"), string.match(noise.effect, "%d+"))
  end
end

local function format_flag(flag)
  if flag:upper() == 'WL_CHECK' then
    return 'Will check'
  else
    return flag:gsub('_', ' '):lower():gsub('^%l', string.upper)
  end
end

local function format_flags(flags, ignored)
  if flags == nil then
    return ''
  end
  local ret = ''
  for _, flag in ipairs(table_keys_sorted(flags)) do
    if not ignored or not ignored[flag] then
      ret = ret .. format_flag(flag) .. ', '
    end
  end
  return ret:sub(1, -3)
end

local function compare_books(a, b)
  return a:lower():gsub('^book of ', ''):gsub('^a ', ''):gsub('^the ', '') <
    b:lower():gsub('^book of ', ''):gsub('^a ', ''):gsub('^the ', '')
end

local function format_books(books)
  local ret = ''
  for _, book in ipairs(table_keys_sorted(books, compare_books)) do
    ret = ret .. '[[' .. book:gsub('^%l', string.upper) .. ']]<br>'
  end
  return ret:sub(1, -5)
end

local function spell_table_line(frame, name, info, no_link_for)
  return '|[[File:' .. name:lower() .. '.png]]\n' ..
         '|style="padding-left:1em"|[[' .. name .. ']]\n' ..
         '|' .. format_schools(frame, info['schools'], no_link_for) .. '\n' ..
         '|' .. info['level'] .. '\n' ..
         '|' .. (info['power cap'] == 0 and 'N/A' or info['power cap']) ..
         '\n' ..
         '|' .. format_range(info['range']) .. '\n' ..
         '|' .. format_noise(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(frame, name, data[name])
  end
  return ret .. '|}'
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 data[name]['schools'][school] then
          if not found then
            found = true
            ret = ret .. spell_table_section('Level ' .. level)
          end
          ret = ret .. spell_table_line(frame, name, data[name], school)
        end
      end
    end
  end
  return ret .. '|}'
end

function p.spell_table_by_school(frame)
  local schools = {}
  for _,spell in pairs(data) do
    for school in pairs(spell['schools']) do
      schools[school] = true
    end
  end

  local ret = '==Spells==\n' .. spell_table_header()
  for _,school in ipairs(table_keys_sorted(schools)) do
    ret = ret .. spell_table_section(
      frame:expandTemplate{title = 'schoollink', args = {school}})
    for _, name in ipairs(names_by_level(data)) do
      if data[name]['schools'][school] then
        ret = ret .. spell_table_line(frame, name, data[name], school)
      end
    end
  end
  return ret .. '|}'
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, compare_books)) do
    ret = ret ..
      spell_table_section('[[' .. book:gsub('^%l', string.upper) .. ']]')
    for _, name in ipairs(names_by_level(data)) do
      if data[name]['books'][book] then
        ret = ret .. spell_table_line(frame, name, data[name])
      end
    end
  end
  return ret .. '|}'
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 empty_table(data[name]['flags']) then
      ret = ret .. spell_table_line(frame, name, data[name])
    end
  end

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

local function format_hated_by(spell)
  local output = ''
  if spell.flags.HASTY then
    output = output .. '[[Cheibriados]][[Category:Hasty Spells]]<br>'
  end
  if spell.flags.UNHOLY or spell.schools.Necromancy then
    output = output .. '[[Elyvilon]]<br>'
  end
  if spell.flags.UNHOLY or spell.schools.Necromancy then
    output = output .. '[[The Shining One]]<br>'
  end
  if spell.flags.CHAOTIC or spell.flags.UNCLEAN or spell.flags.UNHOLY or
    spell.schools.Necromancy then
    output = output .. '[[Zin]]'
    if spell.flags.UNCLEAN then
      output = output .. '[[Category:Unclean Spells]]'
    end
    if spell.flags.CHAOTIC then
      output = output .. '[[Category:Chaotic Spells]]'
    end
    if spell.flags.UNHOLY then
      output = output .. '[[Category:Evil Spells]]'
    end
    output = output .. '<br>'
  end
  return output:sub(1, -5)
end

local function format_targetting(flags)
  local style = nil
  if flags.DIR then
    style = 'Direction'
  elseif flags.DIR_OR_TARGET then
    style = 'Target or direction'
  elseif flags.TARGET then
    style = 'Smite'
  end
  if style then
    if flags.OBJ and flags.NOT_SELF then
      return style .. ' (object, not self)'
    elseif flags.OBJ then
      return style .. ' (object)'
    elseif flags.NOT_SELF then
      return style .. ' (not self)'
    end
  end
  return style
end

function p.spell_info(frame)
  local name = frame.args[1]
  if not name or name == '' then
    name = mw.title.getCurrentTitle().text
  end
  local spell = data[name]
  if not spell then
    return name
  end

  local args = {}
  args.name = spell.name
  args.level = spell.level
  for i,school in ipairs(table_keys_sorted(spell.schools)) do
    args['school' .. i] =
      frame:expandTemplate{title = 'schoollink', args = {school}} ..
      '[[Category:' .. school .. ' Spells]]'
    i = i + 1
  end
  args.sources = format_books(spell.books)
  args.castingnoise = spell.noise.casting
  args.spellnoise = spell.noise.effect
  args['power cap'] = spell['power cap'] == 0 and 'N/A' or spell['power cap']
  args['summons limit'] = spell['summons limit']
  args.targetting = format_targetting(spell.flags)
  args.range = format_range(spell.range)
  args['hated by'] = format_hated_by(spell)
  args.flags = format_flags(spell.flags, {
    CHAOTIC = true,
    CORPSE_VIOLATING = true,
    DIR = true,
    DIR_OR_TARGET = true,
    HASTY = true,
    MONS_ABJURE = true,
    NEEDS_TRACER = true,
    NOT_SELF = true,
    OBJ = true,
    TARGET = true,
    UNCLEAN = true,
    UNHOLY = true,
  })

  local infobox = frame:expandTemplate{title = 'spell', args = args}

  local flavour = spell.description
  if spell.quote then
    flavour = flavour .. '\n----\n' .. spell.quote:gsub('\n', '<br>')
  end
  flavour = frame:expandTemplate{title = 'flavour', args = {flavour}}
  return infobox .. '\n' .. flavour
end

return p
Retrieved from "http://crawl.chaosforge.org/index.php?title=Module:Spell&oldid=83425"