From 2ab09bb48659c60e5dab19c3380a245e3eb19a17 Mon Sep 17 00:00:00 2001 From: Ezhh Date: Thu, 15 Jun 2017 21:38:41 +0100 Subject: Improve chatcommand params consistency (#5985) * Fix and improve params consistency * Move parenthesis requirement to descriptions --- builtin/game/chatcommands.lua | 44 ++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) (limited to 'builtin/game') diff --git a/builtin/game/chatcommands.lua b/builtin/game/chatcommands.lua index 3dfc29ffa..183e06a03 100644 --- a/builtin/game/chatcommands.lua +++ b/builtin/game/chatcommands.lua @@ -92,7 +92,7 @@ core.register_chatcommand("admin", { }) core.register_chatcommand("privs", { - params = "", + params = "[]", description = "Print privileges of player", func = function(caller, param) param = param:trim() @@ -145,7 +145,7 @@ local function handle_grant_command(caller, grantname, grantprivstr) end core.register_chatcommand("grant", { - params = " |all", + params = " ( | all)", description = "Give privilege to player", func = function(name, param) local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)") @@ -157,7 +157,7 @@ core.register_chatcommand("grant", { }) core.register_chatcommand("grantme", { - params = "|all", + params = " | all", description = "Grant privileges to yourself", func = function(name, param) if param == "" then @@ -168,7 +168,7 @@ core.register_chatcommand("grantme", { }) core.register_chatcommand("revoke", { - params = " |all", + params = " ( | all)", description = "Remove privilege from player", privs = {}, func = function(name, param) @@ -305,7 +305,7 @@ core.register_chatcommand("remove_player", { }) core.register_chatcommand("teleport", { - params = ",, | | ,, | ", + params = ",, | | ( ,,) | ( )", description = "Teleport to player or position", privs = {teleport=true}, func = function(name, param) @@ -413,7 +413,7 @@ core.register_chatcommand("teleport", { }) core.register_chatcommand("set", { - params = "[-n] | ", + params = "([-n] ) | ", description = "Set or read server configuration setting", privs = {server=true}, func = function(name, param) @@ -468,9 +468,9 @@ local function emergeblocks_progress_update(ctx) end core.register_chatcommand("emergeblocks", { - params = "(here [radius]) | ( )", + params = "(here []) | ( )", description = "Load (or, if nonexistent, generate) map blocks " - .. "contained in area pos1 to pos2", + .. "contained in area pos1 to pos2 ( and must be in parentheses)", privs = {server=true}, func = function(name, param) local p1, p2 = parse_range_str(name, param) @@ -494,8 +494,9 @@ core.register_chatcommand("emergeblocks", { }) core.register_chatcommand("deleteblocks", { - params = "(here [radius]) | ( )", - description = "Delete map blocks contained in area pos1 to pos2", + params = "(here []) | ( )", + description = "Delete map blocks contained in area pos1 to pos2 " + .. "( and must be in parentheses)", privs = {server=true}, func = function(name, param) local p1, p2 = parse_range_str(name, param) @@ -513,8 +514,9 @@ core.register_chatcommand("deleteblocks", { }) core.register_chatcommand("fixlight", { - params = "(here [radius]) | ( )", - description = "Resets lighting in the area between pos1 and pos2", + params = "(here []) | ( )", + description = "Resets lighting in the area between pos1 and pos2 " + .. "( and must be in parentheses)", privs = {server = true}, func = function(name, param) local p1, p2 = parse_range_str(name, param) @@ -661,7 +663,7 @@ core.register_on_punchnode(function(pos, node, puncher) end) core.register_chatcommand("rollback_check", { - params = "[] [] [limit]", + params = "[] [] []", description = "Check who last touched a node or a node near it" .. " within the time specified by . Default: range = 0," .. " seconds = 86400 = 24h, limit = 5", @@ -714,7 +716,7 @@ core.register_chatcommand("rollback_check", { }) core.register_chatcommand("rollback", { - params = " [] | : []", + params = "( []) | (: [])", description = "Revert actions of a player. Default for is 60", privs = {rollback=true}, func = function(name, param) @@ -806,8 +808,8 @@ core.register_chatcommand("days", { }) core.register_chatcommand("shutdown", { - description = "Shutdown server", - params = "[delay_in_seconds (non-negative number, or -1 to cancel)] [reconnect] [message]", + params = "[ | -1] [reconnect] []", + description = "Shutdown server (-1 cancels a delayed shutdown)", privs = {server=true}, func = function(name, param) local delay, reconnect, message = param:match("([^ ][-]?[0-9]+)([^ ]+)(.*)") @@ -845,7 +847,7 @@ core.register_chatcommand("ban", { }) core.register_chatcommand("unban", { - params = "", + params = " | ", description = "Remove IP ban", privs = {ban=true}, func = function(name, param) @@ -858,7 +860,7 @@ core.register_chatcommand("unban", { }) core.register_chatcommand("kick", { - params = " [reason]", + params = " []", description = "Kick a player", privs = {kick=true}, func = function(name, param) @@ -877,7 +879,7 @@ core.register_chatcommand("kick", { }) core.register_chatcommand("clearobjects", { - params = "[full|quick]", + params = "[full | quick]", description = "Clear all objects in world", privs = {server=true}, func = function(name, param) @@ -923,7 +925,7 @@ core.register_chatcommand("msg", { }) core.register_chatcommand("last-login", { - params = "[name]", + params = "[]", description = "Get the last login time of a player", func = function(name, param) if param == "" then @@ -940,7 +942,7 @@ core.register_chatcommand("last-login", { }) core.register_chatcommand("clearinv", { - params = "[name]", + params = "[]", description = "Clear the inventory of yourself or another player", func = function(name, param) local player -- cgit v1.2.3