ropes/README.md
bas080 e973c4df48 Groups for spawning vines
- Easily lets vines spawn on nodes that have the unique vine group name

- Updated README.md that explains the groups spawning feature.

- Made groups variable local to the registration function and not part of the
  namespace
2015-02-13 03:10:15 +01:00

1.6 KiB

Vines

Features

  • Rope block for spawning rope that slowly drops into the deep.
  • Vines are climbable and slowly grow downward.
  • Shears that allow the collecting of vines.
  • Spawns vines on jungletree leaves.
  • Roots on the bottom of dirt and dirt with grass nodes.
  • Spawns vines on trees located in swampy area.
  • Jungle vines that spawn on the side of jungletrees

API

The API is very minimal. It allows the registering of vines and the spawning of existing vines on nodes of your own.

If you want vines to spawn on a certain node then you can choose which vine you would like to spawn on by adding to the node it's group one of the following.

There are two types of vines. One that spawns at the bottom of nodes and uses the plantlike drawtype, and vines that spawn on the side that use signlike drawtype. The type is determined by the spawn_on_side property in the biome table.

Example

taken from mod


  vines.register_vine( name, definitions, biome )

  --e.g.

  vines.register_vine( 'vine', {
    description = "Vines",
    average_length = 9
  }, biome )

definitions

key type description
description string The vine's tooltip description
average_length int The average length of vines

For biome definitions please see the plants_lib API documentation

Notice

Vines use after_destruct on registered leave nodes to remove vines from which the leaves are removed. This is done by using the override function. Malfunctions may occur if other mods override the after_destruct of these nodes also.