minenux
/
minetest-engine-minetest
1
0
Fork 0
Code Pull Requests Releases Activity

Add success and output return values to chat commands

pull/1129/head
ShadowNinja 2014-01-29 18:27:05 -05:00
parent 832d7973c8
commit e7706593c6
2 changed files with 214 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

446
builtin/game/chatcommands.lua
View File

@ -19,16 +19,21 @@ core.register_on_chat_message(function(name, message)
param = "" param = ""
end end
local cmd_def = core.chatcommands[cmd] local cmd_def = core.chatcommands[cmd]
if cmd_def then if not cmd_def then
local has_privs, missing_privs = core.check_player_privs(name, cmd_def.privs) return false
if has_privs then
cmd_def.func(name, param)
else
core.chat_send_player(name, "You don't have permission to run this command (missing privileges: "..table.concat(missing_privs, ", ")..")")
end
return true -- handled chat message
end end
return false local has_privs, missing_privs = core.check_player_privs(name, cmd_def.privs)
if has_privs then
local success, message = cmd_def.func(name, param)
if message then
core.chat_send_player(name, message)
end
else
core.chat_send_player(name, "You don't have permission"
.. " to run this command (missing privileges: "
.. table.concat(missing_privs, ", ") .. ")")
end
return true -- Handled chat message
end) end)
-- --
@ -45,13 +50,17 @@ core.register_chatcommand("me", {
core.register_chatcommand("help", { core.register_chatcommand("help", {
privs = {}, privs = {},
params = "(nothing)/all/privs/<cmd>", params = "[all/privs/<cmd>]",
description = "Get help for commands or list privileges", description = "Get help for commands or list privileges",
func = function(name, param) func = function(name, param)
local format_help_line = function(cmd, def) local function format_help_line(cmd, def)
local msg = "/"..cmd local msg = "/"..cmd
if def.params and def.params ~= "" then msg = msg .. " " .. def.params end if def.params and def.params ~= "" then
if def.description and def.description ~= "" then msg = msg .. ": " .. def.description end msg = msg .. " " .. def.params
end
if def.description and def.description ~= "" then
msg = msg .. ": " .. def.description
end
return msg return msg
end end
if param == "" then if param == "" then
@ -63,102 +72,90 @@ core.register_chatcommand("help", {
end end
end end
table.sort(cmds) table.sort(cmds)
core.chat_send_player(name, "Available commands: "..table.concat(cmds, " ")) return true, "Available commands: " .. table.concat(cmds, " ") .. "\n"
core.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.") .. "Use '/help <cmd>' to get more information,"
.. " or '/help all' to list everything."
elseif param == "all" then elseif param == "all" then
local cmds = {} local cmds = {}
for cmd, def in pairs(core.chatcommands) do for cmd, def in pairs(core.chatcommands) do
if core.check_player_privs(name, def.privs) then if core.check_player_privs(name, def.privs) then
table.insert(cmds, cmd) table.insert(cmds, format_help_line(cmd, def))
end end
end end
table.sort(cmds) table.sort(cmds)
core.chat_send_player(name, "Available commands:") return true, "Available commands:\n"..table.concat(cmds, "\n")
for _, cmd in ipairs(cmds) do
local def = core.chatcommands[cmd]
core.chat_send_player(name, format_help_line(cmd, def))
end
elseif param == "privs" then elseif param == "privs" then
local privs = {} local privs = {}
for priv, def in pairs(core.registered_privileges) do for priv, def in pairs(core.registered_privileges) do
table.insert(privs, priv) table.insert(privs, priv .. ": " .. def.description)
end end
table.sort(privs) table.sort(privs)
core.chat_send_player(name, "Available privileges:") return true, "Available privileges:\n"..table.concat(privs, "\n")
for _, priv in ipairs(privs) do
local def = core.registered_privileges[priv]
core.chat_send_player(name, priv..": "..def.description)
end
else else
local cmd = param local cmd = param
def = core.chatcommands[cmd] local def = core.chatcommands[cmd]
if not def then if not def then
core.chat_send_player(name, "Command not available: "..cmd) return false, "Command not available: "..cmd
else else
core.chat_send_player(name, format_help_line(cmd, def)) return true, format_help_line(cmd, def)
end end
end end
end, end,
}) })
core.register_chatcommand("privs", { core.register_chatcommand("privs", {
params = "<name>", params = "<name>",
description = "print out privileges of player", description = "print out privileges of player",
func = function(name, param) func = function(name, param)
if param == "" then param = (param ~= "" and param or name)
param = name return true, "Privileges of " .. param .. ": "
else .. core.privs_to_string(
--[[if not core.check_player_privs(name, {privs=true}) then core.get_player_privs(param), ' ')
core.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
return
end]]
end
core.chat_send_player(name, "Privileges of "..param..": "..core.privs_to_string(core.get_player_privs(param), ' '))
end, end,
}) })
core.register_chatcommand("grant", { core.register_chatcommand("grant", {
params = "<name> <privilege>|all", params = "<name> <privilege>|all",
description = "Give privilege to player", description = "Give privilege to player",
privs = {},
func = function(name, param) func = function(name, param)
if not core.check_player_privs(name, {privs=true}) and if not core.check_player_privs(name, {privs=true}) and
not core.check_player_privs(name, {basic_privs=true}) then not core.check_player_privs(name, {basic_privs=true}) then
core.chat_send_player(name, "Your privileges are insufficient.") return false, "Your privileges are insufficient."
return
end end
local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)") local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
if not grantname or not grantprivstr then if not grantname or not grantprivstr then
core.chat_send_player(name, "Invalid parameters (see /help grant)") return false, "Invalid parameters (see /help grant)"
return
elseif not core.auth_table[grantname] then elseif not core.auth_table[grantname] then
core.chat_send_player(name, "Player "..grantname.." does not exist.") return false, "Player " .. grantname .. " does not exist."
return
end end
local grantprivs = core.string_to_privs(grantprivstr) local grantprivs = core.string_to_privs(grantprivstr)
if grantprivstr == "all" then if grantprivstr == "all" then
grantprivs = core.registered_privileges grantprivs = core.registered_privileges
end end
local privs = core.get_player_privs(grantname) local privs = core.get_player_privs(grantname)
local privs_known = true local privs_unknown = ""
for priv, _ in pairs(grantprivs) do for priv, _ in pairs(grantprivs) do
if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not core.check_player_privs(name, {privs=true}) then if priv ~= "interact" and priv ~= "shout" and
core.chat_send_player(name, "Your privileges are insufficient.") not core.check_player_privs(name, {privs=true}) then
return return false, "Your privileges are insufficient."
end end
if not core.registered_privileges[priv] then if not core.registered_privileges[priv] then
core.chat_send_player(name, "Unknown privilege: "..priv) privs_unknown = privs_unknown .. "Unknown privilege: " .. priv .. "\n"
privs_known = false
end end
privs[priv] = true privs[priv] = true
end end
if not privs_known then if privs_unknown ~= "" then
return return false, privs_unknown
end end
core.set_player_privs(grantname, privs) core.set_player_privs(grantname, privs)
core.log(name..' granted ('..core.privs_to_string(grantprivs, ', ')..') privileges to '..grantname) core.log("action", name..' granted ('..core.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
core.chat_send_player(name, "Privileges of "..grantname..": "..core.privs_to_string(core.get_player_privs(grantname), ' '))
if grantname ~= name then if grantname ~= name then
core.chat_send_player(grantname, name.." granted you privileges: "..core.privs_to_string(grantprivs, ' ')) core.chat_send_player(grantname, name
.. " granted you privileges: "
.. core.privs_to_string(grantprivs, ' '))
end end
return true, "Privileges of " .. grantname .. ": "
.. core.privs_to_string(
core.get_player_privs(grantname), ' ')
end, end,
}) })
core.register_chatcommand("revoke", { core.register_chatcommand("revoke", {
@ -168,40 +165,44 @@ core.register_chatcommand("revoke", {
func = function(name, param) func = function(name, param)
if not core.check_player_privs(name, {privs=true}) and if not core.check_player_privs(name, {privs=true}) and
not core.check_player_privs(name, {basic_privs=true}) then not core.check_player_privs(name, {basic_privs=true}) then
core.chat_send_player(name, "Your privileges are insufficient.") return false, "Your privileges are insufficient."
return
end end
local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)") local revoke_name, revoke_priv_str = string.match(param, "([^ ]+) (.+)")
if not revokename or not revokeprivstr then if not revoke_name or not revoke_priv_str then
core.chat_send_player(name, "Invalid parameters (see /help revoke)") return false, "Invalid parameters (see /help revoke)"
return elseif not core.auth_table[revoke_name] then
elseif not core.auth_table[revokename] then return false, "Player " .. revoke_name .. " does not exist."
core.chat_send_player(name, "Player "..revokename.." does not exist.")
return
end end
local revokeprivs = core.string_to_privs(revokeprivstr) local revoke_privs = core.string_to_privs(revoke_priv_str)
local privs = core.get_player_privs(revokename) local privs = core.get_player_privs(revoke_name)
for priv, _ in pairs(revokeprivs) do for priv, _ in pairs(revoke_privs) do
if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not core.check_player_privs(name, {privs=true}) then if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and
core.chat_send_player(name, "Your privileges are insufficient.") not core.check_player_privs(name, {privs=true}) then
return return false, "Your privileges are insufficient."
end end
end end
if revokeprivstr == "all" then if revoke_priv_str == "all" then
privs = {} privs = {}
else else
for priv, _ in pairs(revokeprivs) do for priv, _ in pairs(revoke_privs) do
privs[priv] = nil privs[priv] = nil
end end
end end
core.set_player_privs(revokename, privs) core.set_player_privs(revoke_name, privs)
core.log(name..' revoked ('..core.privs_to_string(revokeprivs, ', ')..') privileges from '..revokename) core.log("action", name..' revoked ('
core.chat_send_player(name, "Privileges of "..revokename..": "..core.privs_to_string(core.get_player_privs(revokename), ' ')) ..core.privs_to_string(revoke_privs, ', ')
if revokename ~= name then ..') privileges from '..revoke_name)
core.chat_send_player(revokename, name.." revoked privileges from you: "..core.privs_to_string(revokeprivs, ' ')) if revoke_name ~= name then
core.chat_send_player(revoke_name, name
.. " revoked privileges from you: "
.. core.privs_to_string(revoke_privs, ' '))
end end
return true, "Privileges of " .. revoke_name .. ": "
.. core.privs_to_string(
core.get_player_privs(revoke_name), ' ')
end, end,
}) })
core.register_chatcommand("setpassword", { core.register_chatcommand("setpassword", {
params = "<name> <password>", params = "<name> <password>",
description = "set given password", description = "set given password",
@ -209,27 +210,30 @@ core.register_chatcommand("setpassword", {
func = function(name, param) func = function(name, param)
local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$") local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
if not toname then if not toname then
toname = string.match(param, "^([^ ]+) *$") toname = param:match("^([^ ]+) *$")
raw_password = nil raw_password = nil
end end
if not toname then if not toname then
core.chat_send_player(name, "Name field required") return false, "Name field required"
return
end end
local actstr = "?" local actstr = "?"
if not raw_password then if not raw_password then
core.set_player_password(toname, "") core.set_player_password(toname, "")
actstr = "cleared" actstr = "cleared"
else else
core.set_player_password(toname, core.get_password_hash(toname, raw_password)) core.set_player_password(toname,
core.get_password_hash(toname,
raw_password))
actstr = "set" actstr = "set"
end end
core.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
if toname ~= name then if toname ~= name then
core.chat_send_player(toname, "Your password was "..actstr.." by "..name) core.chat_send_player(toname, "Your password was "
.. actstr .. " by " .. name)
end end
return true, "Password of player \"" .. toname .. "\" " .. actstr
end, end,
}) })
core.register_chatcommand("clearpassword", { core.register_chatcommand("clearpassword", {
params = "<name>", params = "<name>",
description = "set empty password", description = "set empty password",
@ -237,11 +241,10 @@ core.register_chatcommand("clearpassword", {
func = function(name, param) func = function(name, param)
toname = param toname = param
if toname == "" then if toname == "" then
core.chat_send_player(name, "Name field required") return false, "Name field required"
return
end end
core.set_player_password(toname, '') core.set_player_password(toname, '')
core.chat_send_player(name, "Password of player \""..toname.."\" cleared") return true, "Password of player \"" .. toname .. "\" cleared"
end, end,
}) })
@ -251,11 +254,7 @@ core.register_chatcommand("auth_reload", {
privs = {server=true}, privs = {server=true},
func = function(name, param) func = function(name, param)
local done = core.auth_reload() local done = core.auth_reload()
if done then return done, (done and "Done." or "Failed.")
core.chat_send_player(name, "Done.")
else
core.chat_send_player(name, "Failed.")
end
end, end,
}) })
@ -293,15 +292,14 @@ core.register_chatcommand("teleport", {
p.z = tonumber(p.z) p.z = tonumber(p.z)
teleportee = core.get_player_by_name(name) teleportee = core.get_player_by_name(name)
if teleportee and p.x and p.y and p.z then if teleportee and p.x and p.y and p.z then
core.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
teleportee:setpos(p) teleportee:setpos(p)
return return true, "Teleporting to "..core.pos_to_string(p)
end end
local teleportee = nil local teleportee = nil
local p = nil local p = nil
local target_name = nil local target_name = nil
target_name = string.match(param, "^([^ ]+)$") target_name = param:match("^([^ ]+)$")
teleportee = core.get_player_by_name(name) teleportee = core.get_player_by_name(name)
if target_name then if target_name then
local target = core.get_player_by_name(target_name) local target = core.get_player_by_name(target_name)
@ -311,26 +309,25 @@ core.register_chatcommand("teleport", {
end end
if teleportee and p then if teleportee and p then
p = find_free_position_near(p) p = find_free_position_near(p)
core.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
teleportee:setpos(p) teleportee:setpos(p)
return return true, "Teleporting to " .. target_name
.. " at "..core.pos_to_string(p)
end end
if core.check_player_privs(name, {bring=true}) then if core.check_player_privs(name, {bring=true}) then
local teleportee = nil local teleportee = nil
local p = {} local p = {}
local teleportee_name = nil local teleportee_name = nil
teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$") teleportee_name, p.x, p.y, p.z = param:match(
p.x = tonumber(p.x) "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
p.y = tonumber(p.y) p.x, p.y, p.z = tonumber(p.x), tonumber(p.y), tonumber(p.z)
p.z = tonumber(p.z)
if teleportee_name then if teleportee_name then
teleportee = core.get_player_by_name(teleportee_name) teleportee = core.get_player_by_name(teleportee_name)
end end
if teleportee and p.x and p.y and p.z then if teleportee and p.x and p.y and p.z then
core.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
teleportee:setpos(p) teleportee:setpos(p)
return return true, "Teleporting " .. teleportee_name
.. " to " .. core.pos_to_string(p)
end end
local teleportee = nil local teleportee = nil
@ -349,14 +346,15 @@ core.register_chatcommand("teleport", {
end end
if teleportee and p then if teleportee and p then
p = find_free_position_near(p) p = find_free_position_near(p)
core.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
teleportee:setpos(p) teleportee:setpos(p)
return return true, "Teleporting " .. teleportee_name
.. " to " .. target_name
.. " at " .. core.pos_to_string(p)
end end
end end
core.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)") return false, 'Invalid parameters ("' .. param
return .. '") or player not found (see /help teleport)'
end, end,
}) })
@ -368,18 +366,15 @@ core.register_chatcommand("set", {
local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)") local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
if arg and arg == "-n" and setname and setvalue then if arg and arg == "-n" and setname and setvalue then
core.setting_set(setname, setvalue) core.setting_set(setname, setvalue)
core.chat_send_player(name, setname.." = "..setvalue) return true, setname .. " = " .. setvalue
return
end end
local setname, setvalue = string.match(param, "([^ ]+) (.+)") local setname, setvalue = string.match(param, "([^ ]+) (.+)")
if setname and setvalue then if setname and setvalue then
if not core.setting_get(setname) then if not core.setting_get(setname) then
core.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.") return false, "Failed. Use '/set -n <name> <value>' to create a new setting."
return
end end
core.setting_set(setname, setvalue) core.setting_set(setname, setvalue)
core.chat_send_player(name, setname.." = "..setvalue) return true, setname .. " = " .. setvalue
return
end end
local setname = string.match(param, "([^ ]+)") local setname = string.match(param, "([^ ]+)")
if setname then if setname then
@ -387,47 +382,33 @@ core.register_chatcommand("set", {
if not setvalue then if not setvalue then
setvalue = "<not set>" setvalue = "<not set>"
end end
core.chat_send_player(name, setname.." = "..setvalue) return true, setname .. " = " .. setvalue
return
end end
core.chat_send_player(name, "Invalid parameters (see /help set)") return false, "Invalid parameters (see /help set)."
end, end,
}) })
core.register_chatcommand("mods", { core.register_chatcommand("mods", {
params = "", params = "",
description = "lists mods installed on the server", description = "List mods installed on the server",
privs = {}, privs = {},
func = function(name, param) func = function(name, param)
local response = "" return true, table.concat(core.get_modnames(), ", ")
local modnames = core.get_modnames()
for i, mod in ipairs(modnames) do
response = response .. mod
-- Add space if not at the end
if i ~= #modnames then
response = response .. " "
end
end
core.chat_send_player(name, response)
end, end,
}) })
local function handle_give_command(cmd, giver, receiver, stackstring) local function handle_give_command(cmd, giver, receiver, stackstring)
core.log("action", giver.." invoked "..cmd..', stackstring="' core.log("action", giver .. " invoked " .. cmd
..stackstring..'"') .. ', stackstring="' .. stackstring .. '"')
core.log(cmd..' invoked, stackstring="'..stackstring..'"')
local itemstack = ItemStack(stackstring) local itemstack = ItemStack(stackstring)
if itemstack:is_empty() then if itemstack:is_empty() then
core.chat_send_player(giver, 'error: cannot give an empty item') return false, "Cannot give an empty item"
return
elseif not itemstack:is_known() then elseif not itemstack:is_known() then
core.chat_send_player(giver, 'error: cannot give an unknown item') return false, "Cannot give an unknown item"
return
end end
local receiverref = core.get_player_by_name(receiver) local receiverref = core.get_player_by_name(receiver)
if receiverref == nil then if receiverref == nil then
core.chat_send_player(giver, receiver..' is not a known player') return false, receiver .. " is not a known player"
return
end end
local leftover = receiverref:get_inventory():add_item("main", itemstack) local leftover = receiverref:get_inventory():add_item("main", itemstack)
if leftover:is_empty() then if leftover:is_empty() then
@ -441,81 +422,79 @@ local function handle_give_command(cmd, giver, receiver, stackstring)
-- entered (e.g. big numbers are always interpreted as 2^16-1). -- entered (e.g. big numbers are always interpreted as 2^16-1).
stackstring = itemstack:to_string() stackstring = itemstack:to_string()
if giver == receiver then if giver == receiver then
core.chat_send_player(giver, '"'..stackstring return true, ("%q %sadded to inventory.")
..'" '..partiality..'added to inventory.'); :format(stackstring, partiality)
else else
core.chat_send_player(giver, '"'..stackstring core.chat_send_player(receiver, ("%q %sadded to inventory.")
..'" '..partiality..'added to '..receiver..'\'s inventory.'); :format(stackstring, partiality))
core.chat_send_player(receiver, '"'..stackstring return true, ("%q %sadded to %s's inventory.")
..'" '..partiality..'added to inventory.'); :format(stackstring, partiality, receiver)
end end
end end
core.register_chatcommand("give", { core.register_chatcommand("give", {
params = "<name> <itemstring>", params = "<name> <ItemString>",
description = "give item to player", description = "give item to player",
privs = {give=true}, privs = {give=true},
func = function(name, param) func = function(name, param)
local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$") local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
if not toname or not itemstring then if not toname or not itemstring then
core.chat_send_player(name, "name and itemstring required") return false, "Name and ItemString required"
return
end end
handle_give_command("/give", name, toname, itemstring) return handle_give_command("/give", name, toname, itemstring)
end, end,
}) })
core.register_chatcommand("giveme", { core.register_chatcommand("giveme", {
params = "<itemstring>", params = "<ItemString>",
description = "give item to yourself", description = "give item to yourself",
privs = {give=true}, privs = {give=true},
func = function(name, param) func = function(name, param)
local itemstring = string.match(param, "(.+)$") local itemstring = string.match(param, "(.+)$")
if not itemstring then if not itemstring then
core.chat_send_player(name, "itemstring required") return false, "ItemString required"
return
end end
handle_give_command("/giveme", name, name, itemstring) return handle_give_command("/giveme", name, name, itemstring)
end, end,
}) })
core.register_chatcommand("spawnentity", { core.register_chatcommand("spawnentity", {
params = "<entityname>", params = "<EntityName>",
description = "spawn entity at your position", description = "Spawn entity at your position",
privs = {give=true, interact=true}, privs = {give=true, interact=true},
func = function(name, param) func = function(name, param)
local entityname = string.match(param, "(.+)$") local entityname = string.match(param, "(.+)$")
if not entityname then if not entityname then
core.chat_send_player(name, "entityname required") return false, "EntityName required"
return
end end
core.log("action", '/spawnentity invoked, entityname="'..entityname..'"') core.log("action", ("/spawnentity invoked, entityname=%q")
:format(entityname))
local player = core.get_player_by_name(name) local player = core.get_player_by_name(name)
if player == nil then if player == nil then
core.log("error", "Unable to spawn entity, player is nil") core.log("error", "Unable to spawn entity, player is nil")
return true -- Handled chat message return false, "Unable to spawn entity, player is nil"
end end
local p = player:getpos() local p = player:getpos()
p.y = p.y + 1 p.y = p.y + 1
core.add_entity(p, entityname) core.add_entity(p, entityname)
core.chat_send_player(name, '"'..entityname return true, ("%q spawned."):format(entityname)
..'" spawned.');
end, end,
}) })
core.register_chatcommand("pulverize", { core.register_chatcommand("pulverize", {
params = "", params = "",
description = "delete item in hand", description = "Destroy item in hand",
privs = {},
func = function(name, param) func = function(name, param)
local player = core.get_player_by_name(name) local player = core.get_player_by_name(name)
if player == nil then if not player then
core.log("error", "Unable to pulverize, player is nil") core.log("error", "Unable to pulverize, no player.")
return true -- Handled chat message return false, "Unable to pulverize, no player."
end end
if player:get_wielded_item():is_empty() then if player:get_wielded_item():is_empty() then
core.chat_send_player(name, 'Unable to pulverize, no item in hand.') return false, "Unable to pulverize, no item in hand."
else
player:set_wielded_item(nil)
core.chat_send_player(name, 'An item was pulverized.')
end end
player:set_wielded_item(nil)
return true, "An item was pulverized."
end, end,
}) })
@ -532,8 +511,9 @@ end)
core.register_chatcommand("rollback_check", { core.register_chatcommand("rollback_check", {
params = "[<range>] [<seconds>] [limit]", params = "[<range>] [<seconds>] [limit]",
description = "check who has last touched a node or near it, ".. description = "Check who has last touched a node or near it,"
"max. <seconds> ago (default range=0, seconds=86400=24h, limit=5)", .. " max. <seconds> ago (default range=0,"
.. " seconds=86400=24h, limit=5)",
privs = {rollback=true}, privs = {rollback=true},
func = function(name, param) func = function(name, param)
local range, seconds, limit = local range, seconds, limit =
@ -542,20 +522,18 @@ core.register_chatcommand("rollback_check", {
seconds = tonumber(seconds) or 86400 seconds = tonumber(seconds) or 86400
limit = tonumber(limit) or 5 limit = tonumber(limit) or 5
if limit > 100 then if limit > 100 then
core.chat_send_player(name, "That limit is too high!") return false, "That limit is too high!"
return
end end
core.chat_send_player(name, "Punch a node (range="..
range..", seconds="..seconds.."s, limit="..limit..")")
core.rollback_punch_callbacks[name] = function(pos, node, puncher) core.rollback_punch_callbacks[name] = function(pos, node, puncher)
local name = puncher:get_player_name() local name = puncher:get_player_name()
core.chat_send_player(name, "Checking "..core.pos_to_string(pos).."...") core.chat_send_player(name, "Checking " .. core.pos_to_string(pos) .. "...")
local actions = core.rollback_get_node_actions(pos, range, seconds, limit) local actions = core.rollback_get_node_actions(pos, range, seconds, limit)
local num_actions = #actions local num_actions = #actions
if num_actions == 0 then if num_actions == 0 then
core.chat_send_player(name, "Nobody has touched the ".. core.chat_send_player(name, "Nobody has touched"
"specified location in "..seconds.." seconds") .. " the specified location in "
.. seconds .. " seconds")
return return
end end
local time = os.time() local time = os.time()
@ -571,6 +549,9 @@ core.register_chatcommand("rollback_check", {
time - action.time)) time - action.time))
end end
end end
return true, "Punch a node (range=" .. range .. ", seconds="
.. seconds .. "s, limit=" .. limit .. ")"
end, end,
}) })
@ -584,37 +565,35 @@ core.register_chatcommand("rollback", {
local player_name = nil local player_name = nil
player_name, seconds = string.match(param, "([^ ]+) *(%d*)") player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
if not player_name then if not player_name then
core.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check") return false, "Invalid parameters. See /help rollback"
return .. " and /help rollback_check."
end end
target_name = "player:"..player_name target_name = "player:"..player_name
end end
seconds = tonumber(seconds) or 60 seconds = tonumber(seconds) or 60
core.chat_send_player(name, "Reverting actions of ".. core.chat_send_player(name, "Reverting actions of "
target_name.." since "..seconds.." seconds.") .. target_name .. " since "
.. seconds .. " seconds.")
local success, log = core.rollback_revert_actions_by( local success, log = core.rollback_revert_actions_by(
target_name, seconds) target_name, seconds)
local response = ""
if #log > 100 then if #log > 100 then
core.chat_send_player(name, "(log is too long to show)") response = "(log is too long to show)\n"
else else
for _, line in pairs(log) do for _, line in pairs(log) do
core.chat_send_player(name, line) response = response .. line .. "\n"
end end
end end
if success then response = response .. "Reverting actions "
core.chat_send_player(name, "Reverting actions succeeded.") .. (success and "succeeded." or "FAILED.")
else return success, response
core.chat_send_player(name, "Reverting actions FAILED.")
end
end, end,
}) })
core.register_chatcommand("status", { core.register_chatcommand("status", {
params = "", description = "Print server status",
description = "print server status line",
privs = {},
func = function(name, param) func = function(name, param)
core.chat_send_player(name, core.get_server_status()) return true, core.get_server_status()
end, end,
}) })
@ -624,22 +603,19 @@ core.register_chatcommand("time", {
privs = {settime=true}, privs = {settime=true},
func = function(name, param) func = function(name, param)
if param == "" then if param == "" then
core.chat_send_player(name, "Missing parameter") return false, "Missing time."
return
end end
local newtime = tonumber(param) local newtime = tonumber(param)
if newtime == nil then if newtime == nil then
core.chat_send_player(name, "Invalid time") return false, "Invalid time."
else
core.set_timeofday((newtime % 24000) / 24000)
core.chat_send_player(name, "Time of day changed.")
core.log("action", name .. " sets time " .. newtime)
end end
core.set_timeofday((newtime % 24000) / 24000)
core.log("action", name .. " sets time " .. newtime)
return true, "Time of day changed."
end, end,
}) })
core.register_chatcommand("shutdown", { core.register_chatcommand("shutdown", {
params = "",
description = "shutdown server", description = "shutdown server",
privs = {server=true}, privs = {server=true},
func = function(name, param) func = function(name, param)
@ -651,24 +627,21 @@ core.register_chatcommand("shutdown", {
core.register_chatcommand("ban", { core.register_chatcommand("ban", {
params = "<name>", params = "<name>",
description = "ban IP of player", description = "Ban IP of player",
privs = {ban=true}, privs = {ban=true},
func = function(name, param) func = function(name, param)
if param == "" then if param == "" then
core.chat_send_player(name, "Ban list: " .. core.get_ban_list()) return true, "Ban list: " .. core.get_ban_list()
return
end end
if not core.get_player_by_name(param) then if not core.get_player_by_name(param) then
core.chat_send_player(name, "No such player") return false, "No such player."
return
end end
if not core.ban_player(param) then if not core.ban_player(param) then
core.chat_send_player(name, "Failed to ban player") return false, "Failed to ban player."
else
local desc = core.get_ban_description(param)
core.chat_send_player(name, "Banned " .. desc .. ".")
core.log("action", name .. " bans " .. desc .. ".")
end end
local desc = core.get_ban_description(param)
core.log("action", name .. " bans " .. desc .. ".")
return true, "Banned " .. desc .. "."
end, end,
}) })
@ -678,11 +651,10 @@ core.register_chatcommand("unban", {
privs = {ban=true}, privs = {ban=true},
func = function(name, param) func = function(name, param)
if not core.unban_player_or_ip(param) then if not core.unban_player_or_ip(param) then
core.chat_send_player(name, "Failed to unban player/IP") return false, "Failed to unban player/IP."
else
core.chat_send_player(name, "Unbanned " .. param)
core.log("action", name .. " unbans " .. param)
end end
core.log("action", name .. " unbans " .. param)
return true, "Unbanned " .. param
end, end,
}) })
@ -691,28 +663,26 @@ core.register_chatcommand("kick", {
description = "kick a player", description = "kick a player",
privs = {kick=true}, privs = {kick=true},
func = function(name, param) func = function(name, param)
local tokick, reason = string.match(param, "([^ ]+) (.+)") local tokick, reason = param:match("([^ ]+) (.+)")
if not tokick then tokick = tokick or param
tokick = param
end
if not core.kick_player(tokick, reason) then if not core.kick_player(tokick, reason) then
core.chat_send_player(name, "Failed to kick player " .. tokick) return false, "Failed to kick player " .. tokick
else
core.chat_send_player(name, "kicked " .. tokick)
core.log("action", name .. " kicked " .. tokick)
end end
core.log("action", name .. " kicked " .. tokick)
return true, "Kicked " .. tokick
end, end,
}) })
core.register_chatcommand("clearobjects", { core.register_chatcommand("clearobjects", {
params = "",
description = "clear all objects in world", description = "clear all objects in world",
privs = {server=true}, privs = {server=true},
func = function(name, param) func = function(name, param)
core.log("action", name .. " clears all objects") core.log("action", name .. " clears all objects.")
core.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")") core.chat_send_all("Clearing all objects. This may take long."
.. " You may experience a timeout. (by "
.. name .. ")")
core.clear_objects() core.clear_objects()
core.log("action", "object clearing done") core.log("action", "Object clearing done.")
core.chat_send_all("*** Cleared all objects.") core.chat_send_all("*** Cleared all objects.")
end, end,
}) })
@ -722,17 +692,19 @@ core.register_chatcommand("msg", {
description = "Send a private message", description = "Send a private message",
privs = {shout=true}, privs = {shout=true},
func = function(name, param) func = function(name, param)
local found, _, sendto, message = param:find("^([^%s]+)%s(.+)$") local sendto, message = param:match("^(%S+)%s(.+)$")
if found then if not sendto then
if core.get_player_by_name(sendto) then return false, "Invalid usage, see /help msg."
core.log("action", "PM from "..name.." to "..sendto..": "..message)
core.chat_send_player(sendto, "PM from "..name..": "..message)
core.chat_send_player(name, "Message sent")
else
core.chat_send_player(name, "The player "..sendto.." is not online")
end
else
core.chat_send_player(name, "Invalid usage, see /help msg")
end end
if not core.get_player_by_name(sendto) then
return false, "The player " .. sendto
.. " is not online."
end
core.log("action", "PM from " .. name .. " to " .. sendto
.. ": " .. message)
core.chat_send_player(sendto, "PM from " .. name .. ": "
.. message)
return true, "Message sent."
end, end,
}) })

9
doc/lua_api.txt
View File

@ -2543,10 +2543,11 @@ Decoration definition (register_decoration)
Chatcommand definition (register_chatcommand) Chatcommand definition (register_chatcommand)
{ {
params = "<name> <privilege>", -- short parameter description params = "<name> <privilege>", -- Short parameter description
description = "Remove privilege from player", -- full description description = "Remove privilege from player", -- Full description
privs = {privs=true}, -- require the "privs" privilege to run privs = {privs=true}, -- Require the "privs" privilege to run
func = function(name, param), -- called when command is run func = function(name, param), -- Called when command is run.
-- Returns boolean success and text output.
} }
Detached inventory callbacks Detached inventory callbacks