Dependenices

expcore/commands.lua

@@ -216,8 +216,8 @@
     Commands.run_command(command_event) --- Main event function that is ran for all commands, used internally please avoid direct use
 ]]
 
-local Game = require 'utils.game'
-local player_return,write_json = ext_require('expcore.common','player_return','write_json')
+local Game = require 'utils.game' --- @dep utils.game
+local player_return,write_json = ext_require('expcore.common','player_return','write_json') --- @dep expcore.common
 
 local Commands = {
     defines={ -- common values are stored error like signals

expcore/common.lua

@@ -36,9 +36,9 @@
     Common.format_chat_player_name(player,raw_string) --- Returns the players name in the players color
 ]]
 
-local Colours = require 'resources.color_presets'
-local Game = require 'utils.game'
-local Util = require 'util'
+local Colours = require 'resources.color_presets' --- @dep resources.color_presets
+local Game = require 'utils.game' --- @dep utils.game
+local Util = require 'util' --- @dep util
 require 'utils.table'
 require 'utils.math'
 
@@ -141,7 +141,7 @@ function Common.opt_require(path)
 end
 
 --- Calls a require and returns only the keys given, file must return a table
--- @usage local extract, param_check = ext_require('expcore.common','extract','param_check')
+-- @usage local extract, param_check = ext_require('expcore.common','extract','param_check') --- @dep expcore.common
 -- @tparam string path the path that you want to require
 -- @tparam string ... the name of the keys that you want returned
 -- @return the keys in the order given

expcore/gui.lua

@@ -1,7 +1,7 @@
 --- This file is used to require all the different elements of the gui module
 -- each module has an outline here but for more details see their separate files in ./gui
 
-local Gui = require 'expcore.gui.core'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
 --[[
     Core
 
@@ -48,7 +48,7 @@ local Gui = require 'expcore.gui.core'
     Prototype:clear_store(category) --- Sets the value in this elements store to nil, category needed if categorize function used
 ]]
 
-local Instances = require 'expcore.gui.instances'
+local Instances = require 'expcore.gui.instances' --- @dep expcore.gui.instances
 Gui.new_instance_group = Instances.registers
 Gui.get_instances = Instances.get_elements
 Gui.add_instance = Instances.get_elements
@@ -67,7 +67,7 @@ Gui.classes.instances = Instances
     Instances.unregistered_get_elements(name,category,callback) --- A version of get_elements that does not require the group to be registered
 ]]
 
-local Button = require 'expcore.gui.elements.buttons'
+local Button = require 'expcore.gui.elements.buttons' --- @dep expcore.gui.elements.buttons
 Gui.new_button = Button.new_button
 Gui.classes.button = Button
 --[[
@@ -82,7 +82,7 @@ Gui.classes.button = Button
     Button._prototype:set_key_filter(filter,...) --- Adds a control key filter to the button
 ]]
 
-local Checkbox = require 'expcore.gui.elements.checkbox'
+local Checkbox = require 'expcore.gui.elements.checkbox' --- @dep expcore.gui.elements.checkbox
 Gui.new_checkbox = Checkbox.new_checkbox
 Gui.new_radiobutton = Checkbox.new_radiobutton
 Gui.new_radiobutton_option_set = Checkbox.new_option_set
@@ -104,7 +104,7 @@ Gui.classes.checkbox = Checkbox
     Checkbox.reset_radiobutton(element,exclude,recursive) --- Sets all radiobuttons in a element to false (unless excluded) and can act recursively
 ]]
 
-local Dropdown = require 'expcore.gui.elements.dropdown'
+local Dropdown = require 'expcore.gui.elements.dropdown' --- @dep expcore.gui.elements.dropdown
 Gui.new_dropdown = Dropdown.new_dropdown
 Gui.new_list_box = Dropdown.new_list_box
 Gui.classes.dropdown = Dropdown
@@ -123,7 +123,7 @@ Gui.classes.dropdown = Dropdown
     Dropdown.get_selected_value(element) --- Returns the currently selected value rather than index
 ]]
 
-local Slider = require 'expcore.gui.elements.slider'
+local Slider = require 'expcore.gui.elements.slider' --- @dep expcore.gui.elements.slider
 Gui.new_slider = Slider.new_slider
 Gui.classes.slider = Slider
 --[[
@@ -137,7 +137,7 @@ Gui.classes.slider = Slider
     Slider._prototype:enable_auto_draw_label(state) --- Enables auto draw of the label, the label will share the same parent element as the slider
 ]]
 
-local Text = require 'expcore.gui.elements.text'
+local Text = require 'expcore.gui.elements.text' --- @dep expcore.gui.elements.text
 Gui.new_text_filed = Text.new_text_field
 Gui.new_text_box = Text.new_text_box
 Gui.classes.text = Text
@@ -154,7 +154,7 @@ Gui.classes.text = Text
     Text._prototype_box:set_read_only(state) --- Sets the text box to be read only
 ]]
 
-local ElemButton = require 'expcore.gui.elements.elem-button'
+local ElemButton = require 'expcore.gui.elements.elem-button' --- @dep expcore.gui.elements.elem-button
 Gui.new_elem_button = ElemButton.new_elem_button
 Gui.classes.elem_button = ElemButton
 --[[
@@ -167,7 +167,7 @@ Gui.classes.elem_button = ElemButton
     ElemButton._prototype:set_default(value) --- Sets the default value for the elem button, this may be a function or a string
 ]]
 
-local ProgressBar = require 'expcore.gui.elements.progress-bar'
+local ProgressBar = require 'expcore.gui.elements.progress-bar' --- @dep expcore.gui.elements.progress-bar
 Gui.new_progressbar = ProgressBar.new_progressbar
 Gui.set_progressbar_maximum = ProgressBar.set_maximum
 Gui.increment_progressbar = ProgressBar.increment
@@ -194,7 +194,7 @@ Gui.classes.progressbar = ProgressBar
     ProgressBar._prototype:event_countdown(filter) --- Event handler factory that counts down by 1 every time the event triggers, can filter which elements are decremented
 ]]
 
-local Toolbar = require 'expcore.gui.concepts.toolbar'
+local Toolbar = require 'expcore.gui.concepts.toolbar' --- @dep expcore.gui.concepts.toolbar
 Gui.new_toolbar_button = Toolbar.new_button
 Gui.add_button_to_toolbar = Toolbar.add_button
 Gui.update_toolbar = Toolbar.update
@@ -205,7 +205,7 @@ Gui.classes.toolbar = Toolbar
     Toolbar.update(player) --- Updates the player's toolbar with an new buttons or expected change in auth return
 ]]
 
-local LeftFrames = require 'expcore.gui.concepts.left'
+local LeftFrames = require 'expcore.gui.concepts.left' --- @dep expcore.gui.concepts.left
 Gui.get_left_frame_flow = LeftFrames.get_flow
 Gui.toggle_left_frame = LeftFrames.toggle_frame
 Gui.new_left_frame = LeftFrames.new_frame
@@ -234,7 +234,7 @@ Gui.classes.left_frames = LeftFrames
     LeftFrames._prototype:event_handler(action) --- Creates an event handler that will trigger one of its functions, use with Event.add
 ]]
 
-local CenterFrames = require 'expcore.gui.concepts.center'
+local CenterFrames = require 'expcore.gui.concepts.center' --- @dep expcore.gui.concepts.center
 Gui.get_center_flow = CenterFrames.get_flow
 Gui.toggle_center_frame = CenterFrames.toggle_frame
 Gui.draw_center_frame = CenterFrames.draw_frame
@@ -257,7 +257,7 @@ Gui.classes.center_frames = CenterFrames
     CenterFrames._prototype:event_handler(action) --- Creates an event handler that will trigger one of its functions, use with Event.add
 ]]
 
-local PopupFrames = require 'expcore.gui.concepts.popups'
+local PopupFrames = require 'expcore.gui.concepts.popups' --- @dep expcore.gui.concepts.popups
 Gui.get_popup_flow = PopupFrames.get_flow
 Gui.open_popup = PopupFrames.open
 Gui.new_popup = PopupFrames.new_popup

expcore/gui/concepts/center.lua

@@ -15,10 +15,10 @@
     CenterFrames._prototype:toggle_frame(player) --- Toggles if the frame is open, if open it will close it and if closed it will open it
     CenterFrames._prototype:event_handler(action) --- Creates an event handler that will trigger one of its functions, use with Event.add
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Toolbar = require 'expcore.gui.concepts.toolbar'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Toolbar = require 'expcore.gui.concepts.toolbar' --- @dep expcore.gui.concepts.toolbar
+local Game = require 'utils.game' --- @dep utils.game
 
 local CenterFrames = {
 	_prototype = Prototype.extend{

expcore/gui/concepts/left.lua

@@ -48,13 +48,13 @@
     LeftFrames._prototype:on_player_toggle(player,frame) --- Is triggered when the player presses the toggle button
     LeftFrames._prototype:event_handler(action) --- Creates an event handler that will trigger one of its functions, use with Event.add
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Toolbar = require 'expcore.gui.concepts.toolbar'
-local Buttons = require 'expcore.gui.elements.buttons'
-local mod_gui = require 'mod-gui'
-local Game = require 'utils.game'
-local Event = require 'utils.event'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Toolbar = require 'expcore.gui.concepts.toolbar' --- @dep expcore.gui.concepts.toolbar
+local Buttons = require 'expcore.gui.elements.buttons' --- @dep expcore.gui.elements.buttons
+local mod_gui = require 'mod-gui' --- @dep mod-gui
+local Game = require 'utils.game' --- @dep utils.game
+local Event = require 'utils.event' --- @dep utils.event
 
 local LeftFrames = {
     frames={},

expcore/gui/concepts/popups.lua

@@ -11,15 +11,15 @@
     PopupFrames._prototype:set_default_open_time(amount) --- Sets the default open time for the popup, will be used if non is provided with open
     PopupFrames._prototype:open(player,open_time,...) --- Opens this define for a player, can be given open time and any other params for the draw function
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Game = require 'utils.game'
-local Event = require 'utils.event'
-local ProgressBar = require 'expcore.gui.elements.progress-bar'
-local Button = require 'expcore.gui.elements.buttons'
-local mod_gui = require 'mod-gui'
-local Color = require 'resources.color_presets'
-local Global = require 'utils.global'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Game = require 'utils.game' --- @dep utils.game
+local Event = require 'utils.event' --- @dep utils.event
+local ProgressBar = require 'expcore.gui.elements.progress-bar' --- @dep expcore.gui.elements.progress-bar
+local Button = require 'expcore.gui.elements.buttons' --- @dep expcore.gui.elements.buttons
+local mod_gui = require 'mod-gui' --- @dep mod-gui
+local Color = require 'resources.color_presets' --- @dep resources.color_presets
+local Global = require 'utils.global' --- @dep utils.global
 
 local PopupFrames = {
     paused_popups={},

expcore/gui/concepts/toolbar.lua

@@ -14,12 +14,12 @@
     Toolbar.add_button(button) --- Adds an existing buttton to the toolbar
     Toolbar.update(player) --- Updates the player's toolbar with an new buttons or expected change in auth return
 ]]
-local Gui = require 'expcore.gui.core'
-local Buttons = require 'expcore.gui.elements.buttons'
-local Roles = require 'expcore.roles'
-local Event = require 'utils.event'
-local Game = require 'utils.game'
-local mod_gui = require 'mod-gui'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Buttons = require 'expcore.gui.elements.buttons' --- @dep expcore.gui.elements.buttons
+local Roles = require 'expcore.roles' --- @dep expcore.roles
+local Event = require 'utils.event' --- @dep utils.event
+local Game = require 'utils.game' --- @dep utils.game
+local mod_gui = require 'mod-gui' --- @dep mod-gui
 
 local Toolbar = {
     permission_names = {},

expcore/gui/core.lua

@@ -129,8 +129,8 @@
     Gui.create_scroll_table(element,table_size,maximal_height,name) --- Creates a scroll area with a table inside, table can be any size
     Gui.create_header(element,caption,tooltip,right_align,name) --- Creates a header section with a label and button area
 ]]
-local Gui = require 'utils.gui'
-local Game = require 'utils.game'
+local Gui = require 'utils.gui' --- @dep utils.gui
+local Game = require 'utils.game' --- @dep utils.game
 
 Gui.classes = {} -- Stores the class definations used to create element defines
 Gui.defines = {} -- Stores the indivdual element definations

expcore/gui/elements/buttons.lua

@@ -13,9 +13,9 @@
 
     Other functions present from expcore.gui.core
 ]]
-local mod_gui = require 'mod-gui'
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
+local mod_gui = require 'mod-gui' --- @dep mod-gui
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
 
 local Button = {
     _prototype=Prototype.extend{

expcore/gui/elements/checkbox.lua

@@ -45,10 +45,10 @@
 
     Other functions present from expcore.gui.core
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Store = require 'expcore.store'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Store = require 'expcore.store' --- @dep expcore.store
+local Game = require 'utils.game' --- @dep utils.game
 
 --- Store call for store update
 -- @tparam table define the define that this is acting on

expcore/gui/elements/dropdown.lua

@@ -16,9 +16,9 @@
 
     Other functions present from expcore.gui.core
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Game = require 'utils.game' --- @dep utils.game
 
 local select_value
 --- Store call for store update

expcore/gui/elements/elem-button.lua

@@ -11,9 +11,9 @@
 
     Other functions present from expcore.gui.core
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Game = require 'utils.game' --- @dep utils.game
 
 --- Store call for store update
 -- @tparam table define the define that this is acting on

expcore/gui/elements/progress-bar.lua

@@ -20,10 +20,10 @@
     ProgressBar._prototype:event_counter(filter) --- Event handler factory that counts up by 1 every time the event triggers, can filter which elements have incremented
     ProgressBar._prototype:event_countdown(filter) --- Event handler factory that counts down by 1 every time the event triggers, can filter which elements have decremented
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Global = require 'utils.global'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Global = require 'utils.global' --- @dep utils.global
+local Game = require 'utils.game' --- @dep utils.game
 
 --- Event call for when the value is outside the range 0-1
 -- @tparam table define the define that this is acting on

expcore/gui/elements/slider.lua

@@ -12,10 +12,10 @@
 
     Other functions present from expcore.gui.core
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Instances = require 'expcore.gui.instances'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Instances = require 'expcore.gui.instances' --- @dep expcore.gui.instances
+local Game = require 'utils.game' --- @dep utils.game
 
 --- Event call for on_value_changed and store update
 -- @tparam table define the define that this is acting on

expcore/gui/elements/text.lua

@@ -14,9 +14,9 @@
 
     Other functions present from expcore.gui.core
 ]]
-local Gui = require 'expcore.gui.core'
-local Prototype = require 'expcore.gui.prototype'
-local Game = require 'utils.game'
+local Gui = require 'expcore.gui.core' --- @dep expcore.gui.core
+local Prototype = require 'expcore.gui.prototype' --- @dep expcore.gui.prototype
+local Game = require 'utils.game' --- @dep utils.game
 
 --- Store call for store update
 -- @tparam table define the define that this is acting on

expcore/gui/instances.lua

@@ -75,7 +75,7 @@
     Instances.unregistered_add_element(name,category,element) --- A version of add_element that does not require the group to be registered
     Instances.unregistered_get_elements(name,category,callback) --- A version of get_elements that does not require the group to be registered
 ]]
-local Global = require 'utils.global'
+local Global = require 'utils.global' --- @dep utils.global
 
 local Instances = {
     categorise={},

expcore/gui/prototype.lua

@@ -23,9 +23,9 @@
     Prototype:set_store(category,value) --- Sets the value in this elements store, category needed if categorize function used
     Prototype:clear_store(category) --- Sets the value in this elements store to nil, category needed if categorize function used
 ]]
-local Game = require 'utils.game'
-local Store = require 'expcore.store'
-local Instances = require 'expcore.gui.instances'
+local Game = require 'utils.game' --- @dep utils.game
+local Store = require 'expcore.store' --- @dep expcore.store
+local Instances = require 'expcore.gui.instances' --- @dep expcore.gui.instances
 
 local Constructor = {}
 local Prototype = {}

expcore/gui/test.lua

@@ -1,11 +1,11 @@
 --- This file creates a test gui that is used to test every input method
 -- note that this does not cover every permutation only features in independence
 -- for example store in most cases is just by player name, but other store methods are tested with checkbox
-local Gui = require 'expcore.gui'
-local format_chat_colour,table_keys = ext_require('expcore.common','format_chat_colour','table_keys')
-local Colors = require 'resources.color_presets'
-local Event = require 'utils.event'
-local Store = require 'expcore.store'
+local Gui = require 'expcore.gui' --- @dep expcore.gui
+local format_chat_colour,table_keys = ext_require('expcore.common','format_chat_colour','table_keys') --- @dep expcore.common
+local Colors = require 'resources.color_presets' --- @dep resources.color_presets
+local Event = require 'utils.event' --- @dep utils.event
+local Store = require 'expcore.store' --- @dep expcore.store
 
 local tests = {}
 

expcore/permission_groups.lua

@@ -49,9 +49,9 @@
 ]]
 
 
-local Game = require 'utils.game'
-local Event = require 'utils.event'
-local Sudo = require 'expcore.sudo'
+local Game = require 'utils.game' --- @dep utils.game
+local Event = require 'utils.event' --- @dep utils.event
+local Sudo = require 'expcore.sudo' --- @dep expcore.sudo
 
 local Permissions_Groups = {
     groups={}, -- store for the different groups that are created

expcore/roles.lua

@@ -154,13 +154,13 @@
     Roles._prototype:print(message) --- Will print a message to all players with this role
 ]]
 
-local Game = require 'utils.game'
-local Global = require 'utils.global'
-local Event = require 'utils.event'
-local Groups = require 'expcore.permission_groups'
-local Sudo = require 'expcore.sudo'
-local Colours = require 'resources.color_presets'
-local write_json = ext_require('expcore.common','write_json')
+local Game = require 'utils.game' --- @dep utils.game
+local Global = require 'utils.global' --- @dep utils.global
+local Event = require 'utils.event' --- @dep utils.event
+local Groups = require 'expcore.permission_groups' --- @dep expcore.permission_groups
+local Sudo = require 'expcore.sudo' --- @dep expcore.sudo
+local Colours = require 'resources.color_presets' --- @dep resources.color_presets
+local write_json = ext_require('expcore.common','write_json') --- @dep expcore.common
 
 local Roles = {
     _prototype={},

expcore/store.lua

@@ -69,10 +69,10 @@
 
 ]]
 
-local Global = require 'utils.global'
-local Event = require 'utils.event'
-local table_keys,write_json = ext_require('expcore.common','table_keys','write_json')
-local Token = require 'utils.token'
+local Global = require 'utils.global' --- @dep utils.global
+local Event = require 'utils.event' --- @dep utils.event
+local table_keys,write_json = ext_require('expcore.common','table_keys','write_json') --- @dep expcore.common
+local Token = require 'utils.token' --- @dep utils.token
 
 local Store = {
     data={},

expcore/sudo.lua

@@ -20,8 +20,8 @@
     Sudo.get(name) --- Gets the function that is registered under the given name
     Sudo.run(name,...) --- Runs the function that is registered under the given name, you may supply any number of params as needed
 ]]
-local Task = require 'utils.task'
-local Token = require 'utils.token'
+local Task = require 'utils.task' --- @dep utils.task
+local Token = require 'utils.token' --- @dep utils.token
 
 local Sudo = {
     tokens={}