diff --git a/api.lua b/api.lua
index 17b2a1b..a894148 100644
--- a/api.lua
+++ b/api.lua
@@ -153,7 +153,7 @@ if cleaner.unsafe then
--- Retrieves list of ores to be removed.
--
- -- @treturn table Ores to be replaced.
+ -- @treturn table Ores to be removed.
function cleaner.get_remove_ores()
return remove_ores
end
diff --git a/chat.lua b/chat.lua
index 73f9c52..83a6e34 100644
--- a/chat.lua
+++ b/chat.lua
@@ -211,9 +211,16 @@ end
--- Removes nearby entities.
--
+--
Required Privileges:
+--
+-- - server
+--
-- @chatcmd remove_entities
-- @param entity Entity technical name.
--- @tparam[opt] int radius
+-- @tparam[opt] int radius Search radius (default: 100).
+-- @usage
+-- # remove all mobs:horse entities within a radius of 10 nodes
+-- /remove_entities mobs:horse 10
core.register_chatcommand(cmd_repo.entity.cmd, {
privs = {server=true},
description = S("Remove an entity from game.") .. "\n\n"
@@ -271,9 +278,16 @@ core.register_chatcommand(cmd_repo.entity.cmd, {
--- Removes nearby nodes.
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd remove_nodes
-- @param node Node technical name.
--- @tparam[opt] int radius
+-- @tparam[opt] int radius Search radius (default: 5).
+-- @usage
+-- # remove all default:dirt nodes within a radius of 10
+-- /remove_nodes default:dirt 10
core.register_chatcommand(cmd_repo.rem_node.cmd, {
privs = {server=true},
description = S("Remove a node from game.") .. "\n\n"
@@ -323,9 +337,16 @@ core.register_chatcommand(cmd_repo.rem_node.cmd, {
--- Replaces an item.
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd replace_items
-- @param old_item Technical name of item to replace.
-- @param new_item Technical name of item to be used in place.
+-- @usage
+-- # replace default:sword_wood with default:sword_mese
+-- /replace_items default:sword_wood default:sword_mese
core.register_chatcommand(cmd_repo.item.cmd, {
privs = {server=true},
description = S("Replace an item in game.") .. "\n\n"
@@ -351,10 +372,17 @@ core.register_chatcommand(cmd_repo.item.cmd, {
--- Replaces nearby nodes.
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd replace_nodes
-- @param old_node Technical name of node to replace.
-- @param new_node Technical name of node to be used in place.
--- @tparam[opt] int radius
+-- @tparam[opt] int radius Search radius (default: 5).
+-- @usage
+-- # replace all default:dirt nodes with default:cobble within a radius of 10
+-- /replace_nodes default:dirt default:cobble 10
core.register_chatcommand(cmd_repo.rep_node.cmd, {
privs = {server=true},
description = S("Replace a node in game.") .. "\n\n"
@@ -408,8 +436,15 @@ core.register_chatcommand(cmd_repo.rep_node.cmd, {
--- Checks for nearby unknown nodes.
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd find_unknown_nodes
--- @tparam[opt] int radius Search radius.
+-- @tparam[opt] int radius Search radius (default: 100).
+-- @usage
+-- # print names of all unknown nodes within radius of 10
+-- /find_unknown_nodes 10
core.register_chatcommand(cmd_repo.find_node.cmd, {
privs = {server=true},
description = S("Find names of unknown nodes.") .. "\n\n"
@@ -464,8 +499,15 @@ core.register_chatcommand(cmd_repo.find_node.cmd, {
--- Finds names of nearby nodes.
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd find_nearby_nodes
--- @tparam[opt] int radius Search radius.
+-- @tparam[opt] int radius Search radius (default: 5).
+-- @usage
+-- # print names of all node types found within radius of 10
+-- /find_nearby_nodes 10
core.register_chatcommand(cmd_repo.near_node.cmd, {
privs = {server=true},
description = S("Find names of nearby nodes.") .. "\n\n"
@@ -530,8 +572,15 @@ core.register_chatcommand(cmd_repo.near_node.cmd, {
if cleaner.unsafe then
--- Registers an ore to be removed.
--
+ -- Required Privileges:
+ --
+ -- - server
+ --
-- @chatcmd remove_ores
-- @param ore Ore technical name.
+ -- @usage
+ -- # remove all registered ores that add default:stone_with_iron to world
+ -- /remove_ores default:stone_with_iron
core.register_chatcommand(cmd_repo.ore.cmd, {
privs = {server=true},
description = S("Remove an ore from game.") .. "\n\n"
@@ -570,9 +619,17 @@ end
--- Manages settings for wielded [cleaner tool](tools.html).
--
+-- Required Privileges:
+--
+-- - server
+--
-- @chatcmd ctool
-- @param action Action to execute. Can be "status", "setmode", or "setnode".
--- @param value Mode or node to be set for tool (not required for "status" action)..
+-- @param value Mode or node to be set for tool (not required for "status" action).
+-- @usage
+-- # while cleaner:pencil is wielded, configure to place default:dirt node when used
+-- /ctool setmode write
+-- /ctool setnode default:dirt
core.register_chatcommand(cmd_repo.tool.cmd, {
privs = {server=true},
description = S("Manage settings for wielded cleaner tool.") .. "\n\n"