From f5619165f6f7290289e81577413e39c8a6ed73e0 Mon Sep 17 00:00:00 2001 From: Cooldude2606 Date: Sat, 20 Jul 2019 23:44:48 +0100 Subject: [PATCH] Added production to control --- config/action_buttons.lua | 2 +- config/science.lua | 4 +- doc/config.ld | 12 +- doc/control/Jail.html | 1169 +++++ doc/control/Production.html | 1284 +++++ doc/control/Reports.html | 1033 ++++ doc/control/Warnings.html | 1426 ++++++ doc/index.html | 42 +- doc/ldoc.ltp | 26 +- doc/modules/Jail.html | 316 +- doc/modules/Production.html | 1281 +++++ doc/modules/Reports.html | 547 ++- doc/modules/Warnings.html | 702 +-- doc/modules/config._file_loader.html | 22 +- doc/modules/config.action_buttons.html | 22 +- doc/modules/config.advanced_start.html | 22 +- doc/modules/config.bonuses.html | 22 +- doc/modules/config.chat_reply.html | 22 +- doc/modules/config.death_logger.html | 22 +- doc/modules/config.discord_alerts.html | 22 +- .../config.expcore-commands.auth_admin.html | 22 +- .../config.expcore-commands.auth_roles.html | 22 +- ...expcore-commands.auth_runtime_disable.html | 22 +- ...config.expcore-commands.parse_general.html | 22 +- .../config.expcore-commands.parse_roles.html | 22 +- doc/modules/config.permission_groups.html | 22 +- doc/modules/config.popup_messages.html | 22 +- doc/modules/config.rockets.html | 54 +- doc/modules/config.roles.html | 22 +- doc/modules/config.scorched_earth.html | 22 +- doc/modules/config.spawn_area.html | 22 +- doc/modules/config.warnings.html | 22 +- doc/modules/config.warps.html | 22 +- doc/modules/control.html | 22 +- doc/modules/expcore.commands.html | 22 +- doc/modules/expcore.common.html | 1876 ++++---- doc/modules/expcore.gui.concepts.center.html | 778 ++-- doc/modules/expcore.gui.concepts.left.html | 1426 +++--- doc/modules/expcore.gui.concepts.popups.html | 493 +- doc/modules/expcore.gui.concepts.toolbar.html | 150 +- doc/modules/expcore.gui.core.html | 22 +- doc/modules/expcore.gui.elements.buttons.html | 262 +- .../expcore.gui.elements.checkboxs.html | 362 +- .../expcore.gui.elements.dropdown.html | 272 +- .../expcore.gui.elements.elem-button.html | 159 +- .../expcore.gui.elements.progress-bar.html | 884 ++-- doc/modules/expcore.gui.elements.slider.html | 204 +- doc/modules/expcore.gui.elements.text.html | 216 +- doc/modules/expcore.gui.html | 22 +- doc/modules/expcore.gui.instances.html | 22 +- doc/modules/expcore.gui.prototype.html | 1369 +++--- doc/modules/expcore.gui.test.html | 22 +- doc/modules/expcore.permission_groups.html | 1528 +++--- doc/modules/expcore.roles.html | 4144 +++++++++-------- doc/modules/expcore.store.html | 564 +-- doc/modules/expcore.sudo.html | 22 +- .../modules.addons.advanced-start.html | 22 +- doc/modules/modules.addons.chat-popups.html | 22 +- doc/modules/modules.addons.damage-popups.html | 22 +- doc/modules/modules.control.production.html | 1281 +++++ doc/modules/modules.control.reports.html | 1026 ++++ doc/modules/modules.control.warnings.html | 1416 ++++++ doc/modules/modules.gui.player-list.html | 22 +- doc/modules/modules.gui.rocket-info.html | 34 +- doc/modules/modules.gui.science-info.html | 22 +- doc/modules/modules.gui.task-list.html | 22 +- .../utils.alien_evolution_progress.html | 38 +- doc/modules/utils.core.html | 873 ++-- doc/modules/utils.debug.html | 318 +- doc/modules/utils.event.html | 826 ++-- doc/modules/utils.event_core.html | 46 +- doc/modules/utils.math.html | 38 +- doc/modules/utils.recipe_locker.html | 38 +- doc/modules/utils.state_machine.html | 212 +- doc/modules/utils.table.html | 1341 +++--- doc/modules/utils.task.html | 206 +- doc/modules/utils.timestamp.html | 160 +- doc/topics/license.html | 23 +- doc/topics/readme.md.html | 23 +- modules/addons/discord-alerts.lua | 2 +- modules/commands/warnings.lua | 2 +- modules/control/jail.lua | 17 +- modules/control/production.lua | 237 + modules/control/reports.lua | 13 +- modules/control/warnings.lua | 13 +- modules/gui/science-info.lua | 101 +- old/locale/en/DeconControl.cfg | 3 - old/locale/en/ExpGamingAdmin.AdminLib.cfg | 21 - old/locale/en/ExpGamingAdmin.Warnings.cfg | 10 - old/locale/en/ExpGamingAdmin.cfg | 21 - old/locale/en/ExpGamingBot.autoChat.cfg | 48 - old/locale/en/ExpGamingBot.autoMessage.cfg | 9 - old/locale/en/ExpGamingCommands.home.cfg | 9 - old/locale/en/ExpGamingCore.Command.cfg | 14 - old/locale/en/ExpGamingCore.Gui.cfg | 4 - old/locale/en/ExpGamingCore.Ranking.cfg | 7 - old/locale/en/ExpGamingCore.Role.cfg | 6 - old/locale/en/ExpGamingCore.Server.cfg | 2 - old/locale/en/ExpGamingInfo.Readme.cfg | 69 - old/locale/en/ExpGamingInfo.Rockets.cfg | 12 - old/locale/en/ExpGamingInfo.Science.cfg | 14 - old/locale/en/ExpGamingInfo.Tasklist.cfg | 4 - .../en/ExpGamingPlayer.inventorySearch.cfg | 4 - old/locale/en/ExpGamingPlayer.playerInfo.cfg | 9 - old/locale/en/ExpGamingPlayer.playerList.cfg | 5 - old/locale/en/ExpGamingPlayer.polls.cfg | 7 - old/locale/en/GameSettingsGui.cfg | 32 - old/locale/en/GuiAnnouncements.cfg | 6 - old/locale/en/WarpPoints.cfg | 10 - old/locale/fr/DeconControl.cfg | 3 - old/locale/fr/ExpGamingAdmin.AdminLib.cfg | 15 - old/locale/fr/ExpGamingAdmin.Warnings.cfg | 11 - old/locale/fr/ExpGamingAdmin.cfg | 15 - old/locale/fr/ExpGamingBot.autoChat.cfg | 20 - old/locale/fr/ExpGamingBot.autoMessage.cfg | 9 - old/locale/fr/ExpGamingCore.Command.cfg | 9 - old/locale/fr/ExpGamingCore.Commands.cfg | 9 - old/locale/fr/ExpGamingCore.Gui.cfg | 4 - old/locale/fr/ExpGamingCore.Ranking.cfg | 7 - old/locale/fr/ExpGamingInfo.Readme.cfg | 68 - old/locale/fr/ExpGamingInfo.Rockets.cfg | 12 - old/locale/fr/ExpGamingInfo.Science.cfg | 14 - old/locale/fr/ExpGamingInfo.Tasklist.cfg | 4 - .../fr/ExpGamingPlayer.inventorySearch.cfg | 4 - old/locale/fr/ExpGamingPlayer.playerInfo.cfg | 8 - old/locale/fr/ExpGamingPlayer.playerList.cfg | 5 - old/locale/fr/ExpGamingPlayer.polls.cfg | 7 - old/locale/fr/GameSettingsGui.cfg | 31 - old/locale/fr/GuiAnnouncements.cfg | 6 - old/locale/fr/WarpPoints.cfg | 9 - old/locale/nl/DeconControl.cfg | 3 - old/locale/nl/ExpGamingAdmin.AdminLib.cfg | 15 - old/locale/nl/ExpGamingAdmin.Warnings.cfg | 11 - old/locale/nl/ExpGamingAdmin.cfg | 15 - old/locale/nl/ExpGamingBot.autoChat.cfg | 20 - old/locale/nl/ExpGamingBot.autoMessage.cfg | 9 - old/locale/nl/ExpGamingCore.Command.cfg | 9 - old/locale/nl/ExpGamingCore.Commands.cfg | 9 - old/locale/nl/ExpGamingCore.Gui.cfg | 4 - old/locale/nl/ExpGamingCore.Ranking.cfg | 7 - old/locale/nl/ExpGamingInfo.Readme.cfg | 68 - old/locale/nl/ExpGamingInfo.Rockets.cfg | 12 - old/locale/nl/ExpGamingInfo.Science.cfg | 14 - old/locale/nl/ExpGamingInfo.Tasklist.cfg | 4 - .../nl/ExpGamingPlayer.inventorySearch.cfg | 4 - old/locale/nl/ExpGamingPlayer.playerInfo.cfg | 8 - old/locale/nl/ExpGamingPlayer.playerList.cfg | 5 - old/locale/nl/ExpGamingPlayer.polls.cfg | 7 - old/locale/nl/GameSettingsGui.cfg | 31 - old/locale/nl/GuiAnnouncements.cfg | 6 - old/locale/nl/WarpPoints.cfg | 9 - old/locale/sv-SE/DeconControl.cfg | 3 - old/locale/sv-SE/ExpGamingAdmin.AdminLib.cfg | 19 - old/locale/sv-SE/ExpGamingAdmin.Warnings.cfg | 10 - old/locale/sv-SE/ExpGamingAdmin.cfg | 19 - old/locale/sv-SE/ExpGamingBot.autoChat.cfg | 25 - old/locale/sv-SE/ExpGamingBot.autoMessage.cfg | 10 - old/locale/sv-SE/ExpGamingCore.Command.cfg | 9 - old/locale/sv-SE/ExpGamingCore.Commands.cfg | 9 - old/locale/sv-SE/ExpGamingCore.Gui.cfg | 4 - old/locale/sv-SE/ExpGamingCore.Ranking.cfg | 7 - old/locale/sv-SE/ExpGamingInfo.Readme.cfg | 69 - old/locale/sv-SE/ExpGamingInfo.Rockets.cfg | 13 - old/locale/sv-SE/ExpGamingInfo.Science.cfg | 14 - old/locale/sv-SE/ExpGamingInfo.Tasklist.cfg | 4 - .../sv-SE/ExpGamingPlayer.inventorySearch.cfg | 4 - .../sv-SE/ExpGamingPlayer.playerInfo.cfg | 8 - .../sv-SE/ExpGamingPlayer.playerList.cfg | 5 - old/locale/sv-SE/ExpGamingPlayer.polls.cfg | 7 - old/locale/sv-SE/GameSettingsGui.cfg | 31 - old/locale/sv-SE/GuiAnnouncements.cfg | 7 - old/locale/sv-SE/WarpPoints.cfg | 9 - .../DONE/AdvancedStartingItems/control.lua | 45 - .../DONE/AdvancedStartingItems/softmod.json | 20 - old/modules/DONE/Bot/autoChat/control.lua | 166 - old/modules/DONE/Bot/autoChat/locale/de.cfg | 20 - old/modules/DONE/Bot/autoChat/locale/en.cfg | 48 - old/modules/DONE/Bot/autoChat/locale/fr.cfg | 20 - old/modules/DONE/Bot/autoChat/locale/nl.cfg | 20 - .../DONE/Bot/autoChat/locale/sv-SE.cfg | 25 - old/modules/DONE/Bot/autoChat/softmod.json | 19 - old/modules/DONE/Bot/autoMessage/control.lua | 74 - .../DONE/Bot/autoMessage/locale/de.cfg | 9 - .../DONE/Bot/autoMessage/locale/en.cfg | 9 - .../DONE/Bot/autoMessage/locale/fr.cfg | 9 - .../DONE/Bot/autoMessage/locale/nl.cfg | 9 - .../DONE/Bot/autoMessage/locale/sv-SE.cfg | 10 - old/modules/DONE/Bot/autoMessage/softmod.json | 20 - .../DONE/Bot/discordAlerts/control.lua | 63 - .../DONE/Bot/discordAlerts/softmod.json | 20 - old/modules/DONE/ChatPopup/control.lua | 57 - old/modules/DONE/ChatPopup/softmod.json | 21 - .../Commands/ExpGamingCommands/softmod.json | 25 - .../DONE/Commands/cheatMode/control.lua | 14 - .../DONE/Commands/cheatMode/softmod.json | 19 - old/modules/DONE/Commands/home/control.lua | 48 - old/modules/DONE/Commands/home/locale/en.cfg | 9 - old/modules/DONE/Commands/home/softmod.json | 20 - old/modules/DONE/Commands/kill/control.lua | 18 - old/modules/DONE/Commands/kill/softmod.json | 21 - old/modules/DONE/Commands/repair/control.lua | 68 - old/modules/DONE/Commands/repair/softmod.json | 22 - .../DONE/Commands/repair/src/tempban.lua | 7 - old/modules/DONE/Commands/tags/control.lua | 45 - old/modules/DONE/Commands/tags/softmod.json | 20 - .../DONE/Commands/teleport/control.lua | 35 - .../DONE/Commands/teleport/softmod.json | 23 - old/modules/DONE/Core/Command/control.lua | 298 -- old/modules/DONE/Core/Command/softmod.json | 21 - old/modules/DONE/Core/Group/config.lua | 81 - old/modules/DONE/Core/Group/control.lua | 189 - old/modules/DONE/Core/Group/softmod.json | 22 - old/modules/DONE/Core/Gui/center/control.lua | 221 - old/modules/DONE/Core/Gui/center/softmod.json | 24 - old/modules/DONE/Core/Gui/control.lua | 190 - old/modules/DONE/Core/Gui/inputs/control.lua | 375 -- old/modules/DONE/Core/Gui/inputs/softmod.json | 23 - old/modules/DONE/Core/Gui/left/control.lua | 246 - .../DONE/Core/Gui/left/order_config.lua | 13 - old/modules/DONE/Core/Gui/left/softmod.json | 26 - old/modules/DONE/Core/Gui/locale/de.cfg | 4 - old/modules/DONE/Core/Gui/locale/en.cfg | 4 - old/modules/DONE/Core/Gui/locale/fr.cfg | 4 - old/modules/DONE/Core/Gui/locale/nl.cfg | 4 - old/modules/DONE/Core/Gui/locale/sv-SE.cfg | 4 - old/modules/DONE/Core/Gui/popup/control.lua | 130 - old/modules/DONE/Core/Gui/popup/softmod.json | 24 - old/modules/DONE/Core/Gui/softmod.json | 29 - old/modules/DONE/Core/Gui/src/server.lua | 40 - old/modules/DONE/Core/Gui/src/test.lua | 187 - old/modules/DONE/Core/Gui/toolbar/control.lua | 90 - .../DONE/Core/Gui/toolbar/order_config.lua | 13 - .../DONE/Core/Gui/toolbar/softmod.json | 23 - old/modules/DONE/Core/Role/config.lua | 284 -- old/modules/DONE/Core/Role/control.lua | 532 --- old/modules/DONE/Core/Role/locale/en.cfg | 6 - old/modules/DONE/Core/Role/softmod.json | 24 - old/modules/DONE/Core/Role/src/commands.lua | 28 - old/modules/DONE/Core/Role/src/sync.lua | 82 - old/modules/DONE/DamagePopup/control.lua | 45 - old/modules/DONE/DamagePopup/softmod.json | 19 - old/modules/DONE/DeathMarkers/control.lua | 46 - old/modules/DONE/DeathMarkers/softmod.json | 17 - old/modules/DONE/ExpAdmin/Ban/control.lua | 49 - old/modules/DONE/ExpAdmin/Ban/softmod.json | 23 - .../DONE/ExpAdmin/ClearInventory/control.lua | 58 - .../DONE/ExpAdmin/ClearInventory/softmod.json | 20 - .../DONE/ExpAdmin/Commands/control.lua | 25 - .../DONE/ExpAdmin/Commands/softmod.json | 29 - .../DONE/ExpAdmin/Commands/src/clear.lua | 12 - .../DONE/ExpAdmin/Commands/src/jail.lua | 30 - .../DONE/ExpAdmin/Commands/src/reports.lua | 35 - .../DONE/ExpAdmin/Commands/src/tempban.lua | 15 - .../DONE/ExpAdmin/Commands/src/warnings.lua | 28 - old/modules/DONE/ExpAdmin/Jail/control.lua | 51 - old/modules/DONE/ExpAdmin/Jail/softmod.json | 24 - old/modules/DONE/ExpAdmin/Kick/control.lua | 47 - old/modules/DONE/ExpAdmin/Kick/softmod.json | 23 - old/modules/DONE/ExpAdmin/Reports/control.lua | 163 - .../DONE/ExpAdmin/Reports/softmod.json | 25 - .../DONE/ExpAdmin/Teleport/control.lua | 43 - .../DONE/ExpAdmin/Teleport/softmod.json | 22 - old/modules/DONE/ExpAdmin/TempBan/control.lua | 48 - .../DONE/ExpAdmin/TempBan/softmod.json | 24 - .../DONE/ExpAdmin/Warnings/control.lua | 142 - .../DONE/ExpAdmin/Warnings/locale/de.cfg | 11 - .../DONE/ExpAdmin/Warnings/locale/en.cfg | 10 - .../DONE/ExpAdmin/Warnings/locale/fr.cfg | 11 - .../DONE/ExpAdmin/Warnings/locale/nl.cfg | 11 - .../DONE/ExpAdmin/Warnings/locale/sv-SE.cfg | 10 - .../DONE/ExpAdmin/Warnings/softmod.json | 26 - old/modules/DONE/ExpGamingBot/softmod.json | 22 - old/modules/DONE/ExpGamingLib/control.lua | 330 -- old/modules/DONE/ExpGamingLib/softmod.json | 19 - .../DONE/FactorioStdLib/Color/control.lua | 232 - .../DONE/FactorioStdLib/Color/softmod.json | 16 - .../DONE/FactorioStdLib/Game/control.lua | 110 - .../DONE/FactorioStdLib/Game/softmod.json | 16 - .../DONE/FactorioStdLib/String/control.lua | 86 - .../DONE/FactorioStdLib/String/softmod.json | 16 - .../DONE/FactorioStdLib/Table/control.lua | 423 -- .../DONE/FactorioStdLib/Table/softmod.json | 16 - old/modules/DONE/FactorioStdLib/softmod.json | 21 - .../DONE/Guis/ExpGamingAdmin/Gui/control.lua | 202 - .../DONE/Guis/ExpGamingAdmin/Gui/softmod.json | 23 - .../DONE/Guis/ExpGamingAdmin/control.lua | 103 - .../DONE/Guis/ExpGamingAdmin/locale/de.cfg | 15 - .../DONE/Guis/ExpGamingAdmin/locale/en.cfg | 21 - .../DONE/Guis/ExpGamingAdmin/locale/fr.cfg | 15 - .../DONE/Guis/ExpGamingAdmin/locale/nl.cfg | 15 - .../DONE/Guis/ExpGamingAdmin/locale/sv-SE.cfg | 19 - .../DONE/Guis/ExpGamingAdmin/softmod.json | 37 - old/modules/DONE/Guis/Rockets/control.lua | 105 - old/modules/DONE/Guis/Rockets/locale/de.cfg | 12 - old/modules/DONE/Guis/Rockets/locale/en.cfg | 12 - old/modules/DONE/Guis/Rockets/locale/fr.cfg | 12 - old/modules/DONE/Guis/Rockets/locale/nl.cfg | 12 - .../DONE/Guis/Rockets/locale/sv-SE.cfg | 13 - old/modules/DONE/Guis/Rockets/softmod.json | 23 - old/modules/DONE/Guis/Rockets/src/sync.lua | 20 - old/modules/DONE/Guis/Science/control.lua | 106 - old/modules/DONE/Guis/Science/locale/de.cfg | 14 - old/modules/DONE/Guis/Science/locale/en.cfg | 14 - old/modules/DONE/Guis/Science/locale/fr.cfg | 14 - old/modules/DONE/Guis/Science/locale/nl.cfg | 14 - .../DONE/Guis/Science/locale/sv-Se.cfg | 14 - old/modules/DONE/Guis/Science/softmod.json | 24 - old/modules/DONE/Guis/Science/src/sync.lua | 19 - old/modules/DONE/Guis/Tasklist/control.lua | 207 - old/modules/DONE/Guis/Tasklist/locale/de.cfg | 4 - old/modules/DONE/Guis/Tasklist/locale/en.cfg | 4 - old/modules/DONE/Guis/Tasklist/locale/fr.cfg | 4 - old/modules/DONE/Guis/Tasklist/locale/nl.cfg | 4 - .../DONE/Guis/Tasklist/locale/sv-SE.cfg | 4 - old/modules/DONE/Guis/Tasklist/softmod.json | 22 - old/modules/DONE/Guis/playerList/control.lua | 145 - .../DONE/Guis/playerList/locale/de.cfg | 5 - .../DONE/Guis/playerList/locale/en.cfg | 5 - .../DONE/Guis/playerList/locale/fr.cfg | 5 - .../DONE/Guis/playerList/locale/nl.cfg | 5 - .../DONE/Guis/playerList/locale/sv-SE.cfg | 5 - old/modules/DONE/Guis/playerList/softmod.json | 24 - .../DONE/Guis/playerList/src/ranking.lua | 15 - old/modules/DONE/PlayerAutoColor/control.lua | 48 - old/modules/DONE/PlayerAutoColor/softmod.json | 19 - old/modules/DONE/SpawnArea/control.lua | 127 - old/modules/DONE/SpawnArea/softmod.json | 19 - .../DONE/SpawnArea/src/spawn_entities.lua | 16 - .../DONE/SpawnArea/src/spawn_tiles.lua | 109 - old/modules/DONE/WarpPoints/control.lua | 250 - old/modules/DONE/WarpPoints/locale/de.cfg | 9 - old/modules/DONE/WarpPoints/locale/en.cfg | 10 - old/modules/DONE/WarpPoints/locale/fr.cfg | 9 - old/modules/DONE/WarpPoints/locale/nl.cfg | 9 - old/modules/DONE/WarpPoints/locale/sv-SE.cfg | 9 - old/modules/DONE/WarpPoints/softmod.json | 22 - old/modules/DONE/WarpPoints/src/commands.lua | 21 - .../DONE/WarpPoints/src/warp_entities.lua | 5 - .../DONE/WarpPoints/src/warp_tiles.lua | 4 - old/modules/DONE/WornPaths/control.lua | 105 - old/modules/DONE/WornPaths/softmod.json | 19 - old/modules/DONE/WornPaths/src/entites.lua | 31 - old/modules/DONE/WornPaths/src/paths.lua | 27 - old/modules/DONE/WornPaths/src/placed.lua | 9 - old/modules/DeconControl/control.lua | 72 - old/modules/DeconControl/locale/de.cfg | 3 - old/modules/DeconControl/locale/en.cfg | 3 - old/modules/DeconControl/locale/fr.cfg | 3 - old/modules/DeconControl/locale/nl.cfg | 3 - old/modules/DeconControl/locale/sv-SE.cfg | 3 - old/modules/DeconControl/softmod.json | 26 - old/modules/ExpGamingCore/Server/control.lua | 562 --- old/modules/ExpGamingCore/Server/softmod.json | 26 - .../ExpGamingCore/Server/src/commands.lua | 49 - old/modules/ExpGamingCore/Sync/control.lua | 338 -- old/modules/ExpGamingCore/Sync/softmod.json | 27 - old/modules/ExpGamingCore/Sync/src/gui.lua | 106 - old/modules/ExpGamingCore/Sync/src/logo.png | Bin 15942 -> 0 bytes old/modules/ExpGamingCore/softmod.json | 24 - old/modules/ExpGamingInfo/Readme/control.lua | 132 - .../ExpGamingInfo/Readme/locale/de.cfg | 68 - .../ExpGamingInfo/Readme/locale/en.cfg | 69 - .../ExpGamingInfo/Readme/locale/fr.cfg | 68 - .../ExpGamingInfo/Readme/locale/nl.cfg | 68 - .../ExpGamingInfo/Readme/locale/sv-SE.cfg | 69 - old/modules/ExpGamingInfo/Readme/softmod.json | 23 - old/modules/ExpGamingInfo/Readme/src/sync.lua | 14 - old/modules/ExpGamingInfo/softmod.json | 21 - .../ExpGamingPlayer/afkKick/control.lua | 37 - .../ExpGamingPlayer/afkKick/softmod.json | 22 - .../ExpGamingPlayer/afkKick/src/server.lua | 29 - .../inventorySearch/control.lua | 92 - .../inventorySearch/locale/de.cfg | 4 - .../inventorySearch/locale/en.cfg | 4 - .../inventorySearch/locale/fr.cfg | 4 - .../inventorySearch/locale/nl.cfg | 4 - .../inventorySearch/locale/sv-SE.cfg | 4 - .../inventorySearch/softmod.json | 22 - .../ExpGamingPlayer/playerInfo/control.lua | 58 - .../ExpGamingPlayer/playerInfo/locale/de.cfg | 8 - .../ExpGamingPlayer/playerInfo/locale/en.cfg | 9 - .../ExpGamingPlayer/playerInfo/locale/fr.cfg | 8 - .../ExpGamingPlayer/playerInfo/locale/nl.cfg | 8 - .../playerInfo/locale/sv-SE.cfg | 8 - .../ExpGamingPlayer/playerInfo/softmod.json | 21 - old/modules/ExpGamingPlayer/polls/control.lua | 274 -- .../ExpGamingPlayer/polls/locale/de.cfg | 7 - .../ExpGamingPlayer/polls/locale/en.cfg | 7 - .../ExpGamingPlayer/polls/locale/fr.cfg | 7 - .../ExpGamingPlayer/polls/locale/nl.cfg | 7 - .../ExpGamingPlayer/polls/locale/sv-SE.cfg | 7 - .../ExpGamingPlayer/polls/softmod.json | 19 - old/modules/ExpGamingPlayer/softmod.json | 23 - old/modules/GameSettingsGui/control.lua | 193 - old/modules/GameSettingsGui/locale/de.cfg | 31 - old/modules/GameSettingsGui/locale/en.cfg | 32 - old/modules/GameSettingsGui/locale/fr.cfg | 31 - old/modules/GameSettingsGui/locale/nl.cfg | 31 - old/modules/GameSettingsGui/locale/sv-SE.cfg | 31 - old/modules/GameSettingsGui/softmod.json | 21 - old/modules/GuiAnnouncements/control.lua | 110 - old/modules/GuiAnnouncements/locale/de.cfg | 6 - old/modules/GuiAnnouncements/locale/en.cfg | 6 - old/modules/GuiAnnouncements/locale/fr.cfg | 6 - old/modules/GuiAnnouncements/locale/nl.cfg | 6 - old/modules/GuiAnnouncements/locale/sv-SE.cfg | 7 - old/modules/GuiAnnouncements/softmod.json | 20 - old/modules/index.lua | 67 - old/modules/softmod.json | 33 - 409 files changed, 21360 insertions(+), 23447 deletions(-) create mode 100644 doc/control/Jail.html create mode 100644 doc/control/Production.html create mode 100644 doc/control/Reports.html create mode 100644 doc/control/Warnings.html create mode 100644 doc/modules/Production.html create mode 100644 doc/modules/modules.control.production.html create mode 100644 doc/modules/modules.control.reports.html create mode 100644 doc/modules/modules.control.warnings.html create mode 100644 modules/control/production.lua delete mode 100644 old/locale/en/DeconControl.cfg delete mode 100644 old/locale/en/ExpGamingAdmin.AdminLib.cfg delete mode 100644 old/locale/en/ExpGamingAdmin.Warnings.cfg delete mode 100644 old/locale/en/ExpGamingAdmin.cfg delete mode 100644 old/locale/en/ExpGamingBot.autoChat.cfg delete mode 100644 old/locale/en/ExpGamingBot.autoMessage.cfg delete mode 100644 old/locale/en/ExpGamingCommands.home.cfg delete mode 100644 old/locale/en/ExpGamingCore.Command.cfg delete mode 100644 old/locale/en/ExpGamingCore.Gui.cfg delete mode 100644 old/locale/en/ExpGamingCore.Ranking.cfg delete mode 100644 old/locale/en/ExpGamingCore.Role.cfg delete mode 100644 old/locale/en/ExpGamingCore.Server.cfg delete mode 100644 old/locale/en/ExpGamingInfo.Readme.cfg delete mode 100644 old/locale/en/ExpGamingInfo.Rockets.cfg delete mode 100644 old/locale/en/ExpGamingInfo.Science.cfg delete mode 100644 old/locale/en/ExpGamingInfo.Tasklist.cfg delete mode 100644 old/locale/en/ExpGamingPlayer.inventorySearch.cfg delete mode 100644 old/locale/en/ExpGamingPlayer.playerInfo.cfg delete mode 100644 old/locale/en/ExpGamingPlayer.playerList.cfg delete mode 100644 old/locale/en/ExpGamingPlayer.polls.cfg delete mode 100644 old/locale/en/GameSettingsGui.cfg delete mode 100644 old/locale/en/GuiAnnouncements.cfg delete mode 100644 old/locale/en/WarpPoints.cfg delete mode 100644 old/locale/fr/DeconControl.cfg delete mode 100644 old/locale/fr/ExpGamingAdmin.AdminLib.cfg delete mode 100644 old/locale/fr/ExpGamingAdmin.Warnings.cfg delete mode 100644 old/locale/fr/ExpGamingAdmin.cfg delete mode 100644 old/locale/fr/ExpGamingBot.autoChat.cfg delete mode 100644 old/locale/fr/ExpGamingBot.autoMessage.cfg delete mode 100644 old/locale/fr/ExpGamingCore.Command.cfg delete mode 100644 old/locale/fr/ExpGamingCore.Commands.cfg delete mode 100644 old/locale/fr/ExpGamingCore.Gui.cfg delete mode 100644 old/locale/fr/ExpGamingCore.Ranking.cfg delete mode 100644 old/locale/fr/ExpGamingInfo.Readme.cfg delete mode 100644 old/locale/fr/ExpGamingInfo.Rockets.cfg delete mode 100644 old/locale/fr/ExpGamingInfo.Science.cfg delete mode 100644 old/locale/fr/ExpGamingInfo.Tasklist.cfg delete mode 100644 old/locale/fr/ExpGamingPlayer.inventorySearch.cfg delete mode 100644 old/locale/fr/ExpGamingPlayer.playerInfo.cfg delete mode 100644 old/locale/fr/ExpGamingPlayer.playerList.cfg delete mode 100644 old/locale/fr/ExpGamingPlayer.polls.cfg delete mode 100644 old/locale/fr/GameSettingsGui.cfg delete mode 100644 old/locale/fr/GuiAnnouncements.cfg delete mode 100644 old/locale/fr/WarpPoints.cfg delete mode 100644 old/locale/nl/DeconControl.cfg delete mode 100644 old/locale/nl/ExpGamingAdmin.AdminLib.cfg delete mode 100644 old/locale/nl/ExpGamingAdmin.Warnings.cfg delete mode 100644 old/locale/nl/ExpGamingAdmin.cfg delete mode 100644 old/locale/nl/ExpGamingBot.autoChat.cfg delete mode 100644 old/locale/nl/ExpGamingBot.autoMessage.cfg delete mode 100644 old/locale/nl/ExpGamingCore.Command.cfg delete mode 100644 old/locale/nl/ExpGamingCore.Commands.cfg delete mode 100644 old/locale/nl/ExpGamingCore.Gui.cfg delete mode 100644 old/locale/nl/ExpGamingCore.Ranking.cfg delete mode 100644 old/locale/nl/ExpGamingInfo.Readme.cfg delete mode 100644 old/locale/nl/ExpGamingInfo.Rockets.cfg delete mode 100644 old/locale/nl/ExpGamingInfo.Science.cfg delete mode 100644 old/locale/nl/ExpGamingInfo.Tasklist.cfg delete mode 100644 old/locale/nl/ExpGamingPlayer.inventorySearch.cfg delete mode 100644 old/locale/nl/ExpGamingPlayer.playerInfo.cfg delete mode 100644 old/locale/nl/ExpGamingPlayer.playerList.cfg delete mode 100644 old/locale/nl/ExpGamingPlayer.polls.cfg delete mode 100644 old/locale/nl/GameSettingsGui.cfg delete mode 100644 old/locale/nl/GuiAnnouncements.cfg delete mode 100644 old/locale/nl/WarpPoints.cfg delete mode 100644 old/locale/sv-SE/DeconControl.cfg delete mode 100644 old/locale/sv-SE/ExpGamingAdmin.AdminLib.cfg delete mode 100644 old/locale/sv-SE/ExpGamingAdmin.Warnings.cfg delete mode 100644 old/locale/sv-SE/ExpGamingAdmin.cfg delete mode 100644 old/locale/sv-SE/ExpGamingBot.autoChat.cfg delete mode 100644 old/locale/sv-SE/ExpGamingBot.autoMessage.cfg delete mode 100644 old/locale/sv-SE/ExpGamingCore.Command.cfg delete mode 100644 old/locale/sv-SE/ExpGamingCore.Commands.cfg delete mode 100644 old/locale/sv-SE/ExpGamingCore.Gui.cfg delete mode 100644 old/locale/sv-SE/ExpGamingCore.Ranking.cfg delete mode 100644 old/locale/sv-SE/ExpGamingInfo.Readme.cfg delete mode 100644 old/locale/sv-SE/ExpGamingInfo.Rockets.cfg delete mode 100644 old/locale/sv-SE/ExpGamingInfo.Science.cfg delete mode 100644 old/locale/sv-SE/ExpGamingInfo.Tasklist.cfg delete mode 100644 old/locale/sv-SE/ExpGamingPlayer.inventorySearch.cfg delete mode 100644 old/locale/sv-SE/ExpGamingPlayer.playerInfo.cfg delete mode 100644 old/locale/sv-SE/ExpGamingPlayer.playerList.cfg delete mode 100644 old/locale/sv-SE/ExpGamingPlayer.polls.cfg delete mode 100644 old/locale/sv-SE/GameSettingsGui.cfg delete mode 100644 old/locale/sv-SE/GuiAnnouncements.cfg delete mode 100644 old/locale/sv-SE/WarpPoints.cfg delete mode 100644 old/modules/DONE/AdvancedStartingItems/control.lua delete mode 100644 old/modules/DONE/AdvancedStartingItems/softmod.json delete mode 100644 old/modules/DONE/Bot/autoChat/control.lua delete mode 100644 old/modules/DONE/Bot/autoChat/locale/de.cfg delete mode 100644 old/modules/DONE/Bot/autoChat/locale/en.cfg delete mode 100644 old/modules/DONE/Bot/autoChat/locale/fr.cfg delete mode 100644 old/modules/DONE/Bot/autoChat/locale/nl.cfg delete mode 100644 old/modules/DONE/Bot/autoChat/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Bot/autoChat/softmod.json delete mode 100644 old/modules/DONE/Bot/autoMessage/control.lua delete mode 100644 old/modules/DONE/Bot/autoMessage/locale/de.cfg delete mode 100644 old/modules/DONE/Bot/autoMessage/locale/en.cfg delete mode 100644 old/modules/DONE/Bot/autoMessage/locale/fr.cfg delete mode 100644 old/modules/DONE/Bot/autoMessage/locale/nl.cfg delete mode 100644 old/modules/DONE/Bot/autoMessage/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Bot/autoMessage/softmod.json delete mode 100644 old/modules/DONE/Bot/discordAlerts/control.lua delete mode 100644 old/modules/DONE/Bot/discordAlerts/softmod.json delete mode 100644 old/modules/DONE/ChatPopup/control.lua delete mode 100644 old/modules/DONE/ChatPopup/softmod.json delete mode 100644 old/modules/DONE/Commands/ExpGamingCommands/softmod.json delete mode 100644 old/modules/DONE/Commands/cheatMode/control.lua delete mode 100644 old/modules/DONE/Commands/cheatMode/softmod.json delete mode 100644 old/modules/DONE/Commands/home/control.lua delete mode 100644 old/modules/DONE/Commands/home/locale/en.cfg delete mode 100644 old/modules/DONE/Commands/home/softmod.json delete mode 100644 old/modules/DONE/Commands/kill/control.lua delete mode 100644 old/modules/DONE/Commands/kill/softmod.json delete mode 100644 old/modules/DONE/Commands/repair/control.lua delete mode 100644 old/modules/DONE/Commands/repair/softmod.json delete mode 100644 old/modules/DONE/Commands/repair/src/tempban.lua delete mode 100644 old/modules/DONE/Commands/tags/control.lua delete mode 100644 old/modules/DONE/Commands/tags/softmod.json delete mode 100644 old/modules/DONE/Commands/teleport/control.lua delete mode 100644 old/modules/DONE/Commands/teleport/softmod.json delete mode 100644 old/modules/DONE/Core/Command/control.lua delete mode 100644 old/modules/DONE/Core/Command/softmod.json delete mode 100644 old/modules/DONE/Core/Group/config.lua delete mode 100644 old/modules/DONE/Core/Group/control.lua delete mode 100644 old/modules/DONE/Core/Group/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/center/control.lua delete mode 100644 old/modules/DONE/Core/Gui/center/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/control.lua delete mode 100644 old/modules/DONE/Core/Gui/inputs/control.lua delete mode 100644 old/modules/DONE/Core/Gui/inputs/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/left/control.lua delete mode 100644 old/modules/DONE/Core/Gui/left/order_config.lua delete mode 100644 old/modules/DONE/Core/Gui/left/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/locale/de.cfg delete mode 100644 old/modules/DONE/Core/Gui/locale/en.cfg delete mode 100644 old/modules/DONE/Core/Gui/locale/fr.cfg delete mode 100644 old/modules/DONE/Core/Gui/locale/nl.cfg delete mode 100644 old/modules/DONE/Core/Gui/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Core/Gui/popup/control.lua delete mode 100644 old/modules/DONE/Core/Gui/popup/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/softmod.json delete mode 100644 old/modules/DONE/Core/Gui/src/server.lua delete mode 100644 old/modules/DONE/Core/Gui/src/test.lua delete mode 100644 old/modules/DONE/Core/Gui/toolbar/control.lua delete mode 100644 old/modules/DONE/Core/Gui/toolbar/order_config.lua delete mode 100644 old/modules/DONE/Core/Gui/toolbar/softmod.json delete mode 100644 old/modules/DONE/Core/Role/config.lua delete mode 100644 old/modules/DONE/Core/Role/control.lua delete mode 100644 old/modules/DONE/Core/Role/locale/en.cfg delete mode 100644 old/modules/DONE/Core/Role/softmod.json delete mode 100644 old/modules/DONE/Core/Role/src/commands.lua delete mode 100644 old/modules/DONE/Core/Role/src/sync.lua delete mode 100644 old/modules/DONE/DamagePopup/control.lua delete mode 100644 old/modules/DONE/DamagePopup/softmod.json delete mode 100644 old/modules/DONE/DeathMarkers/control.lua delete mode 100644 old/modules/DONE/DeathMarkers/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Ban/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Ban/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/ClearInventory/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/ClearInventory/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Commands/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Commands/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Commands/src/clear.lua delete mode 100644 old/modules/DONE/ExpAdmin/Commands/src/jail.lua delete mode 100644 old/modules/DONE/ExpAdmin/Commands/src/reports.lua delete mode 100644 old/modules/DONE/ExpAdmin/Commands/src/tempban.lua delete mode 100644 old/modules/DONE/ExpAdmin/Commands/src/warnings.lua delete mode 100644 old/modules/DONE/ExpAdmin/Jail/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Jail/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Kick/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Kick/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Reports/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Reports/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Teleport/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Teleport/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/TempBan/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/TempBan/softmod.json delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/control.lua delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/locale/de.cfg delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/locale/en.cfg delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/locale/fr.cfg delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/locale/nl.cfg delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/ExpAdmin/Warnings/softmod.json delete mode 100644 old/modules/DONE/ExpGamingBot/softmod.json delete mode 100644 old/modules/DONE/ExpGamingLib/control.lua delete mode 100644 old/modules/DONE/ExpGamingLib/softmod.json delete mode 100644 old/modules/DONE/FactorioStdLib/Color/control.lua delete mode 100644 old/modules/DONE/FactorioStdLib/Color/softmod.json delete mode 100644 old/modules/DONE/FactorioStdLib/Game/control.lua delete mode 100644 old/modules/DONE/FactorioStdLib/Game/softmod.json delete mode 100644 old/modules/DONE/FactorioStdLib/String/control.lua delete mode 100644 old/modules/DONE/FactorioStdLib/String/softmod.json delete mode 100644 old/modules/DONE/FactorioStdLib/Table/control.lua delete mode 100644 old/modules/DONE/FactorioStdLib/Table/softmod.json delete mode 100644 old/modules/DONE/FactorioStdLib/softmod.json delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/Gui/control.lua delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/Gui/softmod.json delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/control.lua delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/locale/de.cfg delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/locale/en.cfg delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/locale/fr.cfg delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/locale/nl.cfg delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Guis/ExpGamingAdmin/softmod.json delete mode 100644 old/modules/DONE/Guis/Rockets/control.lua delete mode 100644 old/modules/DONE/Guis/Rockets/locale/de.cfg delete mode 100644 old/modules/DONE/Guis/Rockets/locale/en.cfg delete mode 100644 old/modules/DONE/Guis/Rockets/locale/fr.cfg delete mode 100644 old/modules/DONE/Guis/Rockets/locale/nl.cfg delete mode 100644 old/modules/DONE/Guis/Rockets/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Guis/Rockets/softmod.json delete mode 100644 old/modules/DONE/Guis/Rockets/src/sync.lua delete mode 100644 old/modules/DONE/Guis/Science/control.lua delete mode 100644 old/modules/DONE/Guis/Science/locale/de.cfg delete mode 100644 old/modules/DONE/Guis/Science/locale/en.cfg delete mode 100644 old/modules/DONE/Guis/Science/locale/fr.cfg delete mode 100644 old/modules/DONE/Guis/Science/locale/nl.cfg delete mode 100644 old/modules/DONE/Guis/Science/locale/sv-Se.cfg delete mode 100644 old/modules/DONE/Guis/Science/softmod.json delete mode 100644 old/modules/DONE/Guis/Science/src/sync.lua delete mode 100644 old/modules/DONE/Guis/Tasklist/control.lua delete mode 100644 old/modules/DONE/Guis/Tasklist/locale/de.cfg delete mode 100644 old/modules/DONE/Guis/Tasklist/locale/en.cfg delete mode 100644 old/modules/DONE/Guis/Tasklist/locale/fr.cfg delete mode 100644 old/modules/DONE/Guis/Tasklist/locale/nl.cfg delete mode 100644 old/modules/DONE/Guis/Tasklist/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Guis/Tasklist/softmod.json delete mode 100644 old/modules/DONE/Guis/playerList/control.lua delete mode 100644 old/modules/DONE/Guis/playerList/locale/de.cfg delete mode 100644 old/modules/DONE/Guis/playerList/locale/en.cfg delete mode 100644 old/modules/DONE/Guis/playerList/locale/fr.cfg delete mode 100644 old/modules/DONE/Guis/playerList/locale/nl.cfg delete mode 100644 old/modules/DONE/Guis/playerList/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/Guis/playerList/softmod.json delete mode 100644 old/modules/DONE/Guis/playerList/src/ranking.lua delete mode 100644 old/modules/DONE/PlayerAutoColor/control.lua delete mode 100644 old/modules/DONE/PlayerAutoColor/softmod.json delete mode 100644 old/modules/DONE/SpawnArea/control.lua delete mode 100644 old/modules/DONE/SpawnArea/softmod.json delete mode 100644 old/modules/DONE/SpawnArea/src/spawn_entities.lua delete mode 100644 old/modules/DONE/SpawnArea/src/spawn_tiles.lua delete mode 100644 old/modules/DONE/WarpPoints/control.lua delete mode 100644 old/modules/DONE/WarpPoints/locale/de.cfg delete mode 100644 old/modules/DONE/WarpPoints/locale/en.cfg delete mode 100644 old/modules/DONE/WarpPoints/locale/fr.cfg delete mode 100644 old/modules/DONE/WarpPoints/locale/nl.cfg delete mode 100644 old/modules/DONE/WarpPoints/locale/sv-SE.cfg delete mode 100644 old/modules/DONE/WarpPoints/softmod.json delete mode 100644 old/modules/DONE/WarpPoints/src/commands.lua delete mode 100644 old/modules/DONE/WarpPoints/src/warp_entities.lua delete mode 100644 old/modules/DONE/WarpPoints/src/warp_tiles.lua delete mode 100644 old/modules/DONE/WornPaths/control.lua delete mode 100644 old/modules/DONE/WornPaths/softmod.json delete mode 100644 old/modules/DONE/WornPaths/src/entites.lua delete mode 100644 old/modules/DONE/WornPaths/src/paths.lua delete mode 100644 old/modules/DONE/WornPaths/src/placed.lua delete mode 100644 old/modules/DeconControl/control.lua delete mode 100644 old/modules/DeconControl/locale/de.cfg delete mode 100644 old/modules/DeconControl/locale/en.cfg delete mode 100644 old/modules/DeconControl/locale/fr.cfg delete mode 100644 old/modules/DeconControl/locale/nl.cfg delete mode 100644 old/modules/DeconControl/locale/sv-SE.cfg delete mode 100644 old/modules/DeconControl/softmod.json delete mode 100644 old/modules/ExpGamingCore/Server/control.lua delete mode 100644 old/modules/ExpGamingCore/Server/softmod.json delete mode 100644 old/modules/ExpGamingCore/Server/src/commands.lua delete mode 100644 old/modules/ExpGamingCore/Sync/control.lua delete mode 100644 old/modules/ExpGamingCore/Sync/softmod.json delete mode 100644 old/modules/ExpGamingCore/Sync/src/gui.lua delete mode 100644 old/modules/ExpGamingCore/Sync/src/logo.png delete mode 100644 old/modules/ExpGamingCore/softmod.json delete mode 100644 old/modules/ExpGamingInfo/Readme/control.lua delete mode 100644 old/modules/ExpGamingInfo/Readme/locale/de.cfg delete mode 100644 old/modules/ExpGamingInfo/Readme/locale/en.cfg delete mode 100644 old/modules/ExpGamingInfo/Readme/locale/fr.cfg delete mode 100644 old/modules/ExpGamingInfo/Readme/locale/nl.cfg delete mode 100644 old/modules/ExpGamingInfo/Readme/locale/sv-SE.cfg delete mode 100644 old/modules/ExpGamingInfo/Readme/softmod.json delete mode 100644 old/modules/ExpGamingInfo/Readme/src/sync.lua delete mode 100644 old/modules/ExpGamingInfo/softmod.json delete mode 100644 old/modules/ExpGamingPlayer/afkKick/control.lua delete mode 100644 old/modules/ExpGamingPlayer/afkKick/softmod.json delete mode 100644 old/modules/ExpGamingPlayer/afkKick/src/server.lua delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/control.lua delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/locale/de.cfg delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/locale/en.cfg delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/locale/fr.cfg delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/locale/nl.cfg delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/locale/sv-SE.cfg delete mode 100644 old/modules/ExpGamingPlayer/inventorySearch/softmod.json delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/control.lua delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/locale/de.cfg delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/locale/en.cfg delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/locale/fr.cfg delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/locale/nl.cfg delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/locale/sv-SE.cfg delete mode 100644 old/modules/ExpGamingPlayer/playerInfo/softmod.json delete mode 100644 old/modules/ExpGamingPlayer/polls/control.lua delete mode 100644 old/modules/ExpGamingPlayer/polls/locale/de.cfg delete mode 100644 old/modules/ExpGamingPlayer/polls/locale/en.cfg delete mode 100644 old/modules/ExpGamingPlayer/polls/locale/fr.cfg delete mode 100644 old/modules/ExpGamingPlayer/polls/locale/nl.cfg delete mode 100644 old/modules/ExpGamingPlayer/polls/locale/sv-SE.cfg delete mode 100644 old/modules/ExpGamingPlayer/polls/softmod.json delete mode 100644 old/modules/ExpGamingPlayer/softmod.json delete mode 100644 old/modules/GameSettingsGui/control.lua delete mode 100644 old/modules/GameSettingsGui/locale/de.cfg delete mode 100644 old/modules/GameSettingsGui/locale/en.cfg delete mode 100644 old/modules/GameSettingsGui/locale/fr.cfg delete mode 100644 old/modules/GameSettingsGui/locale/nl.cfg delete mode 100644 old/modules/GameSettingsGui/locale/sv-SE.cfg delete mode 100644 old/modules/GameSettingsGui/softmod.json delete mode 100644 old/modules/GuiAnnouncements/control.lua delete mode 100644 old/modules/GuiAnnouncements/locale/de.cfg delete mode 100644 old/modules/GuiAnnouncements/locale/en.cfg delete mode 100644 old/modules/GuiAnnouncements/locale/fr.cfg delete mode 100644 old/modules/GuiAnnouncements/locale/nl.cfg delete mode 100644 old/modules/GuiAnnouncements/locale/sv-SE.cfg delete mode 100644 old/modules/GuiAnnouncements/softmod.json delete mode 100644 old/modules/index.lua delete mode 100644 old/modules/softmod.json diff --git a/config/action_buttons.lua b/config/action_buttons.lua index f48606d3..5230d5f5 100644 --- a/config/action_buttons.lua +++ b/config/action_buttons.lua @@ -8,7 +8,7 @@ local Roles = require 'expcore.roles' local Store = require 'expcore.store' local Game = require 'utils.game' local Reports = require 'modules.control.reports' -local Warnings = require 'modules.addons.warnings' +local Warnings = require 'modules.control.warnings' local Jail = require 'modules.control.jail' local Colors = require 'resources.color_presets' local format_chat_player_name = ext_require('expcore.common','format_chat_player_name') diff --git a/config/science.lua b/config/science.lua index 3cd3ce5f..f3ee8939 100644 --- a/config/science.lua +++ b/config/science.lua @@ -1,8 +1,8 @@ -- config file for the science info gui return { -- list of all science packs to be shown in the gui show_eta=true, -- when true the eta for research completion will be shown - required_for_green=5, -- the amount required for the text to show as green - required_for_red=-5, -- the amount required for the text to show as red + color_clamp=5, -- the amount required for the text to show as green or red + color_flux=0.1, -- the ammount of flucuation allowed in production before icon change 'automation-science-pack', 'logistic-science-pack', 'military-science-pack', diff --git a/doc/config.ld b/doc/config.ld index fdaec597..79ac9eed 100644 --- a/doc/config.ld +++ b/doc/config.ld @@ -5,15 +5,25 @@ title = 'ExpGaming Scenario' description = 'Explosive Gaming\'s server scenario for 0.17' convert_opt = true -sort = true +sort = false not_luadoc = true no_lua_ref = true template_escape = ">" topics = {"../README.md", "../LICENSE"} style = '../doc' template = '../doc' +no_space_before_args = true +new_type("core", "Core", true) +new_type("addon", "Addons", true) +new_type("commands", "Commands", true) +new_type("control", "Control", true) +new_type("gui", "Guis", true) +new_type("config", "Configs", true) + +new_type("dep", "Dependencies", false) new_type("event", "Events", false, "Event Parameters") +new_type("command", "Commands", false, "Command Parameters") local api_url = "http://lua-api.factorio.com/latest/%s.html%s" diff --git a/doc/control/Jail.html b/doc/control/Jail.html new file mode 100644 index 00000000..d9623087 --- /dev/null +++ b/doc/control/Jail.html @@ -0,0 +1,1169 @@ + + + + + + + + Jail control + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Jail control

+

Control Module - Jail + - Adds a way to jail players and temp ban players.

+

+ + + + + + +

Usage

+

+    -- import the module from the control modules
+    local Jail = require '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
+    Jail.jail_player('MrBiter','Cooldude2606','Likes biters too much')
+
+    -- This will give 'MrBiter' all his roles back and remove him from jail
+    -- again as above the player name is only used in the event for user feedback
+    Jail.unjail_player('MrBiter','Cooldude2606')
+
+    -- Temp ban works the same as jail but will store the reason and move the players items to spawn
+    -- this is meant to be used as a more permiment jail but not as strong as a ban
+    Jail.temp_ban_player('MrBiter','Cooldude2606','Likes biters too much')
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + +
expcore.rolesAllows moving players into the jail role
utils.gameAllows accessing a player from any value
utils.globalAllows storing data in the global table
expcore.commonUse of move_items to clear inventroies
+ + +

Events

+ + + + + + + + + + + + + + + + + + + + +
on_player_jailedWhen a player is assigned to jail
on_player_unjailedWhen a player is unassigned from jail
on_player_temp_bannedWhen a player is temp banned
on_player_untemp_bannedWhen a temp ban is removed from a player
+ + +

Jail

+ + + + + + + + + + + + + + + + +
is_jailed(player)Checks if the player is currently in jail
jail_player(player, by_player_name[, reason='Non given.'])Moves a player to jail and removes all other roles
unjail_player(player, by_player_name)Moves a player out of jail and restores all roles previously removed
+ + +

Temp ban

+ + + + + + + + + + + + + + + + +
is_temp_banned(player)Checks if a player is temp banned
temp_ban_player(player, by_player_name[, reason='Non given.'])Temp bans a player by moving them to jail, clearing all other roles, storing the reason, and moving their items to spawn
untemp_ban_player(player, by_player_name)Rrmoves a player from temp ban by clearing the stored reason, removing them from jail, and restoring previous roles
+ + +
+ + +

Dependencies

+
+
+
+
+ # + expcore.roles +
+
+
+
+ +

Allows moving players into the jail role

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ +

Allows accessing a player from any value

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ +

Allows storing data in the global table

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ +

Use of move_items to clear inventroies

+

+ + + + + + + + + + + + + + +
+
+

Events

+
+
+
+
+ # + on_player_jailed +
+
+
+
+ +

When a player is assigned to jail

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who was jailed + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who jailed the other player + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player was jailed + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_player_unjailed +
+
+
+
+ +

When a player is unassigned from jail

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who was unjailed + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who unjailed the other player + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_player_temp_banned +
+
+
+
+ +

When a player is temp banned

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who was temp banned + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who temp banned the other player + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player was temp banned + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_player_untemp_banned +
+
+
+
+ +

When a temp ban is removed from a player

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who was untemp banned + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who untemp banned the other player + +
  • + + +
+ + + + + + + + + + + + + +
+
+

Jail

+
+
+
+
+ # + is_jailed(player) +
+
+
+
+ +

Checks if the player is currently in jail

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to check if they are in jail + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the player is currently in jail +
  • +
+ + + + + + + + + +
+
+
+
+ # + jail_player(player, by_player_name[, reason='Non given.']) +
+
+
+
+ +

Moves a player to jail and removes all other roles

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player who will be jailed + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the jailing + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being jailed + + (default: 'Non given.') +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + wheather the user was jailed successfully +
  • +
+ + + + + + + + + +
+
+
+
+ # + unjail_player(player, by_player_name) +
+
+
+
+ +

Moves a player out of jail and restores all roles previously removed

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player that will be unjailed + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player that is doing the unjail + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the player was unjailed successfully +
  • +
+ + + + + + + + + +
+
+

Temp ban

+
+
+
+
+ # + is_temp_banned(player) +
+
+
+
+ +

Checks if a player is temp banned

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to check if they are temp banned + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the player is temp banned +
  • +
+ + + + + + + + + +
+
+
+
+ # + temp_ban_player(player, by_player_name[, reason='Non given.']) +
+
+
+
+ +

Temp bans a player by moving them to jail, clearing all other roles, storing the reason, and moving their items to spawn

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player that will be temp banned + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the temp ban + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being temp banned + + (default: 'Non given.') +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the player was successfully temp banned +
  • +
+ + + + + + + + + +
+
+
+
+ # + untemp_ban_player(player, by_player_name) +
+
+
+
+ +

Rrmoves a player from temp ban by clearing the stored reason, removing them from jail, and restoring previous roles

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player who is being removed from temp ban + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the untemp ban + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the player was successfully removed +
  • +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/control/Production.html b/doc/control/Production.html new file mode 100644 index 00000000..96469f11 --- /dev/null +++ b/doc/control/Production.html @@ -0,0 +1,1284 @@ + + + + + + + + Production control + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Production control

+

Control Module - Production + - Common functions used to track production of items

+

+ + + + + + +

Usage

+

+    -- import the module from the control modules
+    local Production = require '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
+    -- the other precision work like wise
+    Production.precision_up(defines.flow_precision_index.one_second)
+
+    -- The get production function is used to get production, consumion and net
+    -- it may be used for any item and with any precision level, use total for total
+    Production.get_production(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute)
+
+    -- The fluctuations works by compearing recent production with the average over time
+    -- again any precision may be used, apart from one_thousand_hours as there would be no valid average
+    Production.get_fluctuations(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute)
+
+    -- ETA is calculated based on what function you use but all share a similar method
+    -- for production eta it will take current production average given by the precision
+    -- and work out how many ticks it will require to make the required amount (1000 by default)
+    Production.get_production_eta(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute,250000)
+
+    -- Both get_color and format_number are helper functions to help format production stats
+    -- get_color will return green,orange,red,or grey based on the active_value
+    -- the passive_value is used when active_value is 0 and can only return orange,red,or grey
+    Production.get_color(clamp,active_value,passive_value)
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + +
resources.color_presetsProvides colors for Production.get_color
utilProvides format_number function to add surfixs
+ + +

Precision

+ + + + + + + + + + + + + + + + +
precision_up(precision)Gets the next lesser precision index value, eg 1 second -> 1 minute
precision_down(precision)Gets the next greater precision index value, eg 1 minute -> 1 second
precision_ticks(precision)Gets the number of tick that precision is given over, eg 1 minute -> 60 ticks
+ + +

Statistics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
get_production_total(force, item_name)Returns the production data for the whole game time
get_production(force, item_name, precision)Returns the production data for the given precision game time
get_fluctuations(force, item_name, precision)Returns the current fluctuation from the average
get_production_eta(force, item_name, precision[, required=1000])Returns the amount of ticks required to produce a certain amount
get_consumsion_eta(force, item_name, precision[, required=1000])Returns the amount of ticks required to consume a certain amount
get_net_eta(force, item_name, precision[, required=1000])Returns the amount of ticks required to produce but not consume a certain amount
+ + +

Formating

+ + + + + + + + + + + + +
get_color(clamp, active_value, passive_value)Returns a color value bassed on the value that was given
format_number(value)Returns three parts used to format a number
+ + +
+ + +

Dependencies

+
+
+
+
+ # + resources.color_presets +
+
+
+
+ +

Provides colors for Production.get_color

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + util +
+
+
+
+ +

Provides format_number function to add surfixs

+

+ + + + + + + + + + + + + + +
+
+

Precision

+
+
+
+
+ # + precision_up(precision) +
+
+
+
+ +

Gets the next lesser precision index value, eg 1 second -> 1 minute

+

+ + + Parameters: + + + + + + + Returns: + + + + + + + + + + +
+
+
+
+ # + precision_down(precision) +
+
+
+
+ +

Gets the next greater precision index value, eg 1 minute -> 1 second

+

+ + + Parameters: + + + + + + + Returns: + + + + + + + + + + +
+
+
+
+ # + precision_ticks(precision) +
+
+
+
+ +

Gets the number of tick that precision is given over, eg 1 minute -> 60 ticks

+

+ + + Parameters: + + + + + + + Returns: +
    +
  • + (number) + the number of ticks in this time +
  • +
+ + + + + + + + + +
+
+

Statistics

+
+
+
+
+ # + get_production_total(force, item_name) +
+
+
+
+ +

Returns the production data for the whole game time

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains total made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_production(force, item_name, precision) +
+
+
+
+ +

Returns the production data for the given precision game time

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_fluctuations(force, item_name, precision) +
+
+
+
+ +

Returns the current fluctuation from the average

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_production_eta(force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to produce a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be made + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to produce this ammount of items +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_consumsion_eta(force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to consume a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be consumed + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to consume this ammount of items +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_net_eta(force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to produce but not consume a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be made but not used + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to produce, but not use, this ammount of items +
  • +
+ + + + + + + + + +
+
+

Formating

+
+
+
+
+ # + get_color(clamp, active_value, passive_value) +
+
+
+
+ +

Returns a color value bassed on the value that was given

+

+ + + Parameters: + +
    + + + + + +
  • + + clamp + + : + + (number) + + value which seperates the different colours + +
  • + + + + + +
  • + + active_value + + : + + (number) + + first value tested, tested against clamp + +
  • + + + + + +
  • + + passive_value + + : + + (number) + + second value tested, tested against 0 + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains r,g,b keys +
  • +
+ + + + + + + + + +
+
+
+
+ # + format_number(value) +
+
+
+
+ +

Returns three parts used to format a number

+

+ + + Parameters: + +
    + + + + + +
  • + + value + + : + + (number) + + the value to format + +
  • + + +
+ + + + + Returns: +
    +
  • + (string) + the sign for the number +
  • +
  • + (string) + the surfix for any unit used +
  • +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/control/Reports.html b/doc/control/Reports.html new file mode 100644 index 00000000..70203f0c --- /dev/null +++ b/doc/control/Reports.html @@ -0,0 +1,1033 @@ + + + + + + + + Reports control + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Reports control

+

Control Module - Reports + - Adds a way to report players and store report messages.

+

+ + + + + + +

Usage

+

+    -- import the module from the control modules
+    local Reports = require '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
+    -- seen by using Reports.get_report.
+    Reports.report_player('MrBiter','Cooldude2606','Liking biters too much') -- true
+
+    -- The other get methods can be used to get all the reports on a player or to test if a player is reported.
+    Reports.get_report('MrBiter','Cooldude2606') -- 'Liking biters too much'
+
+    -- This will remove the warning on 'MrBiter' (must be a valid player) which was made by 'Cooldude2606'.
+    Reports.remove_report('MrBiter','Cooldude2606') -- true
+
+    -- This will remove all the report that have been made against 'MrBiter'. Note that the remove event will
+    -- be triggered once per report issused.
+    Reports.remove_all('MrBiter') -- true
+
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + +
utils.gameAllows getting player from any value
utils.globalAllows storing of data in global table
+ + +

Events

+ + + + + + + + + + + + +
on_player_reportedWhen a player is reported
on_report_removedWhen a report is removed from a player
+ + +

Getters

+ + + + + + + + + + + + + + + + + + + + +
get_reports(player)Gets a list of all reports that a player has against them
get_report(player, by_player_name)Gets a single report against a player given the name of the player who made the report
is_reported(player[, by_player_name])Checks if a player is reported, option to get if reported by a certain player
count_reports(player[, custom_count])Counts the number of reports that a player has aganist them
+ + +

Setters

+ + + + + + + + + + + + + + + + +
report_player(player, by_player_name[, reason='Non given.'])Adds a report to a player, each player can only report another player once
remove_report(player, reported_by_name)Removes a report from a player
remove_all(player)Removes all reports from a player
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.game +
+
+
+
+ +

Allows getting player from any value

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ +

Allows storing of data in global table

+

+ + + + + + + + + + + + + + +
+
+

Events

+
+
+
+
+ # + on_player_reported +
+
+
+
+ +

When a player is reported

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the player index of the player who got reported + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who made the report + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason given for the report + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_report_removed +
+
+
+
+ +

When a report is removed from a player

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the player index of the player who has the report removed + +
  • + + + + + +
  • + + reported_by_name + + : + + (string) + + the name of the player who made the removed report + +
  • + + + + + +
  • + + removed_by_name + + : + + (string) + + the name of the player who removed the report + +
  • + + +
+ + + + + + + + + + + + + +
+
+

Getters

+
+
+
+
+ # + get_reports(player) +
+
+
+
+ +

Gets a list of all reports that a player has against them

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the report for + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + a list of all reports, key is by player name, value is reason +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_report(player, by_player_name) +
+
+
+
+ +

Gets a single report against a player given the name of the player who made the report

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the report for + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who made the report + +
  • + + +
+ + + + + Returns: +
    +
  • + (string or nil) + string is the reason that the player was reported, if the player is not reported +
  • +
+ + + + + + + + + +
+
+
+
+ # + is_reported(player[, by_player_name]) +
+
+
+
+ +

Checks if a player is reported, option to get if reported by a certain player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to check if reported + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + when given will check if reported by this player + + (optional) +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + if the player has been reported +
  • +
+ + + + + + + + + +
+
+
+
+ # + count_reports(player[, custom_count]) +
+
+
+
+ +

Counts the number of reports that a player has aganist them

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to count the reports for + +
  • + + + + + +
  • + + custom_count + + : + + (function) + + when given this function will be used to count the reports + + (optional) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of reports that the user has +
  • +
+ + + + + + + + + +
+
+

Setters

+
+
+
+
+ # + report_player(player, by_player_name[, reason='Non given.']) +
+
+
+
+ +

Adds a report to a player, each player can only report another player once

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to add the report to + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player that is making the report + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being reported + + (default: 'Non given.') +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the report was added successfully +
  • +
+ + + + + + + + + +
+
+
+
+ # + remove_report(player, reported_by_name) +
+
+
+
+ +

Removes a report from a player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove the report from + +
  • + + + + + +
  • + + reported_by_name + + : + + (string) + + the name of the player that made the report + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the report was removed successfully +
  • +
+ + + + + + + + + +
+
+
+
+ # + remove_all(player) +
+
+
+
+ +

Removes all reports from a player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove the reports from + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the reports were removed successfully +
  • +
+ + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/control/Warnings.html b/doc/control/Warnings.html new file mode 100644 index 00000000..ad54c40d --- /dev/null +++ b/doc/control/Warnings.html @@ -0,0 +1,1426 @@ + + + + + + + + Warnings control + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Warnings control

+

Control Module - Warnings + - Adds a way to give and remove warnings to players.

+

+ + + + + + +

Usage

+

+    -- import the module from the control modules
+    local Warnings = require 'modules.control.warnings'
+
+    -- This will add a warning to the player
+    Warnings.add_warning('MrBiter','Cooldude2606','Killed too many biters')
+
+    -- This will remove a warning from a player, second name is just who is doing the action
+    Warnings.remove_warning('MrBiter','Cooldude2606')
+
+    -- Script warning as similar to normal warning but are designed to have no effect for a short amount of time
+    -- this is so it can be used for greifer protection without being too agressive
+    Warnings.add_script_warning('MrBiter','Killed too many biters')
+
+    -- Both normal and script warnings can also be cleared, this will remove all warnings
+    Warnings.clear_warnings('MrBiter','Cooldude2606')
+ + + + + + + +

Dependencies

+ + + + + + + + + + + + + + + + + + + + +
utils.eventAllows registering of custom events
utils.gameAllows getting player from any value
utils.globalAllows storing in the global table
config.warningsConfig file for this module
+ + +

Events

+ + + + + + + + + + + + + + + + + + + + +
on_warning_addedWhen a warning is added to a player
on_warning_removedWhen a warning is removed from a player
on_script_warning_addedWhen a warning is added to a player, by the script
on_script_warning_removedWhen a warning is remnoved from a player, by the script
+ + +

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
get_warnings(player)Gets an array of warnings that the player has, always returns a list even if emtpy
count_warnings(player)Gets the number of warnings that a player has on them
add_warning(player, by_player_name[, reason='Non given.'])Adds a warning to a player, when a warning is added a set action is done based on the number of warnings and the config file
remove_warning(player, by_player_name)Removes a warning from a player, always removes the earlyist warning, fifo
clear_warnings(player, by_player_name)Removes all warnings from a player, will trigger remove event for each warning
get_script_warnings(player)Gets an array of all the script warnings that a player has
count_script_warnings(player)Gets the number of script warnings that a player has on them
add_script_warning(player[, reason='Non given.'])Adds a script warning to a player, this may add a full warning if max script warnings is met
remove_script_warning(player)Removes a script warning from a player
clear_script_warnings(player)Removes all script warnings from a player, emits event for each warning removed
+ + +
+ + +

Dependencies

+
+
+
+
+ # + utils.event +
+
+
+
+ +

Allows registering of custom events

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ +

Allows getting player from any value

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ +

Allows storing in the global table

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + config.warnings +
+
+
+
+ +

Config file for this module

+

+ + + + + + + + + + + + + + +
+
+

Events

+
+
+
+
+ # + on_warning_added +
+
+
+
+ +

When a warning is added to a player

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who recived the warning + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who gave the warning + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player was given a warning + +
  • + + + + + +
  • + + warning_count + + : + + (number) + + the new number of warnings that the player has + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_warning_removed +
+
+
+
+ +

When a warning is removed from a player

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who is having the warning removed + +
  • + + + + + +
  • + + warning_by_name + + : + + (string) + + the name of the player who gave the warning + +
  • + + + + + +
  • + + removed_by_name + + : + + (string) + + the name of the player who is removing the warning + +
  • + + + + + +
  • + + warning_count + + : + + (number) + + the new number of warnings that the player has + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_script_warning_added +
+
+
+
+ +

When a warning is added to a player, by the script

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who recived the warning + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player was given a warning + +
  • + + + + + +
  • + + warning_count + + : + + (number) + + the new number of warnings that the player has + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_script_warning_removed +
+
+
+
+ +

When a warning is remnoved from a player, by the script

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who is having the warning removed + +
  • + + + + + +
  • + + warning_count + + : + + (number) + + the new number of warnings that the player has + +
  • + + +
+ + + + + + + + + + + + + +
+
+

Functions

+
+
+
+
+ # + get_warnings(player) +
+
+
+
+ +

Gets an array of warnings that the player has, always returns a list even if emtpy

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the warning for + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + an array of all the warnings on this player, contains tick, by_player_name and reason +
  • +
+ + + + + + + + + +
+
+
+
+ # + count_warnings(player) +
+
+
+
+ +

Gets the number of warnings that a player has on them

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to count the warnings for + +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + add_warning(player, by_player_name[, reason='Non given.']) +
+
+
+
+ +

Adds a warning to a player, when a warning is added a set action is done based on the number of warnings and the config file

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to add a warning to + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the action + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being warned + + (default: 'Non given.') +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + remove_warning(player, by_player_name) +
+
+
+
+ +

Removes a warning from a player, always removes the earlyist warning, fifo

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove a warning from + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the action + +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + clear_warnings(player, by_player_name) +
+
+
+
+ +

Removes all warnings from a player, will trigger remove event for each warning

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to clear the warnings from + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the action + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + true when warnings were cleared succesfully +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_script_warnings(player) +
+
+
+
+ +

Gets an array of all the script warnings that a player has

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to get the script warnings of + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + a table of all the script warnings a player has, contains tick and reason +
  • +
+ + + + + + + + + +
+
+
+
+ # + count_script_warnings(player) +
+
+
+
+ +

Gets the number of script warnings that a player has on them

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to count the script warnings of + +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of script warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + add_script_warning(player[, reason='Non given.']) +
+
+
+
+ +

Adds a script warning to a player, this may add a full warning if max script warnings is met

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to add a script warning to + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player is being warned + + (default: 'Non given.') +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of script warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + remove_script_warning(player) +
+
+
+
+ +

Removes a script warning from a player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove a script warning from + +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of script warnings that the player has +
  • +
+ + + + + + + + + +
+
+
+
+ # + clear_script_warnings(player) +
+
+
+
+ +

Removes all script warnings from a player, emits event for each warning removed

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to clear the script warnings from + +
  • + + +
+ + + + + + + + + + + + + +
+
+ + + +
+
+
+ + + + diff --git a/doc/index.html b/doc/index.html index 6e2fc4e9..2f1bd13c 100644 --- a/doc/index.html +++ b/doc/index.html @@ -34,8 +34,6 @@ - - @@ -44,6 +42,29 @@
+

Control

+ + + + + + + + + + + + + + + + + +
JailControl Module - Jail + - Adds a way to jail players and temp ban players.
ProductionControl Module - Production + - Common functions used to track production of items
ReportsControl Module - Reports + - Adds a way to report players and store report messages.
WarningsControl Module - Warnings + - Adds a way to give and remove warnings to players.

Modules

@@ -274,21 +295,6 @@ - - - - - - - - - - - - @@ -380,7 +386,7 @@ generated by LDoc diff --git a/doc/ldoc.ltp b/doc/ldoc.ltp index ca3fc3d2..539ab547 100644 --- a/doc/ldoc.ltp +++ b/doc/ldoc.ltp @@ -73,7 +73,22 @@ > if module then - + + +> if module and module.type ~= "topic" then +> if module and not ldoc.no_summary and #module.items > 0 then + +> end +> end > if not ldoc.no_summary then > local this_mod = module and module.name > for kind, mods, type in ldoc.kinds() do @@ -111,13 +126,15 @@ > end > end - + +> if module and module.type ~= "topic" then +
> if module and module.type ~= "topic" then > if module and not ldoc.no_summary and #module.items > 0 then
-> if module and module.type ~= "topic" then - > end diff --git a/doc/modules/Jail.html b/doc/modules/Jail.html index f36043a8..a03abf37 100644 --- a/doc/modules/Jail.html +++ b/doc/modules/Jail.html @@ -35,14 +35,23 @@ - + + +
modules.addons.damage-popups Displays the amount of dmg that is done by players to entities also shows player health when a player is attacked
JailControl Module - Jail - - Adds a way to jail players and temp ban players.
ReportsControl Module - Reports - - Adds a way to report players and store report messages.
WarningsControl Module - Warnings - - Adds a way to give and remove warnings to players.
modules.gui.player-list
+

Dependencies

+ +
+ + + + + + + + + + + + + + + + + + +
expcore.rolesAllows moving players into the jail role
utils.gameAllows accessing a player from any value
utils.globalAllows storing data in the global table
expcore.commonUse of move_items to clear inventroies
+ +

Events

@@ -186,14 +233,14 @@ - - - - + + + + @@ -244,6 +291,117 @@
+

Dependencies

+
+
+
+
+ # + expcore.roles +
+
+
+
+ +

Allows moving players into the jail role

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.game +
+
+
+
+ +

Allows accessing a player from any value

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + utils.global +
+
+
+
+ +

Allows storing data in the global table

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + expcore.common +
+
+
+
+ +

Use of move_items to clear inventroies

+

+ + + + + + + + + + + + + + +
+

Events

@@ -321,6 +479,72 @@ + + + + + + + +
+
+
+ # + on_player_unjailed +
+
+
+
+ +

When a player is unassigned from jail

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who was unjailed + +
  • + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who unjailed the other player + +
  • + + +
+ + + + + + + @@ -403,72 +627,6 @@ - - - - - - -
-
-
-
- # - on_player_unjailed -
-
-
-
- -

When a player is unassigned from jail

-

- - - Event Parameters: - -
    - - - - - -
  • - - player_index - - : - - (number) - - the index of the player who was unjailed - -
  • - - - - - -
  • - - by_player_name - - : - - (string) - - the name of the player who unjailed the other player - -
  • - - -
- - - - - - - @@ -1003,7 +1161,7 @@ generated by LDoc
diff --git a/doc/modules/Production.html b/doc/modules/Production.html new file mode 100644 index 00000000..ca9dbceb --- /dev/null +++ b/doc/modules/Production.html @@ -0,0 +1,1281 @@ + + + + + + + + Production module + + + + + + + +
+
+ + + + + + + +
+ + + + + + + + +

Production module

+

Control Module - Production + - Common functions used to track production of items

+

+ + + + + + +

Usage

+

+    -- import the module from the control modules
+    local Production = require '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
+    -- the other precision work like wise
+    Production.precision_up(defines.flow_precision_index.one_second)
+
+    -- The get production function is used to get production, consumion and net
+    -- it may be used for any item and with any precision level, use total for total
+    Production.get_production(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute)
+
+    -- The fluctuations works by compearing recent production with the average over time
+    -- again any precision may be used, apart from one_thousand_hours as there would be no valid average
+    Production.get_fluctuations(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute)
+
+    -- ETA is calculated based on what function you use but all share a similar method
+    -- for production eta it will take current production average given by the precision
+    -- and work out how many ticks it will require to make the required amount (1000 by default)
+    Production.get_production_eta(game.forces.player,'iron-plate',defines.flow_precision_index.one_minute,250000)
+
+    -- Both get_color and format_number are helper functions to help format production stats
+    -- get_color will return green,orange,red,or grey based on the active_value
+    -- the passive_value is used when active_value is 0 and can only return orange,red,or grey
+    Production.get_color(clamp,active_value,passive_value)
+ + + + + +
When a player is assigned to jail
on_player_temp_bannedWhen a player is temp banned
on_player_unjailed When a player is unassigned from jail
on_player_temp_bannedWhen a player is temp banned
on_player_untemp_banned When a temp ban is removed from a player
+ +

Dependencies

+ + + + + + + + + + + + +
resources.color_presetsProvides colors for Production.get_color
utilProvides format_number function to add surfixs
+ + +

Precision

+ + + + + + + + + + + + + + + + +
precision_up (precision)Gets the next lesser precision index value, eg 1 second -> 1 minute
precision_down (precision)Gets the next greater precision index value, eg 1 minute -> 1 second
precision_ticks (precision)Gets the number of tick that precision is given over, eg 1 minute -> 60 ticks
+ + +

Stats

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
get_production_total (force, item_name)Returns the production data for the whole game time
get_production (force, item_name, precision)Returns the production data for the given precision game time
get_fluctuations (force, item_name, precision)Returns the current fluctuation from the average
get_production_eta (force, item_name, precision[, required=1000])Returns the amount of ticks required to produce a certain amount
get_consumsion_eta (force, item_name, precision[, required=1000])Returns the amount of ticks required to consume a certain amount
get_net_eta (force, item_name, precision[, required=1000])Returns the amount of ticks required to produce but not consume a certain amount
+ + +

Formating

+ + + + + + + + + + + + +
get_color (clamp, active_value, passive_value)Returns a color value bassed on the value that was given
format_number (value)Returns three parts used to format a number
+ + +
+ + +

Dependencies

+
+
+
+
+ # + resources.color_presets +
+
+
+
+ +

Provides colors for Production.get_color

+

+ + + + + + + + + + + + + + +
+
+
+
+ # + util +
+
+
+
+ +

Provides format_number function to add surfixs

+

+ + + + + + + + + + + + + + +
+
+

Precision

+
+
+
+
+ # + precision_up (precision) +
+
+
+
+ +

Gets the next lesser precision index value, eg 1 second -> 1 minute

+

+ + + Parameters: + + + + + + + Returns: + + + + + + + + + + +
+
+
+
+ # + precision_down (precision) +
+
+
+
+ +

Gets the next greater precision index value, eg 1 minute -> 1 second

+

+ + + Parameters: + + + + + + + Returns: + + + + + + + + + + +
+
+
+
+ # + precision_ticks (precision) +
+
+
+
+ +

Gets the number of tick that precision is given over, eg 1 minute -> 60 ticks

+

+ + + Parameters: + + + + + + + Returns: +
    +
  • + (number) + the number of ticks in this time +
  • +
+ + + + + + + + + +
+
+

Stats

+
+
+
+
+ # + get_production_total (force, item_name) +
+
+
+
+ +

Returns the production data for the whole game time

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains total made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_production (force, item_name, precision) +
+
+
+
+ +

Returns the production data for the given precision game time

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_fluctuations (force, item_name, precision) +
+
+
+
+ +

Returns the current fluctuation from the average

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains made, used and net +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_production_eta (force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to produce a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be made + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to produce this ammount of items +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_consumsion_eta (force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to consume a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be consumed + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to consume this ammount of items +
  • +
+ + + + + + + + + +
+
+
+
+ # + get_net_eta (force, item_name, precision[, required=1000]) +
+
+
+
+ +

Returns the amount of ticks required to produce but not consume a certain amount

+

+ + + Parameters: + +
    + + + + + +
  • + + force + + : + + (LuaForce) + + the force to get the data for + +
  • + + + + + +
  • + + item_name + + : + + (string) + + the name of the item that you want the data about + +
  • + + + + + +
  • + + precision + + : + + (defines.flow_precision_index) + + the precision that you want the data given to + +
  • + + + + + +
  • + + required + + : + + (number) + + the number of items that are required to be made but not used + + (default: 1000) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of ticks required to produce, but not use, this ammount of items +
  • +
+ + + + + + + + + +
+
+

Formating

+
+
+
+
+ # + get_color (clamp, active_value, passive_value) +
+
+
+
+ +

Returns a color value bassed on the value that was given

+

+ + + Parameters: + +
    + + + + + +
  • + + clamp + + : + + (number) + + value which seperates the different colours + +
  • + + + + + +
  • + + active_value + + : + + (number) + + first value tested, tested against clamp + +
  • + + + + + +
  • + + passive_value + + : + + (number) + + second value tested, tested against 0 + +
  • + + +
+ + + + + Returns: +
    +
  • + (table) + contains r,g,b keys +
  • +
+ + + + + + + + + +
+
+
+
+ # + format_number (value) +
+
+
+
+ +

Returns three parts used to format a number

+

+ + + Parameters: + +
    + + + + + +
  • + + value + + : + + (number) + + the value to format + +
  • + + +
+ + + + + Returns: +
    +
  • + (string) + the sign for the number +
  • +
  • + (string) + the surfix for any unit used +
  • +
  • + (string) + the number formated +
  • +
+ + + + + + + + + +
+
+ + + +
+ + + + + + diff --git a/doc/modules/Reports.html b/doc/modules/Reports.html index b55cf3e1..35edb453 100644 --- a/doc/modules/Reports.html +++ b/doc/modules/Reports.html @@ -36,13 +36,22 @@ + + @@ -473,8 +545,8 @@ Returns:
  • - (number) - the number of reports that the user has + (table) + a list of all reports, key is by player name, value is reason
@@ -553,63 +625,6 @@ - - - - - - - -
-
-
- # - get_reports (player) -
-
-
-
- -

Gets a list of all reports that a player has against them

-

- - - Parameters: - -
    - - - - - -
  • - - player - - : - - (LuaPlayer) - - the player to get the report for - -
  • - - -
- - - - - Returns: -
    -
  • - (table) - a list of all reports, key is by player name, value is reason -
  • -
- - - @@ -684,6 +699,80 @@ + + + + + + +
+
+
+
+ # + count_reports (player[, custom_count]) +
+
+
+
+ +

Counts the number of reports that a player has aganist them

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to count the reports for + +
  • + + + + + +
  • + + custom_count + + : + + (function) + + when given this function will be used to count the reports + + (optional) +
  • + + +
+ + + + + Returns: +
    +
  • + (number) + the number of reports that the user has +
  • +
+ + + @@ -697,136 +786,6 @@
- # - remove_all (player) -
-
-
-
- -

Removes all reports from a player

-

- - - Parameters: - -
    - - - - - -
  • - - player - - : - - (LuaPlayer) - - the player to remove the reports from - -
  • - - -
- - - - - Returns: -
    -
  • - (boolean) - whether the reports were removed successfully -
  • -
- - - - - - - - - -
-
-
-
- # - remove_report (player, reported_by_name) -
-
-
-
- -

Removes a report from a player

-

- - - Parameters: - -
    - - - - - -
  • - - player - - : - - (LuaPlayer) - - the player to remove the report from - -
  • - - - - - -
  • - - reported_by_name - - : - - (string) - - the name of the player that made the report - -
  • - - -
- - - - - Returns: -
    -
  • - (boolean) - whether the report was removed successfully -
  • -
- - - - - - - - - -
-
-
-
# report_player (player, by_player_name[, reason='Non given.'])
@@ -907,6 +866,136 @@ + + + + + + + +
+
+
+ # + remove_report (player, reported_by_name) +
+
+
+
+ +

Removes a report from a player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove the report from + +
  • + + + + + +
  • + + reported_by_name + + : + + (string) + + the name of the player that made the report + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the report was removed successfully +
  • +
+ + + + + + + + + +
+
+
+
+ # + remove_all (player) +
+
+
+
+ +

Removes all reports from a player

+

+ + + Parameters: + +
    + + + + + +
  • + + player + + : + + (LuaPlayer) + + the player to remove the reports from + +
  • + + +
+ + + + + Returns: +
    +
  • + (boolean) + whether the reports were removed successfully +
  • +
+ + + @@ -929,7 +1018,7 @@ generated by LDoc
diff --git a/doc/modules/Warnings.html b/doc/modules/Warnings.html index 66363f29..69fcc9c9 100644 --- a/doc/modules/Warnings.html +++ b/doc/modules/Warnings.html @@ -36,13 +36,20 @@ + + + + + + + + + + + + + + + +
+
+
+
+ # + on_script_warning_added +
+
+
+
+ +

When a warning is added to a player, by the script

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who recived the warning + +
  • + + + + + +
  • + + reason + + : + + (string) + + the reason that the player was given a warning + +
  • + + + + + +
  • + + warning_count + + : + + (number) + + the new number of warnings that the player has + +
  • + + +
+ + + + + + + + + + + + + +
+
+
+
+ # + on_script_warning_removed +
+
+
+
+ +

When a warning is remnoved from a player, by the script

+

+ + + Event Parameters: + +
    + + + + + +
  • + + player_index + + : + + (number) + + the index of the player who is having the warning removed + +
  • + + + + +
  • warning_count @@ -604,14 +614,14 @@
    - # - add_script_warning (player[, reason='Non given.']) + # + get_warnings (player)
    -

    Adds a script warning to a player, this may add a full warning if max script warnings is met

    +

    Gets an array of warnings that the player has, always returns a list even if emtpy

    @@ -631,25 +641,65 @@ (LuaPlayer) - the player to add a script warning to + the player to get the warning for
  • +
+ + + + + Returns: +
    +
  • + (table) + an array of all the warnings on this player, contains tick, by_player_name and reason +
  • +
+ + + + + + + + + +
+
+
+
+ # + count_warnings (player) +
+
+
+
+ +

Gets the number of warnings that a player has on them

+

+ + + Parameters: + +
    + +
  • - reason + player : - (string) + (LuaPlayer) - the reason that the player is being warned + the player to count the warnings for - (default: 'Non given.')
  • @@ -662,7 +712,7 @@
    • (number) - the number of script warnings that the player has + the number of warnings that the player has
    @@ -768,14 +818,14 @@
    - # - clear_script_warnings (player) + # + remove_warning (player, by_player_name)
    -

    Removes all script warnings from a player, emits event for each warning removed

    +

    Removes a warning from a player, always removes the earlyist warning, fifo

    @@ -795,7 +845,23 @@ (LuaPlayer) - the player to clear the script warnings from + the player to remove a warning from + + + + + + + +
  • + + by_player_name + + : + + (string) + + the name of the player who is doing the action
  • @@ -805,6 +871,13 @@ + Returns: +
      +
    • + (number) + the number of warnings that the player has +
    • +
    @@ -881,120 +954,6 @@ - - - - - - -
    -
    -
    -
    - # - count_script_warnings (player) -
    -
    -
    -
    - -

    Gets the number of script warnings that a player has on them

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to count the script warnings of - -
    • - - -
    - - - - - Returns: -
      -
    • - (number) - the number of script warnings that the player has -
    • -
    - - - - - - - - - -
    -
    -
    -
    - # - count_warnings (player) -
    -
    -
    -
    - -

    Gets the number of warnings that a player has on them

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to count the warnings for - -
    • - - -
    - - - - - Returns: -
      -
    • - (number) - the number of warnings that the player has -
    • -
    - - - @@ -1062,14 +1021,14 @@
    - # - get_warnings (player) + # + count_script_warnings (player)
    -

    Gets an array of warnings that the player has, always returns a list even if emtpy

    +

    Gets the number of script warnings that a player has on them

    @@ -1089,7 +1048,7 @@ (LuaPlayer) - the player to get the warning for + the player to count the script warnings of @@ -1102,8 +1061,82 @@ Returns:
    • - (table) - an array of all the warnings on this player, contains tick, by_player_name and reason + (number) + the number of script warnings that the player has +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + add_script_warning (player[, reason='Non given.']) +
    +
    +
    +
    + +

    Adds a script warning to a player, this may add a full warning if max script warnings is met

    +

    + + + Parameters: + +
      + + + + + +
    • + + player + + : + + (LuaPlayer) + + the player to add a script warning to + +
    • + + + + + +
    • + + reason + + : + + (string) + + the reason that the player is being warned + + (default: 'Non given.') +
    • + + +
    + + + + + Returns: +
      +
    • + (number) + the number of script warnings that the player has
    @@ -1176,14 +1209,14 @@
    - # - remove_warning (player, by_player_name) + # + clear_script_warnings (player)
    -

    Removes a warning from a player, always removes the earlyist warning, fifo

    +

    Removes all script warnings from a player, emits event for each warning removed

    @@ -1203,23 +1236,7 @@ (LuaPlayer) - the player to remove a warning from - - - - - - - -
  • - - by_player_name - - : - - (string) - - the name of the player who is doing the action + the player to clear the script warnings from
  • @@ -1229,13 +1246,6 @@ - Returns: -
      -
    • - (number) - the number of warnings that the player has -
    • -
    @@ -1261,7 +1271,7 @@ generated by LDoc
diff --git a/doc/modules/config._file_loader.html b/doc/modules/config._file_loader.html index fcca2f80..e45bf570 100644 --- a/doc/modules/config._file_loader.html +++ b/doc/modules/config._file_loader.html @@ -35,14 +35,12 @@ - + +
@@ -1307,7 +1191,7 @@
# - Common.print_colored_grid_value (value, surface, position, offset, immutable, color_value, base_color, delta_color, under_bound, over_bound) + Common.print_colored_grid_value(value, surface, position, offset, immutable, color_value, base_color, delta_color, under_bound, over_bound)
@@ -1493,15 +1377,14 @@
- # - Common.print_grid_value (value, surface, position, scale, offset, immutable) + # + Common.clear_flying_text(surface)
-

https://github.com/Refactorio/RedMew/blob/9184b2940f311d8c9c891e83429fc57ec7e0c4a2/map_gen/maps/diggy/debug.lua#L31 - Prints a colored value on a location.

+

Clears all flying text entites on a surface

@@ -1513,89 +1396,15 @@ -
  • - - value - - : - - - between -1 and 1 - -
  • - - - - -
  • surface : + (LuaSurface) - LuaSurface - -
  • - - - - - -
  • - - position - - : - - - Position {x, y} - -
  • - - - - - -
  • - - scale - - : - - - float - -
  • - - - - - -
  • - - offset - - : - - - float - -
  • - - - - - -
  • - - immutable - - : - - - bool if immutable, only set, never do a surface lookup, values never change + the surface to clear
  • @@ -1619,7 +1428,7 @@
    # - Common.string_contains (s, contains) + Common.string_contains(s, contains)
    @@ -1691,14 +1500,14 @@
    - # - Common.table_alphanumsort (tbl) + # + Common.extract_keys(tbl, ...)
    -

    Returns the list is a sorted way that would be expected by people (this is by key)

    +

    Extracts certain keys from a table

    @@ -1718,7 +1527,23 @@ (table) - the table to be sorted + table the which contains the keys + + + + + + + +
  • + + ... + + : + + (string) + + the names of the keys you want extracted
  • @@ -1731,8 +1556,7 @@ Returns:
    • - (table) - the sorted table + the keys in the order given
    @@ -1742,111 +1566,22 @@ + Usage: +
    local key_three, key_one = extract({key_one='foo',key_two='bar',key_three=true},'key_three','key_one')
    - # - Common.table_keys (table[, sorted][, as_string]) + # + Common.enum(tbl)
    -

    Returns a copy of all of the keys in the table.

    -

    - - - Parameters: - -
      - - - - - -
    • - - table - - : - - (table) - - tbl the to copy the keys from, or an empty table if tbl is nil - -
    • - - - - - -
    • - - sorted - - : - - (boolean) - - whether to sort the keys (slower) or keep the random order from pairs() - - (optional) -
    • - - - - - -
    • - - as_string - - : - - (boolean) - - whether to try and parse the keys as strings, or leave them as their existing type - - (optional) -
    • - - -
    - - - - - Returns: -
      -
    • - (array) - an array with a copy of all the keys in the table -
    • -
    - - - - - - - - - -
    -
    -
    -
    - # - Common.table_keysort (tbl) -
    -
    -
    -
    - -

    Returns the list is a sorted way that would be expected by people (this is by key) (faster alterative than above)

    +

    Converts a table to an enum

    @@ -1866,7 +1601,7 @@ (table) - the table to be sorted + table the that will be converted @@ -1880,7 +1615,113 @@
    • (table) - the sorted table + the new table that acts like an enum +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + Common.auto_complete(options, input[, use_key=false][, rtn_key=false]) +
    +
    +
    +
    + +

    Returns the closest match to the input

    +

    + + + Parameters: + +
      + + + + + +
    • + + options + + : + + (table) + + table a of options for the auto complete + +
    • + + + + + +
    • + + input + + : + + (string) + + string the input that will be completed + +
    • + + + + + +
    • + + use_key + + : + + (boolean) + + when true the keys of options will be used as the options + + (default: false) +
    • + + + + + +
    • + + rtn_key + + : + + (boolean) + + when true the the key will be returned rather than the value + + (default: false) +
    • + + +
    + + + + + Returns: +
      +
    • + the list item found that matches the input
    @@ -1897,7 +1738,7 @@
    # - Common.table_values (table[, sorted][, as_string]) + Common.table_values(table[, sorted][, as_string])
    @@ -1987,14 +1828,14 @@
    - # - Common.type_check (value[, test_type=nil]) + # + Common.table_keys(table[, sorted][, as_string])
    -

    Compare types faster for faster validation of params

    +

    Returns a copy of all of the keys in the table.

    @@ -2008,13 +1849,13 @@
  • - value + table : - (any) + (table) - the value to be tested + tbl the to copy the keys from, or an empty table if tbl is nil
  • @@ -2024,15 +1865,32 @@
  • - test_type + sorted : - (string) + (boolean) - the type to test for if not given then it tests for nil + whether to sort the keys (slower) or keep the random order from pairs() - (default: nil) + (optional) +
  • + + + + + +
  • + + as_string + + : + + (boolean) + + whether to try and parse the keys as strings, or leave them as their existing type + + (optional)
  • @@ -2044,8 +1902,8 @@ Returns:
    • - (boolean) - is v of type test_type + (array) + an array with a copy of all the keys in the table
    @@ -2055,23 +1913,20 @@ - Usage: -
    type_check('foo','string') -- return true
    -
    type_check('foo') -- return false
    - # - Common.type_check_error (value, test_type, error_message, level) + # + Common.table_alphanumsort(tbl)
    -

    Raises an error if the value is of the wrong type

    +

    Returns the list is a sorted way that would be expected by people (this is by key)

    @@ -2083,129 +1938,6 @@ -
  • - - value - - : - - (any) - - the value that you want to test the type of - -
  • - - - - - -
  • - - test_type - - : - - (string) - - the type that the value should be - -
  • - - - - - -
  • - - error_message - - : - - (string) - - the error message that is returned - -
  • - - - - - -
  • - - level - - : - - (number) - - the level to call the error on (level = 1 means the caller) - -
  • - - - - - - - - Returns: -
      -
    • - (boolean) - true if no error was called -
    • -
    - - - - - - - - Usage: -
    type_check_error('foo','number','Value must be a number') -- will raise error "Value must be a number"
    - - -
    -
    -
    -
    - # - Common.write_json (path, tbl) -
    -
    -
    -
    - -

    Writes a table object to a file in json format

    -

    - - - Parameters: - -
      - - - - - -
    • - - path - - : - - (string) - - the path of the file to write include / to use dir - -
    • - - - - -
    • tbl @@ -2214,7 +1946,7 @@ (table) - the table that will be converted to a json string and wrote to file + the table to be sorted
    • @@ -2224,6 +1956,290 @@ + Returns: +
        +
      • + (table) + the sorted table +
      • +
      + + + + + + + + + +
    +
    +
    +
    + # + Common.table_keysort(tbl) +
    +
    +
    +
    + +

    Returns the list is a sorted way that would be expected by people (this is by key) (faster alterative than above)

    +

    + + + Parameters: + +
      + + + + + +
    • + + tbl + + : + + (table) + + the table to be sorted + +
    • + + +
    + + + + + Returns: +
      +
    • + (table) + the sorted table +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + Common.format_chat_colour(message, color) +
    +
    +
    +
    + +

    Returns a message with valid chat tags to change its colour

    +

    + + + Parameters: + +
      + + + + + +
    • + + message + + : + + (string) + + the message that will be in the output + +
    • + + + + + +
    • + + color + + : + + (table) + + a color which contains r,g,b as its keys + +
    • + + +
    + + + + + Returns: +
      +
    • + (string) + the message with the color tags included +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + Common.format_chat_colour_localized(message, color) +
    +
    +
    +
    + +

    Returns a message with valid chat tags to change its colour, using localization

    +

    + + + Parameters: + +
      + + + + + +
    • + + message + + : + + (string or table) + + the message that will be in the output + +
    • + + + + + +
    • + + color + + : + + (table) + + a color which contains r,g,b as its keys + +
    • + + +
    + + + + + Returns: +
      +
    • + (table) + the message with the color tags included +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + Common.format_chat_player_name(player[, raw_string=false]) +
    +
    +
    +
    + +

    Returns the players name in the players color

    +

    + + + Parameters: + +
      + + + + + +
    • + + player + + : + + (LuaPlayer) + + the player to use the name and color of + +
    • + + + + + +
    • + + raw_string + + : + + (boolean) + + when true a is returned rather than a localized string + + (default: false) +
    • + + +
    + + + + + Returns: +
      +
    • + (table) + the players name with tags for the players color +
    • +
    @@ -2249,7 +2265,7 @@ generated by LDoc
    diff --git a/doc/modules/expcore.gui.concepts.center.html b/doc/modules/expcore.gui.concepts.center.html index 9ae4718d..8ee49171 100644 --- a/doc/modules/expcore.gui.concepts.center.html +++ b/doc/modules/expcore.gui.concepts.center.html @@ -35,14 +35,20 @@ - + + +
    -
    -
    -
    - # - CenterFrames._prototype:event_handler ([action=update]) -
    -
    -
    -
    - -

    Creates an event handler that will trigger one of its functions, use with Event.add

    -

    - - - Parameters: - -
      - - - - - -
    • - - action - - : - - (string) - - the action to take on this event - - (default: update) -
    • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:redraw_frame (player) -
    -
    -
    -
    - -

    Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame for - -
    • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:set_auto_focus ([state=true]) -
    -
    -
    -
    - -

    Sets the frame to be the current active gui when opened and closes all other frames

    -

    - - - Parameters: - -
      - - - - - -
    • - - state - - : - - (boolean) - - when true will auto close other frames and set this frame as player.opened - - (default: true) -
    • - - -
    - - - - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames._prototype:toggle_frame (player) -
    -
    -
    -
    - -

    Toggles if the frame is open, if open it will close it and if closed it will open it

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to draw the frame for - -
    • - - -
    - - - - - Returns: -
      -
    • - (boolean) - with the gui frame is now open + the center flow
    @@ -496,7 +296,7 @@
    # - CenterFrames.clear_flow (player) + CenterFrames.clear_flow(player)
    @@ -546,7 +346,7 @@
    # - CenterFrames.draw_frame (player, name) + CenterFrames.draw_frame(player, name)
    @@ -608,120 +408,6 @@ - - - - - - -
    -
    -
    -
    - # - CenterFrames.get_flow (player) -
    -
    -
    -
    - -

    Gets the center flow for a player

    -

    - - - Parameters: - -
      - - - - - -
    • - - player - - : - - (LuaPlayer) - - the player to get the flow for - -
    • - - -
    - - - - - Returns: - - - - - - - - - - -
    -
    -
    -
    - # - CenterFrames.new_frame (permision_name) -
    -
    -
    -
    - -

    Creates a new center frame define

    -

    - - - Parameters: - -
      - - - - - -
    • - - permision_name - - : - - (string) - - the name that can be used with the permision system - -
    • - - -
    - - - - - Returns: -
      -
    • - (table) - the new center frame define -
    • -
    - - - @@ -733,7 +419,7 @@
    # - CenterFrames.redraw_frame (player, name) + CenterFrames.redraw_frame(player, name)
    @@ -806,7 +492,7 @@
    # - CenterFrames.toggle_frame (player, name[, state]) + CenterFrames.toggle_frame(player, name[, state])
    @@ -885,6 +571,336 @@ + + + + + + +
    +
    +
    +
    + # + CenterFrames.new_frame(permision_name) +
    +
    +
    +
    + +

    Creates a new center frame define

    +

    + + + Parameters: + +
      + + + + + +
    • + + permision_name + + : + + (string) + + the name that can be used with the permision system + +
    • + + +
    + + + + + Returns: +
      +
    • + (table) + the new center frame define +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + CenterFrames._prototype:set_auto_focus([state=true]) +
    +
    +
    +
    + +

    Sets the frame to be the current active gui when opened and closes all other frames

    +

    + + + Parameters: + +
      + + + + + +
    • + + state + + : + + (boolean) + + when true will auto close other frames and set this frame as player.opened + + (default: true) +
    • + + +
    + + + + + + + + + + + + + +
    +
    +
    +
    + # + CenterFrames._prototype:draw_frame(player) +
    +
    +
    +
    + +

    Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)

    +

    + + + Parameters: + +
      + + + + + +
    • + + player + + : + + (LuaPlayer) + + the player to draw the frame for + +
    • + + +
    + + + + + Returns: + + + + + + + + + + +
    +
    +
    +
    + # + CenterFrames._prototype:redraw_frame(player) +
    +
    +
    +
    + +

    Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)

    +

    + + + Parameters: + +
      + + + + + +
    • + + player + + : + + (LuaPlayer) + + the player to draw the frame for + +
    • + + +
    + + + + + Returns: + + + + + + + + + + +
    +
    +
    +
    + # + CenterFrames._prototype:toggle_frame(player) +
    +
    +
    +
    + +

    Toggles if the frame is open, if open it will close it and if closed it will open it

    +

    + + + Parameters: + +
      + + + + + +
    • + + player + + : + + (LuaPlayer) + + the player to draw the frame for + +
    • + + +
    + + + + + Returns: +
      +
    • + (boolean) + with the gui frame is now open +
    • +
    + + + + + + + + + +
    +
    +
    +
    + # + CenterFrames._prototype:event_handler([action=update]) +
    +
    +
    +
    + +

    Creates an event handler that will trigger one of its functions, use with Event.add

    +

    + + + Parameters: + +
      + + + + + +
    • + + action + + : + + (string) + + the action to take on this event + + (default: update) +
    • + + +
    + + + + + + + @@ -907,7 +923,7 @@ generated by LDoc
    diff --git a/doc/modules/expcore.gui.concepts.left.html b/doc/modules/expcore.gui.concepts.left.html index 15c736c4..85a9072f 100644 --- a/doc/modules/expcore.gui.concepts.left.html +++ b/doc/modules/expcore.gui.concepts.left.html @@ -35,14 +35,20 @@ - + + +