Add more details to chat command help

This commit is contained in:
Jordan Irwin 2021-08-28 13:37:07 -07:00
parent 1ea69bee6f
commit 95bf66aba3
3 changed files with 45 additions and 2 deletions

View File

@ -12,56 +12,79 @@ local commands = {
{
cmd = "help",
params = "[" .. S("command") .. "]",
desc = S("Shows usage info."),
},
{
cmd = "list",
desc = S("Lists all registered shop IDs."),
},
{
cmd = "info",
params = "<" .. S("ID") .. ">",
desc = S("Lists information about a shop."),
},
{
cmd = "register",
params = "<" .. S("ID") .. ">" .. " <sell/buy> "
.. " [" .. S("product1=value,product2=value,...") .. "]",
desc = S("Registers a new shop."),
persists = true,
},
{
cmd = "unregister",
params = "<" .. S("ID") .. ">",
desc = S("Unregisters a shop."),
persists = true,
},
{
cmd = "add",
params = "<" .. S("ID") .. "> <" .. S("product1=value,product2=value,...") .. ">",
desc = S("Adds one or more items to a shop's product list."),
persists = true,
},
{
cmd = "remove",
params = "<" .. S("ID") .. "> <" .. S("product") .. ">",
desc = S("Removes first instance of an item from a shop's product list."),
persists = true,
},
{
cmd = "removeall",
params = "<" .. S("ID") .. "> <" .. S("product") .. ">",
desc = S("Removes all instances of an item from a shop's product list."),
persists = true,
},
{
cmd = "reload",
desc = S("Reloads shops configuration."),
},
}
local format_usage = function(cmd)
local usage = S("Usage:")
if cmd then
usage = usage .. "\n /" .. ss.modname .. " " .. cmd
local params
local desc, params, persists
for _, c in ipairs(commands) do
if c.cmd == cmd then
desc = c.desc
params = c.params
persists = c.persists
break
end
end
usage = usage .. "\n /" .. ss.modname .. " " .. cmd
if params then
usage = usage .. " " .. params
end
if desc then
if persists then
desc = desc .. " " .. S("(changes are written to config)")
end
usage = desc .. "\n\n" .. usage
end
else
for _, c in ipairs(commands) do
usage = usage .. "\n /" .. ss.modname .. " " .. c.cmd

View File

@ -25,6 +25,16 @@ Cannot use shops because there are no registered currencies.=No se pueden usar l
# chat commands
Manage shops configuration.=Administrar configuración de tiendas.
Shows usage info.=Muestra información del uso.
Lists all registered shop IDs.=Muestra todas las ID de tiendas registradas.
Lists information about a shop.=Muestra información de una tienda.
Registers a new shop.=Registra una tienda nueva.
Unregisters a shop.=Quita del registro una tienda.
Adds one or more items to a shop's product list.=Agrega uno o más productos a la lista de una tienda.
Removes first instance of an item from a shop's product list.=Quita el primero instancia de un producto de la lista de una tienda.
Removes all instances of an item from a shop's product list.=Quita todos las instancias de un producto de la lista de una tienda.
Reloads shops configuration.=Vuelva a cargar la configuración de tiendas.
(changes are written to config)=(los cambios están grabados a la configuración)
Usage:=Uso:
command=orden
params=parámetros

View File

@ -25,6 +25,16 @@ Cannot use shops because there are no registered currencies.=
# chat commands
Manage shops configuration.=
Shows usage info.=
Lists all registered shop IDs.=
Lists information about a shop.=
Registers a new shop.=
Unregisters a shop.=
Adds one or more items to a shop's product list.=
Removes first instance of an item from a shop's product list.=
Removes all instances of an item from a shop's product list.=
Reloads shops configuration.=
(changes are written to config)=
Usage:=
command=
params=