add API documentation to flowlib (part 1)

This commit is contained in:
AFCMS 2021-03-28 00:12:41 +01:00
parent ce123d4676
commit fb50b256ed

35
mods/CORE/flowlib/API.md Normal file
View File

@ -0,0 +1,35 @@
# flowlib
Simple flow functions.
## flowlib.is_touching()
## flowlib.is_water(pos)
Return true if node at <pos> is water, false overwise.
* pos: position
## flowlib.node_is_water(node)
Return true if <node> is water, false overwise.
* node: node
## flowlib.is_lava(pos)
Return true if node at <pos> is lava, false overwise.
* pos: position
## flowlib.node_is_lava(node)
Return true if <node> is lava, false overwise.
* node: node
## flowlib.is_liquid(pos)
Return true if node at <pos> is liquid, false overwise.
* pos: position
## flowlib.node_is_liquid(node)
Return true if <node> is liquid, false overwise.
* node: node
## flowlib.quick_flow(pos, node)
* pos: position
* node: node
## flowlib.move_centre(pos, realpos, node, radius)