net.risingworld.api.utils

Class Definitions.PlantDefinition

java.lang.Object

net.risingworld.api.utils.Definitions.PlantDefinition

Enclosing class:

Definitions

public static class Definitions.PlantDefinition
extends java.lang.Object

A class representing plant/vegetation definitions ("meta data").

Method Summary

Modifier and Type	Method and Description
int	getGrowthTime() Gets the growth time (i.e. the amount of seconds until this plant reaches the next growth stage).
short	getID() Gets the ID.
java.lang.String	getName() Gets the plant name (alway lowercase).
java.lang.String	getNextGrowthStage() Gets the next growth stage, i.e. the name of the "new" plant (always lowercase).
Definitions.ItemDefinition	getSaplingItemDefinition() Gets the related sapling item definition.
short	getSaplingItemID() Gets the sapling item id.
int	getStrength() Gets the strength of this plant.
boolean	hasBirds() Gets whether or not birds live in this plant/tree.
boolean	hasCollision() Gets whether or not this plant has collision.
boolean	hasRandomGrowthRotation() Gets whether or not this plant has a random growth rotation, i.e. if it changes the rotation randomly when reaching the next growth stage.
boolean	isCrop() Gets whether or not this is a crop plant.
boolean	isFruitTree() Gets whether or not this plant is a fruit tree, e.g. an apple tree.
boolean	isGrowable() Gets whether or not this plant can grow.
boolean	isPickupable() Gets whether or not this plant can be picked up.
boolean	isTree() Gets whether or not this plant is a tree.
boolean	isWaterPlant() Gets whether or not this plant is a water plant, i.e. if it only grows in water or under water.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getID

public short getID()

Gets the ID.

Returns:

the plant ID.

getName

public java.lang.String getName()

Gets the plant name (alway lowercase).

Returns:

the plant name.

getStrength

public int getStrength()

Gets the strength of this plant.

Returns:

the strength of this plant.

isPickupable

public boolean isPickupable()

Gets whether or not this plant can be picked up.

Returns:

true if this plant can be picked up, false if not.

hasBirds

public boolean hasBirds()

Gets whether or not birds live in this plant/tree.

Returns:

true if birds can live in this plant/tree, false if not.

isGrowable

public boolean isGrowable()

Gets whether or not this plant can grow.

Returns:

true if this plant can grow, false if not.

getGrowthTime

public int getGrowthTime()

Gets the growth time (i.e. the amount of seconds until this plant reaches the next growth stage).

Returns:

the growth time in seconds.

getNextGrowthStage

public java.lang.String getNextGrowthStage()

Gets the next growth stage, i.e. the name of the "new" plant (always lowercase).

Returns:

the name of the next growth stage.

hasRandomGrowthRotation

public boolean hasRandomGrowthRotation()

Gets whether or not this plant has a random growth rotation, i.e. if it changes the rotation randomly when reaching the next growth stage.

Returns:

true if this plant changes the rotation when reaching the next growth stage, false if not.

hasCollision

public boolean hasCollision()

Gets whether or not this plant has collision.

Returns:

true if this plant has collision, false if not.

isTree

public boolean isTree()

Gets whether or not this plant is a tree.

Returns:

true if this plant is a tree, false if not.

isFruitTree

public boolean isFruitTree()

Gets whether or not this plant is a fruit tree, e.g. an apple tree.

Returns:

true if this plant is a fruit tree, false if not.

isCrop

public boolean isCrop()

Gets whether or not this is a crop plant.

Returns:

true if this is a crop plant, false if not.

isWaterPlant

public boolean isWaterPlant()

Gets whether or not this plant is a water plant, i.e. if it only grows in water or under water.

Returns:

true if this is a water plant, false if not.

getSaplingItemID

public short getSaplingItemID()

Gets the sapling item id. If this plant has no saplings, -1 is returned.

Returns:

the type id of the related sapling item, or -1 if this plant has no saplings.

getSaplingItemDefinition

public Definitions.ItemDefinition getSaplingItemDefinition()

Gets the related sapling item definition. If this plant has no saplings, null is returned.

Returns:

the sapling item definition, or null if this plant has no saplings.