Merge pull request 'doc-refactoring part 1' (#1437) from doc-refactoring into master

Reviewed-on: MineClone2/MineClone2#1437

mods/CORE/controls/API.md

@@ -0,0 +1,23 @@
+# controls
+
+## controls.players
+Table containing player controls at runtime.
+WARNING: Never use this table in writing
+
+## controls.register_on_press(func)
+Register a function that will be executed with (player, keyname) every time a player press a key.
+
+## controls.registered_on_press
+Table containing functions registered with controls.register_on_press().
+
+## controls.register_on_release(func)
+Register a function that will be executed with (player, keyname, clock_from_last_press) every time a player release a key.
+
+## controls.registered_on_release
+Table containing functions registered with controls.register_on_release().
+
+## controls.register_on_hold(func)
+Register a function that will be executed with (player, keyname, clock_from_start_hold) every time a player hold a key.
+
+## controls.registered_on_hold
+Table containing functions registered with controls.register_on_hold().

mods/CORE/flowlib/API.md

@@ -0,0 +1,45 @@
+# flowlib
+Simple flow functions.
+
+## flowlib.is_touching(realpos, nodepos, radius)
+Return true if a sphere of <radius> at <realpos> collide with node at <nodepos>.
+* realpos: position
+* nodepos: position
+* radius: number
+
+## 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)
+Return direction where the water is flowing (to be use to push mobs, items...).
+* pos: position
+* node: node
+
+## flowlib.move_centre(pos, realpos, node, radius)
+Return the pos of the nearest not water block near from <pos> in a sphere of <radius> at <realpos>.
+WARNING: This function is never used in mcl2, use at your own risk. The informations described here may be wrong.
+* pos: position
+* realpos: position, position of the entity
+* node: node
+* radius: number

mods/CORE/mcl_autogroup/API.md

@@ -0,0 +1,27 @@
+# mcl_autogroup
+This mod emulate digging times from mc.
+
+## mcl_autogroup.can_harvest(nodename, toolname)
+Return true if <nodename> can be dig with <toolname>.
+* nodename: string, valid nodename
+* toolname: (optional) string, valid toolname
+
+## mcl_autogroup.get_groupcaps(toolname, efficiency)
+This function is used to calculate diggroups for tools.
+WARNING: This function can only be called after mod initialization.
+* toolname: string, name of the tool being enchanted (like "mcl_tools:diamond_pickaxe")
+* efficiency: (optional) integer, the efficiency level the tool is enchanted with (default 0)
+
+## mcl_autogroup.get_wear(toolname, diggroup)
+Return the max wear of <toolname> with <diggroup>
+WARNING: This function can only be called after mod initialization.
+* toolname: string, name of the tool used
+* diggroup: string, the name of the diggroup the tool is used on
+
+## mcl_autogroup.register_diggroup(group, def)
+* group: string, name of the group to register as a digging group
+* def: (optional) table, table with information about the diggroup (defaults to {} if unspecified)
+    * level: (optional) string, if specified it is an array containing the names of the different digging levels the digging group supports
+
+## mcl_autogroup.registered_diggroups
+List of registered diggroups, indexed by name.

mods/CORE/mcl_colors/API.md

@@ -0,0 +1,8 @@
+# mcl_colors
+Mod providing global table containing legacity minecraft colors to be used in mods.
+
+## mcl_colors.*
+Colors by upper name, in hex value.
+
+## mcl_colors.background.*
+Background colors by upper name, in hex value.

mods/CORE/mcl_explosions/API.md

@@ -0,0 +1,15 @@
+# mcl_explosions
+This mod provide helper functions to create explosions.
+
+## mcl_explosions.explode(pos, strength, info, puncher)
+* pos: position, initial position of the explosion
+* strenght: number, radius of the explosion
+* info: table, explosion informations:
+    * drop_chance: number, if specified becomes the drop chance of all nodes in the explosion (default: 1.0 / strength)
+    * max_blast_resistance: int, if specified the explosion will treat all non-indestructible nodes as having a blast resistance of no more than this value
+    * sound: bool, if true, the explosion will play a sound (default: true)
+    * particles: bool, if true, the explosion will create particles (default: true)
+    * fire: bool, if true, 1/3 nodes become fire (default: false)
+    * griefing: bool, if true, the explosion will destroy nodes (default: true)
+    * grief_protected: bool, if true, the explosion will also destroy nodes which have been protected (default: false)
+* puncher: (optional) entity, will be used as source for damage done by the explosion

mods/CORE/mcl_worlds/API.md

@@ -0,0 +1,80 @@
+# mcl_worlds
+This mod provides utility functions about positions and dimensions.
+
+## mcl_worlds.is_in_void(pos)
+This function returns:
+
+* true, true: if pos is in deep void (deadly)
+* true, false: if the pos is in void (non deadly)
+* false, false: owerwise
+
+Params:
+
+* pos: position
+
+## mcl_worlds.y_to_layer(y)
+This function is used to calculate the minetest y layer and dimension of the given <y> minecraft layer.
+Mainly used for ore generation.
+Takes an Y coordinate as input and returns:
+
+* The corresponding Minecraft layer (can be nil if void)
+* The corresponding Minecraft dimension ("overworld", "nether" or "end") or "void" if <y> is in the void
+If the Y coordinate is not located in any dimension, it will return: nil, "void"
+
+Params:
+
+* y: int
+
+## mcl_worlds.pos_to_dimension(pos)
+This function return the Minecraft dimension of <pos> ("overworld", "nether" or "end") or "void" if <y> is in the void.
+
+* pos: position
+
+## mcl_worlds.layer_to_y(layer, mc_dimension)
+Takes a Minecraft layer and a “dimension” name and returns the corresponding Y coordinate for MineClone 2.
+mc_dimension can be "overworld", "nether", "end" (default: "overworld").
+
+* layer: int
+* mc_dimension: string
+
+## mcl_worlds.has_weather(pos)
+Returns true if <pos> can have weather, false owerwise.
+Weather can be only in the overworld.
+
+* pos: position
+
+## mcl_worlds.has_dust(pos)
+Returns true if <pos> can have nether dust, false owerwise.
+Nether dust can be only in the nether.
+
+* pos: position
+
+## mcl_worlds.compass_works(pos)
+Returns true if compasses are working at <pos>, false owerwise.
+In mc, you cant use compass in the nether and the end.
+
+* pos: position
+
+## mcl_worlds.compass_works(pos)
+Returns true if clock are working at <pos>, false owerwise.
+In mc, you cant use clock in the nether and the end.
+
+* pos: position
+
+## mcl_worlds.register_on_dimension_change(function(player, dimension))
+Register a callback function func(player, dimension).
+It will be called whenever a player changes between dimensions.
+The void counts as dimension.
+
+* player: player, the player who changed the dimension
+* dimension: position, The new dimension of the player ("overworld", "nether", "end", "void").
+
+
+## mcl_worlds.registered_on_dimension_change
+Table containing all function registered with mcl_worlds.register_on_dimension_change()
+
+## mcl_worlds.dimension_change(player, dimension)
+Notify this mod of a dimmension change of <player> to <dimension>
+
+* player: player, player who changed the dimension
+* dimension: string, new dimension ("overworld", "nether", "end", "void")