anarquimico
/
MineClone2
forked from VoxeLibre/VoxeLibre
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Cleaned up the API.md documentation.

This commit is contained in:
Michieal 2023-02-15 14:03:09 -05:00 committed by Gitea
parent 82059c6073
commit b311838041
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
mods/CORE/mcl_oxidization/API.md
View File

@ -1,13 +1,11 @@
# Mineclone Oxidization API # Mineclone Oxidization API
This document explains the API of this mod. This document explains the API of this mod.
### `register_oxidation_abm(abm_name, node_name)` ### `register_oxidation_abm(node_name)`
Registers the ABM for the oxidization of nodes. It expects that the variable Registers the ABM for the oxidization of nodes. It expects that the variable
`_mcl_oxidized_variant` be set with the node name of the oxidized version. `_mcl_oxidized_variant` be set with the node name of the oxidized version.
#### Parameters: #### Parameters:
`abm_name`: A unique name for the abm to register.
`node_name`: the name of the node to check, and to oxidize. `node_name`: the name of the node to check, and to oxidize.
#### Usage: #### Usage:
@ -30,7 +28,7 @@ local block_oxidation = {
} }
for _, b in pairs(block_oxidation) do for _, b in pairs(block_oxidation) do
register_oxidation_abm("Copper oxidation", "mcl_copper:block" .. b[1], "mcl_copper:block" .. b[2]) register_oxidation_abm("mcl_copper:block" .. b[1], "mcl_copper:block" .. b[2])
end end
``` ```