Allow passing numeric id to auto functions. Tidy up docs api some more.

Author: warmist

docs/dev/Lua API.rst

@@ -6097,17 +6097,17 @@ Functions
   this as default power consumption/production. Note: due to implementation limitations
   workshop only connects to other machines if the other machine is build later than this one.
 
-  :workshop_type:   custom workshop string id e.g. ``SOAPMAKER`` or numeric id
-  :needs_power:   only function if it has sufficient power
-  :power_consumed:   building consumes this amount of power
-  :power_produced:   output this amount of power
-  :connection_points:   a table of ``{x=?,y=?}`` points that can connect to other machines
+  :workshop_type:       custom workshop string id e.g. ``SOAPMAKER`` or numeric id
+  :needs_power:         only function if it has sufficient power
+  :power_consumed:      building consumes this amount of power
+  :power_produced:      output this amount of power
+  :connection_points:   a table of ``{x=?,y=?}`` zero-based coordinates that can connect to other machines
 
-* ``setMachineInfoAuto(workshop_type, needs_power, power_consumed, power_produced, gear_tiles)``
+* ``setMachineInfoAuto(workshop_type, needs_power, power_consumed, power_produced, [gear_tiles])``
 
   Same as ``setMachineInfo`` but fills out the ``connection_points`` table from raws placing connection
   points on tiles which have the gear tile. ``gear_tiles`` is an optional array of two tiles that are
-  counted as gears in the workshop ascii tile raws.
+  counted as gears in the workshop ascii tile raws. The default gear tiles are ``42`` and ``15``.
 
 * ``setAnimationInfo(workshop_type, frames, frame_skip)``
 
@@ -6123,26 +6123,27 @@ Functions
   :frame_skip:      How many ticks to display one frame. If set to negative number (or skipped) frames
                     are synchronized with machine animation.
 
-* ``setAnimationInfoAuto(name, make_graphics_too, frame_skip, gear_tiles)``
+* ``setAnimationInfoAuto(workshop_type, make_graphics_too, [frame_length], [gear_tiles])``
 
   Animate workshop as with function above but generate frames automatically. This works by finding
   tiles which have gears and animating them with alternating gear tiles.
 
-  :name:            custom workshop string id e.g. ``SOAPMAKER``
+  :workshop_type:     custom workshop string id e.g. ``SOAPMAKER`` or numeric id
   :make_graphics_too:  replace same tiles in graphics mode with tiles from vanilla df mechanism
-  :frame_skip:      How many ticks to display one frame. If set to negative number (or skipped) frames
-                    are synchronized with machine animation.
-  :gear_tiles:      Optional array of 2 or 4 indexes. First two define ascii tiles and next two graphics tiles
+  :frame_length:      How many ticks to display one frame. If set to negative number (or skipped) frames
+                      are synchronized with machine animation.
+  :gear_tiles:        Optional array of 2 or 4 indexes. First two define ascii tiles and next two graphics tiles.
+                      This overrides default gear tiles.
 
-* ``setOnUpdate(name,interval,callback)``
+* ``setOnUpdate(workshop_type,interval,callback)``
 
   Setup callback to be called every ``interval`` of ticks for each building of this type. Note: low interval
   numbers and/or many workshops that use this might reduce DF performance.
 
-  :name:   custom workshop string id e.g. ``SOAPMAKER``
-  :interval:   how many ticks to skip between event triggers
-  :callback:   function to call. Function signature is ``func(workshop)`` where ``workshop`` is of type
-               ``df.building_workshopst``
+  :workshop_type:   custom workshop string id e.g. ``SOAPMAKER`` or numeric id
+  :interval:        how many ticks to skip between event triggers
+  :callback:        function to call. Function signature is ``func(workshop)`` where ``workshop`` is of type
+                    ``df.building_workshopst``
 
 * ``getPower(building)``
 

plugins/lua/building-hacks.lua

@@ -1,11 +1,11 @@
 local _ENV = mkmodule('plugins.building-hacks')
 --[[
     from native:
-        setOwnableBuilding(workshop_type,bool)
+        setOwnableBuilding(workshop_type)
         setAnimationInfo(workshop_type,table frames,int frameskip=-1)
         setUpdateSkip(workshop_type,int=0)
         setMachineInfo(workshop_type,bool need_power,int consume=0,int produce=0,table connection_points)
-        fixImpassible(workshop_type,bool)
+        fixImpassible(workshop_type)
         getPower(building) -- 2 or 0 returns, produced and consumed
         setPower(building,produced, consumed)
     from here:
@@ -39,13 +39,21 @@ local function onUpdateLocal(workshop)
         f(workshop)
     end
 end
-local function findCustomWorkshop(name)
-    local raws=df.global.world.raws.buildings.all
-    for k,v in ipairs(raws) do
-        if v.code==name then
-            return v
+local function findCustomWorkshop(name_or_id)
+    if type(name_or_id)="string" then
+        local raws=df.global.world.raws.buildings.all
+        for k,v in ipairs(raws) do
+            if v.code==name_or_id then
+                return v
+            end
         end
+        error("Building def:"..name_or_id.." not found")
+    elseif type(name_or_id)=="number" then
+        return df.building_def.find(name_or_id)
+    else
+        error("Expected string or integer id for workshop definition")
     end
+    
 end
 local function registerUpdateAction(shopId,callback)
     _registeredStuff[shopId]=callback
@@ -80,9 +88,9 @@ local function findGears( shop_def ,gear_tiles) --finds positions of all gears a
     for x=0,w-1 do
     for y=0,h-1 do
         local tile=shop_def.tile[stage][x][y]
-        if tile==42 then --gear icon
+        if tile==gear_tiles[1] then --gear icon
             table.insert(ret,{x=x,y=y,invert=false})
-        elseif tile==15 then --inverted gear icon
+        elseif tile==gear_tiles[2] then --inverted gear icon
             table.insert(ret,{x=x,y=y,invert=true})
         end
     end