sixam/modcleaner
1
0
Fork 0
mirror of https://codeberg.org/AntumLuanti/mod-cleaner.git synced 2025-03-15 04:41:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docstrings

Browse source
This commit is contained in:
Jordan Irwin 2021-07-31 18:47:34 -07:00
parent e5e0d7f620
commit da24ace035
2 changed files with 10 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
chat.lua
View file

@ -211,13 +211,10 @@ end
--- Removes nearby entities. --- Removes nearby entities.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd remove_entities -- @chatcmd remove_entities
-- @param entity Entity technical name. -- @param entity Entity technical name.
-- @tparam[opt] int radius Search radius (default: 100). -- @tparam[opt] int radius Search radius (default: 100).
-- @priv server
-- @usage -- @usage
-- # remove all mobs:horse entities within a radius of 10 nodes -- # remove all mobs:horse entities within a radius of 10 nodes
-- /remove_entities mobs:horse 10 -- /remove_entities mobs:horse 10
@ -278,13 +275,10 @@ core.register_chatcommand(cmd_repo.entity.cmd, {
--- Removes nearby nodes. --- Removes nearby nodes.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd remove_nodes -- @chatcmd remove_nodes
-- @param node Node technical name. -- @param node Node technical name.
-- @tparam[opt] int radius Search radius (default: 5). -- @tparam[opt] int radius Search radius (default: 5).
-- @priv server
-- @usage -- @usage
-- # remove all default:dirt nodes within a radius of 10 -- # remove all default:dirt nodes within a radius of 10
-- /remove_nodes default:dirt 10 -- /remove_nodes default:dirt 10
@ -337,13 +331,10 @@ core.register_chatcommand(cmd_repo.rem_node.cmd, {
--- Replaces an item. --- Replaces an item.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd replace_items -- @chatcmd replace_items
-- @param old_item Technical name of item to replace. -- @param old_item Technical name of item to replace.
-- @param new_item Technical name of item to be used in place. -- @param new_item Technical name of item to be used in place.
-- @priv server
-- @usage -- @usage
-- # replace default:sword_wood with default:sword_mese -- # replace default:sword_wood with default:sword_mese
-- /replace_items default:sword_wood default:sword_mese -- /replace_items default:sword_wood default:sword_mese
@ -372,14 +363,11 @@ core.register_chatcommand(cmd_repo.item.cmd, {
--- Replaces nearby nodes. --- Replaces nearby nodes.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd replace_nodes -- @chatcmd replace_nodes
-- @param old_node Technical name of node to replace. -- @param old_node Technical name of node to replace.
-- @param new_node Technical name of node to be used in place. -- @param new_node Technical name of node to be used in place.
-- @tparam[opt] int radius Search radius (default: 5). -- @tparam[opt] int radius Search radius (default: 5).
-- @priv server
-- @usage -- @usage
-- # replace all default:dirt nodes with default:cobble within a radius of 10 -- # replace all default:dirt nodes with default:cobble within a radius of 10
-- /replace_nodes default:dirt default:cobble 10 -- /replace_nodes default:dirt default:cobble 10
@ -436,12 +424,9 @@ core.register_chatcommand(cmd_repo.rep_node.cmd, {
--- Checks for nearby unknown nodes. --- Checks for nearby unknown nodes.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd find_unknown_nodes -- @chatcmd find_unknown_nodes
-- @tparam[opt] int radius Search radius (default: 100). -- @tparam[opt] int radius Search radius (default: 100).
-- @priv server
-- @usage -- @usage
-- # print names of all unknown nodes within radius of 10 -- # print names of all unknown nodes within radius of 10
-- /find_unknown_nodes 10 -- /find_unknown_nodes 10
@ -499,12 +484,9 @@ core.register_chatcommand(cmd_repo.find_node.cmd, {
--- Finds names of nearby nodes. --- Finds names of nearby nodes.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd find_nearby_nodes -- @chatcmd find_nearby_nodes
-- @tparam[opt] int radius Search radius (default: 5). -- @tparam[opt] int radius Search radius (default: 5).
-- @priv server
-- @usage -- @usage
-- # print names of all node types found within radius of 10 -- # print names of all node types found within radius of 10
-- /find_nearby_nodes 10 -- /find_nearby_nodes 10
@ -572,12 +554,11 @@ core.register_chatcommand(cmd_repo.near_node.cmd, {
if cleaner.unsafe then if cleaner.unsafe then
--- Registers an ore to be removed. --- Registers an ore to be removed.
-- --
-- <h3>Required Privileges:</h3>
--
-- - server
--
-- @chatcmd remove_ores -- @chatcmd remove_ores
-- @param ore Ore technical name. -- @param ore Ore technical name.
-- @priv server
-- @note This action is reverted after server restart. To make changes permanent,
-- use the [cleaner.json](config.html#cleaner.json) config.
-- @usage -- @usage
-- # remove all registered ores that add default:stone_with_iron to world -- # remove all registered ores that add default:stone_with_iron to world
-- /remove_ores default:stone_with_iron -- /remove_ores default:stone_with_iron

2
tools.lua
View file

@ -13,7 +13,7 @@ local aux = dofile(cleaner.modpath .. "/misc_functions.lua")
-- --
-- @tool cleaner:pencil -- @tool cleaner:pencil
-- @img cleaner_pencil.png -- @img cleaner_pencil.png
-- @privs server -- @priv server
-- @usage -- @usage
-- place (right-click): -- place (right-click):
-- - when not pointing at a node, changes modes -- - when not pointing at a node, changes modes