mirror of
https://github.com/minetest-mods/ropes.git
synced 2024-11-24 16:33:48 +01:00
README Update
- Link to plants_lib API for explaining the biome argument - Minor changes to the example.
This commit is contained in:
parent
7bb3f5e042
commit
46c891d4d6
14
README.md
14
README.md
@ -20,19 +20,25 @@ drawtype.
|
|||||||
*taken from mod*
|
*taken from mod*
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
|
||||||
|
vines.register_vine( name, definitions, biome )
|
||||||
|
|
||||||
|
--e.g.
|
||||||
|
|
||||||
vines.register_vine( 'vine', {
|
vines.register_vine( 'vine', {
|
||||||
description = "Vines",
|
description = "Vines",
|
||||||
is_side_vine = false,
|
|
||||||
average_length = 9
|
average_length = 9
|
||||||
}, biome )
|
}, biome )
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### definitions
|
||||||
|key| type| description|
|
|key| type| description|
|
||||||
|---| ---| ---|
|
|---| ---| ---|
|
||||||
|description| string|The node tooltip description|
|
|description| string|The vine's tooltip description|
|
||||||
|is_side_vine| bool| If not a side vine it is a plantlike drawtype bottom vine|
|
|
||||||
|average_length|int| The average length of vines|
|
|average_length|int| The average length of vines|
|
||||||
|biome| table| A plants_lib biome format (see plants_lib documentation)|
|
|
||||||
|
For biome definitions please see the [plants_lib API documentation](https://github.com/VanessaE/plantlife_modpack/blob/master/API.txt)
|
||||||
|
|
||||||
## Notice
|
## Notice
|
||||||
Vines use after_destruct on registered leave nodes to remove vines from which
|
Vines use after_destruct on registered leave nodes to remove vines from which
|
||||||
|
Loading…
Reference in New Issue
Block a user