diff options
| author | Bluebird <bluebird.greycoat@gmail.com> | 2017-04-27 04:49:07 -0500 |
|---|---|---|
| committer | Loïc Blot <nerzhul@users.noreply.github.com> | 2017-04-27 11:49:07 +0200 |
| commit | d130e1fdc09398367bfed3e0d4a4b2574ca33ab1 (patch) | |
| tree | 094db63724072f56ea4884cefca8da1540d8a25d /doc/lua_api.txt | |
| parent | 1670bc7366c687ef185b5b3cebda55b9201e004f (diff) | |
| download | minetest-d130e1fdc09398367bfed3e0d4a4b2574ca33ab1.tar.gz minetest-d130e1fdc09398367bfed3e0d4a4b2574ca33ab1.tar.bz2 minetest-d130e1fdc09398367bfed3e0d4a4b2574ca33ab1.zip | |
Fix incorrect formspec-tooltip doc, add detail in 'floodable' & 'on_flood' docs (#5660)
* Fix incorrect formspec tooltip documentation
* Improve `floodable` and `on_flood` documentation.
The original documentation did not specify that liquids should not themselves be floodable. This is probably something that should be mentioned.
Diffstat (limited to 'doc/lua_api.txt')
| -rw-r--r-- | doc/lua_api.txt | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 4f90e9223..d4141b5d4 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -1580,7 +1580,7 @@ examples. * Sets default background color of tooltips * Sets default font color of tooltips -#### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>,<fontcolor>]` +#### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]` * Adds tooltip for an element * `<bgcolor>` tooltip background color as `ColorString` (optional) * `<fontcolor>` tooltip font color as `ColorString` (optional) @@ -3942,7 +3942,9 @@ Definition tables diggable = true, -- If false, can never be dug climbable = false, -- If true, can be climbed on (ladder) buildable_to = false, -- If true, placed nodes can replace this node - floodable = false, -- If true, liquids flow into and replace this node + floodable = false, --[[ + ^ If true, liquids flow into and replace this node. + ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]] liquidtype = "none", -- "none"/"source"/"flowing" liquid_alternative_flowing = "", -- Flowing version of source liquid liquid_alternative_source = "", -- Source version of flowing liquid @@ -4009,7 +4011,8 @@ Definition tables ^ node placement (i.e. schematics and VoxelManip) or air nodes. If ^ return true the node is not flooded, but on_flood callback will ^ most likely be called over and over again every liquid update - ^ interval. Default: nil ]] + ^ interval. Default: nil. + ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]] after_place_node = func(pos, placer, itemstack, pointed_thing) --[[ ^ Called after constructing node when node was placed using |