Merge branch 'explosivegaming:main' into aperx

exp_legacy/module/config/chat_reply.lua

@@ -24,6 +24,7 @@ local afk_time_units = {
 }
 
 return {
+    --- @type table<string, LocalisedString | fun(player: LuaPlayer, is_command: boolean): LocalisedString>
     messages = { --- @setting messages will trigger when ever the word is said
         ["discord"] = { "info.discord" },
         ["expgaming"] = { "info.website" },
@@ -66,6 +67,7 @@ return {
     command_admin_only = false, --- @setting command_admin_only when true will only allow chat commands for admins
     command_permission = "command/chat-commands", --- @setting command_permission the permission used to allow command prefixes
     command_prefix = "!", --- @setting command_prefix prefix used for commands below and to print to all players (if enabled above)
+    --- @type table<string, LocalisedString | fun(player: LuaPlayer, is_command: boolean): LocalisedString>
     commands = { --- @setting commands will trigger only when command prefix is given
         ["dev"] = { "exp_chat-auto-reply.reply-dev" },
         ["magic"] = { "exp_chat-auto-reply.reply-magic" },

exp_legacy/module/config/gui/player_list_actions.lua

@@ -15,7 +15,8 @@ local Colors = require("modules/exp_util/include/color")
 local format_player_name = ExpUtil.format_player_name_locale
 
 --- Accessors injected by the gui so the actions can read the selected player and set the selected action
-local get_selected_player, set_selected_action
+local get_selected_player --- @type fun(player: LuaPlayer): LuaPlayer
+local set_selected_action --- @type fun(player: LuaPlayer, action: string?)
 local function set_accessors(player_getter, action_setter)
     get_selected_player, set_selected_action = player_getter, action_setter
 end
@@ -31,7 +32,7 @@ end
 
 -- gets the action player and a coloured name for the action to be used on
 local function get_action_player(player)
-    local selected_player = get_selected_player(player) --[[ @as LuaPlayer ]]
+    local selected_player = get_selected_player(player) --[[@as LuaPlayer]]
     local selected_player_color = format_player_name(selected_player)
     return selected_player, selected_player_color
 end

exp_legacy/module/config/spawn_area.lua

@@ -87,7 +87,7 @@ return {
                 amount = 4000,
                 size = { 26, 27 },
                 -- offset = {-64,-32}
-                offset = { -64, -64 },
+                offset = { x = -64, y = -64 },
             },
             {
                 enabled = false,
@@ -95,7 +95,7 @@ return {
                 amount = 4000,
                 size = { 26, 27 },
                 -- offset = {-64, 0}
-                offset = { 64, -64 },
+                offset = { x = 64, y = -64 },
             },
             {
                 enabled = false,
@@ -103,7 +103,7 @@ return {
                 amount = 4000,
                 size = { 22, 20 },
                 -- offset = {-64, 32}
-                offset = { -64, 64 },
+                offset = { x = -64, y = 64 },
             },
             {
                 enabled = false,
@@ -111,7 +111,7 @@ return {
                 amount = 4000,
                 size = { 22, 20 },
                 -- offset = {-64, -64}
-                offset = { 64, 64 },
+                offset = { x = 64, y = 64 },
             },
             {
                 enabled = false,
@@ -119,7 +119,7 @@ return {
                 amount = 4000,
                 size = { 22, 20 },
                 -- offset = {-64, -96}
-                offset = { 0, 64 },
+                offset = { x = 0, y = 64 },
             },
         },
     },
@@ -132,7 +132,7 @@ return {
                 num_patches = 4,
                 amount = 4000000,
                 -- offset = {-80, -12},
-                offset = { -12, 64 },
+                offset = { x = -12, y = 64 },
                 -- offset_next = {0, 6}
                 offset_next = { 6, 0 },
             },

exp_legacy/module/config/vlayer.lua

@@ -35,6 +35,20 @@ return {
         storage_output = 1, -- >0 allows for item teleportation (allowed_items only)
     },
 
+    --- @class Vlayer.ItemProperties
+    --- @field starting_value number
+    --- @field required_area number
+    --- @field production number?
+    --- @field discharge number?
+    --- @field capacity number?
+    --- @field surface_area number?
+    --- @field fuel_value number?
+    --- @field power boolean?
+    --- @field modded boolean? Set when the item is registered from a modded equivalent
+    --- @field base_game_equivalent string?
+    --- @field multiplier number?
+
+    --- @type table<string, Vlayer.ItemProperties>
     allowed_items = { --- @setting allowed_items List of all items allowed in vlayer storage and their properties
         --[[
             Allowed properties:

exp_legacy/module/config/warnings.lua

@@ -2,6 +2,7 @@
 -- @config Warnings
 
 return {
+    --- @type (LocalisedString[] | fun(player: LuaPlayer, by_player_name: string, number_of_warnings: number))[]
     actions = { --- @setting actions what actions are taking at number of warnings
         -- if a localized string is used then __1__ will by_player_name and __2__ will be the current warning count (auto inserted)
         { "warnings.received", "" },