Namespace modules

Author: vallode

dist/library/modules/buildings.lua

@@ -9,96 +9,96 @@
 ---@field findPenPitAt function
 dfhack.buildings = {}
 
----@param building building
----@param type general_ref_type
----@return general_ref
+---@param building df.building
+---@param type df.general_ref_type
+---@return df.general_ref
 function dfhack.buildings.getGeneralRef(building, type) end
 
----@param building building
----@param type specific_ref_type
----@return specific_ref
+---@param building df.building
+---@param type df.specific_ref_type
+---@return df.specific_ref
 function dfhack.buildings.getSpecificRef(building, type) end
 
----@param bld building_civzonest
----@param unit unit
+---@param bld df.building_civzonest
+---@param unit df.unit
 ---@return boolean
 function dfhack.buildings.setOwner(bld, unit) end
 
----@param pos coord
----@param type building_type
+---@param pos df.coord
+---@param type df.building_type
 ---@param subtype integer
 ---@param custom integer
----@return building
+---@return df.building
 function dfhack.buildings.allocInstance(pos, type, subtype, custom) end
 
----@param pos coord
----@param size coord2d
----@param ext building_extents
+---@param pos df.coord
+---@param size df.coord2d
+---@param ext df.building_extents
 ---@param createext boolean|nil
 ---@param allowoccupied boolean|nil
 ---@param allowwall boolean|nil
 ---@param allowflow boolean|nil
 ---@return boolean
 function dfhack.buildings.checkFreeTiles(pos, size, ext, createext, allowoccupied, allowwall, allowflow) end
 
----@param ext building_extents
+---@param ext df.building_extents
 ---@param defval integer
 ---@return integer
 function dfhack.buildings.countExtentTiles(ext, defval) end
 
----@param pos coord
----@param size coord2d
+---@param pos df.coord
+---@param size df.coord2d
 ---@return boolean
 function dfhack.buildings.hasSupport(pos, size) end
 
----@param bld building
+---@param bld df.building
 ---@return boolean
 function dfhack.buildings.constructAbstract(bld) end
 
----@param bld building
----@param items DFVector<item>
+---@param bld df.building
+---@param items df.DFVector<item>
 ---@return boolean
 function dfhack.buildings.constructWithItems(bld, items) end
 
----@param bld building
----@param items DFVector<job_item>
+---@param bld df.building
+---@param items df.DFVector<job_item>
 ---@return boolean
 function dfhack.buildings.constructWithFilters(bld, items) end
 
----@param bld building
+---@param bld df.building
 ---@return boolean
 function dfhack.buildings.deconstruct(bld) end
 
----@param bld building
+---@param bld df.building
 ---@return nil
 function dfhack.buildings.notifyCivzoneModified(bld) end
 
----@param bld building
+---@param bld df.building
 ---@return boolean
 function dfhack.buildings.markedForRemoval(bld) end
 
----@param building building
----@param unit unit
+---@param building df.building
+---@param unit df.unit
 ---@return string
 function dfhack.buildings.getRoomDescription(building, unit) end
 
----@param building building
+---@param building df.building
 ---@return boolean
 function dfhack.buildings.isActivityZone(building) end
 
----@param building building
+---@param building df.building
 ---@return boolean
 function dfhack.buildings.isPenPasture(building) end
 
----@param building building
+---@param building df.building
 ---@return boolean
 function dfhack.buildings.isPitPond(building) end
 
----@param building building
+---@param building df.building
 ---@return boolean
 function dfhack.buildings.isActive(building) end
 
----@param bld building
+---@param bld df.building
 ---@return nil
 function dfhack.buildings.completeBuild(bld) end
 

dist/library/modules/burrows.lua

@@ -9,29 +9,31 @@ dfhack.burrows = {}
 
 ---@param name string
 ---@param ignorefinalplus boolean|nil
----@return burrow
+---@return df.burrow
 function dfhack.burrows.findByName(name, ignorefinalplus) end
 
----@param burrow burrow
+---@param burrow df.burrow
 ---@return nil
 function dfhack.burrows.clearUnits(burrow) end
 
----@param burrow burrow
----@param unit unit
+---@param burrow df.burrow
+---@param unit df.unit
 ---@return boolean
 function dfhack.burrows.isAssignedUnit(burrow, unit) end
 
----@param burrow burrow
----@param unit unit
+---@param burrow df.burrow
+---@param unit df.unit
 ---@param enable boolean|nil
 ---@return nil
 function dfhack.burrows.setAssignedUnit(burrow, unit, enable) end
 
----@param burrow burrow
+---@param burrow df.burrow
 ---@return nil
 function dfhack.burrows.clearTiles(burrow) end
 
-function dfhack.burrows.isAssignedTile() end
+---@return unknown
+function dfhack.burrows.isAssignedTile(...) end
 
-function dfhack.burrows.setAssignedTile() end
+---@return unknown
+function dfhack.burrows.setAssignedTile(...) end
 

dist/library/modules/constructions.lua

@@ -6,14 +6,14 @@
 ---@field findAtTile function
 dfhack.constructions = {}
 
----@param pos coord
----@param type construction_type
----@param item item_type
+---@param pos df.coord
+---@param type df.construction_type
+---@param item df.item_type
 ---@param matindex integer
 ---@return boolean
 function dfhack.constructions.designateNew(pos, type, item, matindex) end
 
----@param constr construction
+---@param constr df.construction
 ---@return boolean
 function dfhack.constructions.insert(constr) end
 

dist/library/modules/designations.lua

@@ -5,23 +5,23 @@
 ---@field getPlantDesignationTile function
 dfhack.designations = {}
 
----@param plant plant
+---@param plant df.plant
 ---@return boolean
 function dfhack.designations.markPlant(plant) end
 
----@param plant plant
+---@param plant df.plant
 ---@return boolean
 function dfhack.designations.unmarkPlant(plant) end
 
----@param plant plant
+---@param plant df.plant
 ---@return boolean
 function dfhack.designations.canMarkPlant(plant) end
 
----@param plant plant
+---@param plant df.plant
 ---@return boolean
 function dfhack.designations.canUnmarkPlant(plant) end
 
----@param plant plant
+---@param plant df.plant
 ---@return boolean
 function dfhack.designations.isPlantMarked(plant) end
 

dist/library/modules/dfhack.lua

@@ -17,36 +17,37 @@
 dfhack = {}
 
 ---@return string
-function dfhack.getOSType() end
+function dfhack.getOSType(...) end
 
 ---@return integer
-function dfhack.getArchitecture() end
+function dfhack.getArchitecture(...) end
 
 ---@return string
-function dfhack.getArchitectureName() end
+function dfhack.getArchitectureName(...) end
 
 ---@return string
-function dfhack.getDFVersion() end
+function dfhack.getDFVersion(...) end
 
 ---@return string
-function dfhack.getDFPath() end
+function dfhack.getDFPath(...) end
 
 ---@return integer
-function dfhack.getTickCount() end
+function dfhack.getTickCount(...) end
 
 ---@return string
-function dfhack.getHackPath() end
+function dfhack.getHackPath(...) end
 
 ---@return boolean
-function dfhack.isWorldLoaded() end
+function dfhack.isWorldLoaded(...) end
 
 ---@return boolean
-function dfhack.isMapLoaded() end
+function dfhack.isMapLoaded(...) end
 
 ---@return boolean
-function dfhack.isSiteLoaded() end
+function dfhack.isSiteLoaded(...) end
 
-function dfhack.TranslateName() end
+---@return unknown
+function dfhack.TranslateName(...) end
 
 ---@param s string
 ---@return string

dist/library/modules/filesystem.lua

@@ -7,13 +7,13 @@
 dfhack.filesystem = {}
 
 ---@return string
-function dfhack.filesystem.getcwd() end
+function dfhack.filesystem.getcwd(...) end
 
 ---@return boolean
-function dfhack.filesystem.restore_cwd() end
+function dfhack.filesystem.restore_cwd(...) end
 
 ---@return string
-function dfhack.filesystem.get_initial_cwd() end
+function dfhack.filesystem.get_initial_cwd(...) end
 
 ---@param path string
 ---@return boolean
@@ -43,9 +43,12 @@ function dfhack.filesystem.isfile(path) end
 ---@return boolean
 function dfhack.filesystem.isdir(path) end
 
-function dfhack.filesystem.atime() end
+---@return unknown
+function dfhack.filesystem.atime(...) end
 
-function dfhack.filesystem.ctime() end
+---@return unknown
+function dfhack.filesystem.ctime(...) end
 
-function dfhack.filesystem.mtime() end
+---@return unknown
+function dfhack.filesystem.mtime(...) end