mirror of
https://github.com/sbrl/Minetest-WorldEditAdditions.git
synced 2024-11-29 10:23:00 +00:00
code documentation tweaks
This commit is contained in:
parent
8ab8bf2ed9
commit
f2a6b5531a
2 changed files with 8 additions and 1 deletions
|
@ -1,3 +1,4 @@
|
||||||
|
---@diagnostic disable-next-line: lowercase-global
|
||||||
worldeditadditions_tools = {
|
worldeditadditions_tools = {
|
||||||
player_data = {},
|
player_data = {},
|
||||||
registered_tools = {},
|
registered_tools = {},
|
||||||
|
|
|
@ -27,7 +27,13 @@ end
|
||||||
|
|
||||||
|
|
||||||
--- Registers a new WorldEditAdditions tool.
|
--- Registers a new WorldEditAdditions tool.
|
||||||
-- @param tool string The name of the tool to register.
|
-- @param tool string The name of the tool to register (sans the ":worldeditadditions:" prefix).
|
||||||
|
--[[
|
||||||
|
=== WARNING ===
|
||||||
|
":worldeditadditions:" will be prepended to the `tool` param so
|
||||||
|
calling `register_tool(":worldeditadditions:<toolname>", def_table)`
|
||||||
|
may cause errors.
|
||||||
|
--]]
|
||||||
-- @param options table A table of options for the tool:
|
-- @param options table A table of options for the tool:
|
||||||
-- - `description` (string) A description of the tool.
|
-- - `description` (string) A description of the tool.
|
||||||
-- - `inventory_image` (string) The path to the image for the tool.
|
-- - `inventory_image` (string) The path to the image for the tool.
|
||||||
|
|
Loading…
Reference in a new issue