sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-26 00:53:00 +00:00
Code Issues Releases Wiki Activity

code documentation tweaks

Browse source
This commit is contained in:
VorTechnix 2024-10-10 09:21:34 -07:00
parent 8ab8bf2ed9
commit f2a6b5531a
No known key found for this signature in database
GPG key ID: 091E91A69545D5BA
2 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
worldeditadditions_tools/init.lua
View file

@ -1,3 +1,4 @@
---@diagnostic disable-next-line: lowercase-global
worldeditadditions_tools = { worldeditadditions_tools = {
player_data = {}, player_data = {},
registered_tools = {}, registered_tools = {},

8
worldeditadditions_tools/lib/register_tool.lua
View file

@ -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.