Fix bugs found while working on luacheck

Author: BenLubar

fix/blood-del.lua

@@ -8,7 +8,6 @@ Makes it so that future caravans won't bring barrels full of blood, ichor, or go
 
 ]====]
 local my_entity=df.historical_entity.find(df.global.ui.civ_id)
-local sText=" "
 local k=0
 local v=1
 
@@ -17,34 +16,34 @@ for x,y in pairs(df.global.world.entities.all) do
  k=0
  while k < #my_entity.resources.misc_mat.extracts.mat_index do
   v=my_entity.resources.misc_mat.extracts.mat_type[k]
-  sText=dfhack.matinfo.decode(v,my_entity.resources.misc_mat.extracts.mat_index[k])
-  if (sText==nil) then
+  local mat=dfhack.matinfo.decode(v,my_entity.resources.misc_mat.extracts.mat_index[k])
+  if (mat==nil) then
    --LIQUID barrels
    my_entity.resources.misc_mat.extracts.mat_type:erase(k)
    my_entity.resources.misc_mat.extracts.mat_index:erase(k)
    k=k-1
   else
-   if(sText.material.id=="BLOOD") then
+   if(mat.material.id=="BLOOD") then
     my_entity.resources.misc_mat.extracts.mat_type:erase(k)
     my_entity.resources.misc_mat.extracts.mat_index:erase(k)
     k=k-1
    end
-   if(sText.material.id=="ICHOR") then
+   if(mat.material.id=="ICHOR") then
     my_entity.resources.misc_mat.extracts.mat_type:erase(k)
     my_entity.resources.misc_mat.extracts.mat_index:erase(k)
     k=k-1
    end
-   if(sText.material.id=="GOO") then
+   if(mat.material.id=="GOO") then
     my_entity.resources.misc_mat.extracts.mat_type:erase(k)
     my_entity.resources.misc_mat.extracts.mat_index:erase(k)
     k=k-1
    end
-   if(sText.material.id=="SWEAT") then
+   if(mat.material.id=="SWEAT") then
     my_entity.resources.misc_mat.extracts.mat_type:erase(k)
     my_entity.resources.misc_mat.extracts.mat_index:erase(k)
     k=k-1
    end
-   if(sText.material.id=="TEARS") then
+   if(mat.material.id=="TEARS") then
     my_entity.resources.misc_mat.extracts.mat_type:erase(k)
     my_entity.resources.misc_mat.extracts.mat_index:erase(k)
     k=k-1

fix/diplomats.lua

@@ -51,7 +51,7 @@ for _,ent in pairs(df.global.world.entities.all) do
     if ent.type == df.historical_entity_type.Civilization and ent.entity_raw.flags.TREE_CAP_DIPLOMACY then
         checked = checked + 1
 
-        update = true
+        local update = true
         local found_position
         -- see if we need to add a new position or modify an existing one
         for _,pos in pairs(ent.positions.own) do
@@ -72,12 +72,12 @@ for _,ent in pairs(df.global.world.entities.all) do
         if update then
             -- either there's no diplomat, or there is one and it's got the wrong responsibilities
             if not found_position then
-                found_position = add_guild_rep( ent )
+                found_position = update_pos( ent )
             end
             -- assign responsibilities
-            found_position.responsibilities.MAKE_INTRODUCTIONS = true
-            found_position.responsibilities.MAKE_PEACE_AGREEMENTS = true
-            found_position.responsibilities.MAKE_TOPIC_AGREEMENTS = true
+            found_position.responsibilities.MAKE_INTRODUCTIONS = 1
+            found_position.responsibilities.MAKE_PEACE_AGREEMENTS = 1
+            found_position.responsibilities.MAKE_TOPIC_AGREEMENTS = 1
         end
         -- make sure the diplomat position, whether we created it or not, is set up for proper assignment
         local assign = true

fix/dry-buckets.lua

@@ -13,7 +13,7 @@ local emptied = 0
 local water_type = dfhack.matinfo.find('WATER').type
 
 for _,item in ipairs(df.global.world.items.all) do
-    container = dfhack.items.getContainer(item)
+    local container = dfhack.items.getContainer(item)
     if container ~= nil
     and container:getType() == df.item_type.BUCKET
     and not (container.flags.in_job or container.flags.in_building)

fix/merchants.lua

@@ -50,7 +50,7 @@ for _,ent in pairs(df.global.world.entities.all) do
     if ent.type == df.historical_entity_type.Civilization and ent.entity_raw.flags.MERCHANT_NOBILITY then
         checked = checked + 1
 
-        update = true
+        local update = true
         -- see if we need to add a new position or modify an existing one
         local found_position
         for _,pos in pairs(ent.positions.own) do
@@ -72,8 +72,8 @@ for _,ent in pairs(df.global.world.entities.all) do
                 found_position = add_guild_rep(ent)
             end
             -- assign responsibilities
-            found_position.responsibilities.ESTABLISH_COLONY_TRADE_AGREEMENTS = true
-            found_position.responsibilities.TRADE=true
+            found_position.responsibilities.ESTABLISH_COLONY_TRADE_AGREEMENTS = 1
+            found_position.responsibilities.TRADE = 1
         end
 
         -- make sure the guild rep position, whether we created it or not, is set up for proper assignment

fix/retrieve-units.lua

@@ -23,7 +23,7 @@ such as the following:
 
 ]====]
 
-utils = require('utils')
+local utils = require('utils')
 
 function shouldRetrieve(unit)
     if unit.flags1.incoming then

fix/stable-temp.lua

@@ -13,7 +13,7 @@ local args = {...}
 local apply = (args[1] == 'apply')
 
 local count = 0
-local types = {}
+local types = {} --as:number[]
 
 local function update_temp(item,btemp)
     if item.temperature.whole ~= btemp then
@@ -34,7 +34,7 @@ local function update_temp(item,btemp)
         end
     end
 
-    for _,sub in ipairs(dfhack.items.getContainedItems(item)) do
+    for _,sub in ipairs(dfhack.items.getContainedItems(item)) do --as:df.item_actual
         update_temp(sub,btemp)
     end
 
@@ -45,7 +45,7 @@ end
 
 local last_frame = df.global.world.frame_counter-1
 
-for _,item in ipairs(df.global.world.items.all) do
+for _,item in ipairs(df.global.world.items.all) do --as:df.item_actual
     if item.flags.on_ground and df.item_actual:is_instance(item) and
        item.temp_updated_frame == last_frame then
         local pos = item.pos

fix/stuck-merchants.lua

@@ -2,7 +2,7 @@
 -- Based on "dismissmerchants" by PatrikLundell:
 -- http://www.bay12forums.com/smf/index.php?topic=159297.msg7257447#msg7257447
 
-help = [====[
+local help = [====[
 
 fix/stuck-merchants
 ===================

fix/tile-occupancy.lua

@@ -26,8 +26,8 @@ function findUnit(x, y, z)
     return false
 end
 
-cursor = df.global.cursor
-changed = false
+local cursor = df.global.cursor
+local changed = false
 function report(flag)
     print('Cleared occupancy flag: ' .. flag)
     changed = true
@@ -37,10 +37,10 @@ if cursor.x == -30000 then
     qerror('Cursor not active.')
 end
 
-occ = dfhack.maps.getTileBlock(pos2xyz(cursor)).occupancy[cursor.x % 16][cursor.y % 16]
+local occ = dfhack.maps.getTileBlock(pos2xyz(cursor)).occupancy[cursor.x % 16][cursor.y % 16]
 
-if occ.building ~= 0 and not dfhack.buildings.findAtTile(pos2xyz(cursor)) then
-    occ.building = 0
+if occ.building and not dfhack.buildings.findAtTile(pos2xyz(cursor)) then
+    occ.building = df.tile_building_occ.None
     report('building')
 end
 

modtools/outside-only.lua

@@ -24,9 +24,13 @@ Arguments::
 local eventful = require 'plugins.eventful'
 local utils = require 'utils'
 
+--luacheck: global
 buildingType = utils.invert({'EITHER','OUTSIDE_ONLY','INSIDE_ONLY'})
-registeredBuildings = registeredBuildings or {}
+--luacheck: global
+registeredBuildings = registeredBuildings or {} --as:number[]
+--luacheck: global
 checkEvery = checkEvery or 100
+--luacheck: global
 timeoutId = timeoutId or nil
 
 eventful.enableEvent(eventful.eventType.UNLOAD,1)
@@ -98,7 +102,7 @@ eventful.onBuildingCreatedDestroyed.outsideOnly = function(buildingId)
  checkBuildings()
 end
 
-validArgs = utils.invert({
+local validArgs = utils.invert({
  'help',
  'clear',
  'checkEvery',

modtools/projectile-trigger.lua

@@ -27,7 +27,8 @@ This triggers dfhack commands when projectiles hit their targets.  Usage::
 local eventful = require 'plugins.eventful'
 local utils = require 'utils'
 
-materialTriggers = materialTriggers or {}
+--luacheck: global
+materialTriggers = materialTriggers or {} --as:{_type:table,command:__arg,material:__arg}[][]
 
 eventful.enableEvent(eventful.eventType.UNLOAD,1)
 eventful.onUnload.projectileTrigger = function()
@@ -56,18 +57,18 @@ end
 
 eventful.onProjItemCheckImpact.expansion = function(projectile)
  local matStr = dfhack.matinfo.decode(projectile.item):getToken()
- local table = {}
- table.pos = projectile.cur_pos
- table.projectile = projectile
- table.item = projectile.item
  for _,args in ipairs(materialTriggers[matStr] or {}) do
-  utils.fillTable(args,table)
-  processTrigger(args)
-  utils.unfillTable(args,table)
+  processTrigger({
+   pos = projectile.cur_pos,
+   projectile = projectile,
+   item = projectile.item,
+   command = args.command,
+   material = args.material
+  })
  end
 end
 
-validArgs = utils.invert({
+local validArgs = utils.invert({
  'help',
  'clear',
  'command',

modtools/random-trigger.lua

@@ -76,15 +76,17 @@ Arguments::
 local utils = require 'utils'
 local eventful = require 'plugins.eventful'
 
-outcomeLists = outcomeLists or {}
+--luacheck: global
+outcomeLists = outcomeLists or {} --as:{total:number,outcomes:'{weight:number,command:__arg}[]'}[]
+--luacheck: global
 randomGen = randomGen or dfhack.random.new()
 
 eventful.enableEvent(eventful.eventType.UNLOAD, 1)
 eventful.onUnload.randomTrigger = function()
  outcomeLists = {}
 end
 
-validArgs = utils.invert({
+local validArgs = utils.invert({
  'help',
  'command',
  'outcomeListName',
@@ -132,11 +134,11 @@ end
 if args.weight and not tonumber(args.weight) then
  error ('Invalid weight: ' .. args.weight)
 end
-args.weight = (args.weight and tonumber(args.weight)) or 1
-if args.weight ~= math.floor(args.weight) then
+local weight = (args.weight and tonumber(args.weight)) or 1
+if weight ~= math.floor(weight) then
  error 'Noninteger weight.'
 end
-if args.weight < 0 then
+if weight < 0 then
  error 'invalid weight: must be non-negative'
 end
 
@@ -148,11 +150,11 @@ args.outcomeListName = args.outcomeListName or ''
 args.outcomeListName = 'outcomeList ' .. args.outcomeListName
 
 if args.withProbability then
- args.withProbability = tonumber(args.withProbability)
- if not args.withProbability or args.withProbability < 0 or args.withProbability > 1 then
-  error('Invalid withProbability: ' .. (args.withProbability or 'nil'))
+ local withProbability = tonumber(args.withProbability)
+ if not withProbability or withProbability < 0 or withProbability > 1 then
+  error('Invalid withProbability: ' .. (withProbability or 'nil'))
  end
- if randomGen:drandom() < args.withProbability then
+ if randomGen:drandom() < withProbability then
   dfhack.run_command(table.unpack(args.command))
  end
 end
@@ -190,9 +192,9 @@ if not outcomeList then
  outcomeList = outcomeLists[args.outcomeListName]
 end
 
-outcomeList.total = args.weight + (outcomeList.total or 0)
-local outcome = {}
-outcome.weight = args.weight
+outcomeList.total = weight + (outcomeList.total or 0)
+local outcome = {} --as:{weight:number,command:__arg}
+outcome.weight = weight
 outcome.command = args.command
 outcomeList.outcomes = outcomeList.outcomes or {}
 table.insert(outcomeList.outcomes, outcome)

modtools/raw-lint.lua

@@ -8,20 +8,21 @@ Checks for simple issues with raw files. Can be run automatically.
 
 ]====]
 
-utils = require 'utils'
+local utils = require 'utils'
 
+--luacheck: global
 enabled = enabled or false
 
 if dfhack.filesystem == nil or dfhack.filesystem.listdir_recursive == nil then
     qerror('This script requires DFHack 0.40.24-r2 or newer')
 end
 
-perr_prefix = ''
+local perr_prefix = ''
 function perr(msg, ...)
     dfhack.printerr((#perr_prefix > 0 and perr_prefix .. ': ' or '') .. tostring(msg):format(...))
 end
 
-valid_objnames = utils.invert{
+local valid_objnames = utils.invert{
     'BODY_DETAIL_PLAN',
     'BODY',
     'BUILDING',
@@ -41,7 +42,7 @@ valid_objnames = utils.invert{
     'TISSUE_TEMPLATE',
 }
 
-objname_overrides = {
+local objname_overrides = {
     b_detail_plan = 'BODY_DETAIL_PLAN',
     c_variation = 'CREATURE_VARIATION',
 }
@@ -120,7 +121,7 @@ dfhack.onStateChange.raw_lint = function(event)
     end
 end
 
-args = {...}
+local args = {...}
 if dfhack_flags and dfhack_flags.enable then
     table.insert(args, dfhack_flags.enable_state and 'enable' or 'disable')
 end

modtools/reaction-product-trigger.lua

@@ -29,13 +29,8 @@ local eventful = require 'plugins.eventful'
 local utils = require 'utils'
 
 --TODO: onUnload
-productHooks = productHooks or {}
-
-reactionInputItems = reactionInputItems
-
-function preserveReagents()
- reactionInputItems:resize(0)
-end
+--luacheck: global
+productHooks = productHooks or {} --as:{clear:__arg,reactionName:__arg,command:__arg}[][]
 
 eventful.enableEvent(eventful.eventType.UNLOAD,1)
 eventful.onUnload.reactionProductTrigger = function()
@@ -88,12 +83,10 @@ local function afterProduce(reaction,reaction_product,unit,input_items,input_rea
 end
 
 eventful.onReactionComplete.reactionProductTrigger = function(reaction,reaction_product,unit,input_items,input_reagents,output_items)
- reactionInputItems = input_items
  afterProduce(reaction,reaction_product,unit,input_items,input_reagents,output_items)
- reactionInputItems = nil
 end
 
-validArgs = utils.invert({
+local validArgs = utils.invert({
  'help',
  'clear',
  'reactionName',
@@ -104,8 +97,7 @@ if moduleMode then
  return
 end
 
-local args = {...} or {}
-args = utils.processArgs(args, validArgs)
+local args = utils.processArgs({...}, validArgs)
 
 if args.help then
  print(usage)