games/RedMew
1
0
Fork 0
mirror of https://github.com/Refactorio/RedMew.git synced 2025-09-16 09:16:22 +02:00
Code Issues Releases Activity

Added a bit more documentation

Browse Source
This commit is contained in:
Lynn
2018-11-30 19:15:11 +01:00
parent f88b05448e
commit 1f99757654
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
utils/command.lua
View File

@@ -9,15 +9,15 @@ local serialize = serpent.line
local Command = {} local Command = {}
local option_names = { local option_names = {
['description'] = true, ['description'] = 'A description of the command',
['arguments'] = true, ['arguments'] = 'A table of arguments, example: {"foo", "bar"} would map the first 2 arguments to foo and bar',
['default_values'] = true, ['default_values'] = 'A default value for a given argument when omitted, example: {bar = false}',
['admin_only'] = true, ['admin_only'] = 'Set this to true if only admins may execute this command',
['debug_only'] = true, ['debug_only'] = 'Set this to true if it should only be registered when _DEBUG is true',
['allowed_by_server'] = true, ['allowed_by_server'] = 'Set to true if the server (host) may execute this command',
['allowed_by_player'] = true, ['allowed_by_player'] = 'Set to false to disable players from executing this command',
['log_command'] = true, ['log_command'] = 'Set to true to log commands. Always true when admin_only is enabled',
['capture_excess_arguments'] = true, ['capture_excess_arguments'] = 'Allows the last argument to be the remaining text in the command',
} }
---Validates if there aren't any wrong fields in the options. ---Validates if there aren't any wrong fields in the options.
@@ -41,7 +41,7 @@ end
---Options table accepts the following structure: { ---Options table accepts the following structure: {
--- description = 'A description of the command', --- description = 'A description of the command',
--- arguments = {'foo', 'bar'}, -- maps arguments to these names in the given sequence --- arguments = {'foo', 'bar'}, -- maps arguments to these names in the given sequence
--- default_values = {'bar' = nil}, -- gives a default value to 'bar' when omitted --- default_values = {bar = false}, -- gives a default value to 'bar' when omitted
--- admin_only = true, -- defaults to false --- admin_only = true, -- defaults to false
--- debug_only = false, -- only registers it if _DEBUG is set to true when false --- debug_only = false, -- only registers it if _DEBUG is set to true when false
--- allowed_by_server = false -- lets the server execute this, defaults to false --- allowed_by_server = false -- lets the server execute this, defaults to false