Skip to content

Commit

Permalink
Improve floodable and on_flood documentation.
Browse files Browse the repository at this point in the history
The original documentation did not specify that liquids should not themselves be floodable. This is probably something that should be mentioned.
  • Loading branch information
BluebirdGreycoat committed Apr 27, 2017
1 parent 196b975 commit e0cf700
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/lua_api.txt
Expand Up @@ -3943,7 +3943,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
Expand Down Expand Up @@ -4010,7 +4012,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
Expand Down

0 comments on commit e0cf700

Please sign in to comment.