Dependenices

modules/control/jail.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Jail = require 'modules.control.jail'
+    local Jail = require 'modules.control.jail' --- @dep modules.control.jail
 
     -- This will move 'MrBiter' to the jail role and remove all other roles from them
     -- the player name and reason are only so they can be included in the event for user feedback
@@ -20,18 +20,10 @@
     Jail.temp_ban_player('MrBiter','Cooldude2606','Likes biters too much')
 ]]
 
---- Allows moving players into the jail role
--- @dep expcore.roles
-local Roles = require 'expcore.roles'
---- Allows accessing a player from any value
--- @dep utils.game
-local Game = require 'utils.game'
---- Allows storing data in the global table
--- @dep utils.global
-local Global = require 'utils.global'
---- Use of move_items to clear inventroies
--- @dep expcore.common
-local move_items = ext_require('expcore.common','move_items')
+local Roles = require 'expcore.roles' --- @dep expcore.roles
+local Game = require 'utils.game' --- @dep utils.game
+local Global = require 'utils.global' --- @dep utils.global
+local move_items = ext_require('expcore.common','move_items') --- @dep expcore.common
 
 local valid_player = Game.get_player_from_any
 local assign_roles = Roles.assign_player

modules/control/production.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Production = require 'modules.control.production'
+    local Production = require 'modules.control.production' --- @dep modules.control.production
 
     -- This will return the less precise index from the one given
     -- this means that one_second will return one_minute or ten_hours will return fifty_hours
@@ -32,12 +32,8 @@
 
 ]]
 
---- Provides colors for Production.get_color
--- @dep resources.color_presets
-local Colors = require 'resources.color_presets'
---- Provides format_number function to add surfixs
--- @dep util
-local format_number = ext_require('util','format_number')
+local Colors = require 'resources.color_presets' --- @dep resources.color_presets
+local format_number = ext_require('util','format_number') --- @dep util
 
 local precision_index = defines.flow_precision_index
 local Production = {}

modules/control/reports.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Reports = require 'modules.control.reports'
+    local Reports = require 'modules.control.reports' --- @dep modules.control.reports
 
     -- This will place a report on "MrBiter" (must be a valid player) the report will have been made
     -- by "Cooldude2606" (must be the player name) with the reason 'Liking biters too much' this can be
@@ -24,12 +24,8 @@
 
 ]]
 
---- Allows getting player from any value
--- @dep utils.game
-local Game = require 'utils.game'
---- Allows storing of data in global table
--- @dep utils.global
-local Global = require 'utils.global'
+local Game = require 'utils.game' --- @dep utils.game
+local Global = require 'utils.global' --- @dep utils.global
 
 local valid_player = Game.get_player_from_any
 

modules/control/rockets.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Rockets = require 'modules.control.rockets'
+    local Rockets = require 'modules.control.rockets' --- @dep modules.control.rockets
 
     -- Some basic information is stored for each silo that has been built
     -- the data includes: the tick it was built, the rockets launched from it and more
@@ -25,15 +25,9 @@
 
 ]]
 
---- Allows registering event handlers
--- @dep utils.event
-local Event = require 'utils.event'
---- Allows storing in the global table
--- @dep utils.global
-local Global = require 'utils.global'
---- Contains the config for this module
--- @dep config.rockets
-local config = require 'config.rockets'
+local Event = require 'utils.event' --- @dep utils.event
+local Global = require 'utils.global' --- @dep utils.global
+local config = require 'config.rockets' --- @dep config.rockets
 
 local largest_rolling_avg = 0
 for _,avg_over in pairs(config.stats.rolling_avg) do

modules/control/tasks.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Tasks = require 'modules.control.tasks'
+    local Tasks = require 'modules.control.tasks' --- @dep modules.control.tasks
 
     -- To create a new task all you need is the name of the force you want to add the task to
     -- you can give a place to add it but this is optional
@@ -25,15 +25,9 @@
 
 ]]
 
---- Allows storing of task ids
--- @dep expcore.store
-local Store = require 'expcore.store'
---- Allows storing in the global table
--- @dep utils.global
-local Global = require 'utils.global'
---- Allows non conflicting task ids
--- @dep utils.token
-local Token = require 'utils.token'
+local Store = require 'expcore.store' --- @dep expcore.store
+local Global = require 'utils.global' --- @dep utils.global
+local Token = require 'utils.token' --- @dep utils.token
 
 local Tasks = {
     store = 'gui.left.task-list.tasks',

modules/control/warnings.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Warnings = require 'modules.control.warnings'
+    local Warnings = require 'modules.control.warnings' --- @dep modules.control.warnings
 
     -- This will add a warning to the player
     Warnings.add_warning('MrBiter','Cooldude2606','Killed too many biters')
@@ -21,18 +21,10 @@
     Warnings.clear_warnings('MrBiter','Cooldude2606')
 ]]
 
---- Allows registering of custom events
--- @dep utils.event
-local Event = require 'utils.event'
---- Allows getting player from any value
--- @dep utils.game
-local Game = require 'utils.game'
---- Allows storing in the global table
--- @dep utils.global
-local Global = require 'utils.global'
---- Config file for this module
--- @dep config.warnings
-local config = require 'config.warnings'
+local Event = require 'utils.event' --- @dep utils.event
+local Game = require 'utils.game' --- @dep utils.game
+local Global = require 'utils.global' --- @dep utils.global
+local config = require 'config.warnings' --- @dep config.warnings
 
 local valid_player = Game.get_player_from_any
 

modules/control/warps.lua

@@ -5,7 +5,7 @@
 
     @usage
     -- import the module from the control modules
-    local Warps = require 'modules.control.warps'
+    local Warps = require 'modules.control.warps' --- @dep modules.control.warps
 
     -- Adding a warp require a force, surface and postion, and the option to set this as the spawn
     -- this function will also create the warp area unless set other wise
@@ -25,21 +25,11 @@
 
 ]]
 
---- Allows storing of warp ids
--- @dep expcore.store
-local Store = require 'expcore.store'
---- Allows storing of warp details
--- @dep utils.global
-local Global = require 'utils.global'
---- Allows non conflicting warp ids
--- @dep utils.token
-local Token = require 'utils.token'
---- Config for the warps
--- @dep expcore.store
-local config = require 'config.warps'
---- Access to table_values and table_keysort
--- @dep expcore.common
-local table_values,table_keysort = ext_require('expcore.common','table_values','table_keysort')
+local Store = require 'expcore.store' --- @dep expcore.store
+local Global = require 'utils.global' --- @dep utils.global
+local Token = require 'utils.token' --- @dep utils.token
+local config = require 'config.warps' --- @dep config.warps
+local table_values,table_keysort = ext_require('expcore.common','table_values','table_keysort') --- @dep expcore.common
 
 local Warps = {
     store = {