Commands

modules/commands/cheat-mode.lua

@@ -1,8 +1,16 @@
+--[[-- Commands Module - Cheat Mode
+    - Adds a command that allows players to enter cheat mode
+    @commands Cheat-Mode
+]]
+
 local Commands = require 'expcore.commands' --- @dep expcore.commands
 require 'config.expcore-commands.parse_general'
 
+--- Toggles cheat mode for your player, or another player.
+-- @command toggle-cheat-mode
+-- @tparam[opt=self] LuaPlayer player player to toggle chest mode of, can be nil for self
 Commands.new_command('toggle-cheat-mode','Toggles cheat mode for your player, or another player.')
-:add_param('player',true,'player') -- player to toggle chest mode of, can be nil for self
+:add_param('player',true,'player')
 :set_defaults{player=function(player)
     return player -- default is the user using the command
 end}