net.risingworld.api.events.world

Class PlantGrowEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.world.PlantGrowEvent

All Implemented Interfaces:

Cancellable

public class PlantGrowEvent
extends Event
implements Cancellable

Called when a plant grows (i.e. transition to next growth stage).
Note: Most growable plants have multiple "growth stages", so a sapling usually never turns into a fully grown plant directly. For example, a tomato sapling (internal name "tomato_sapling") first turns into a tiny tomato plant ("tomato_s0"), then into a bigger plant ("tomtato_s1"), then it turns into a grown plant without fruits ("tomato_s2"), then some unripe tomatoes appear ("tomato_s3"), and finally you get the fully grown tomato plant ("tomato"). In total, the PlantGrowEvent will be triggered 5 times in this case (for every growth stage).

Constructor Summary

Constructors

Constructor and Description
PlantGrowEvent(short plantid, short nextstageid, int growthTime, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz)

Method Summary

Modifier and Type	Method and Description
int	getChunkPositionX() Gets the x offset of the chunk (which contains the plant).
int	getChunkPositionY() Gets the y offset of the chunk (which contains the plant).
int	getChunkPositionZ() Gets the z offset of the chunk (which contains the plant).
int	getNextGrowthTime() Gets the growth time for the next plant stage (in seconds).
Definitions.PlantDefinition	getNextStagePlantDefinition()
short	getNextStageTypeID() Gets the next type ID of the plant, i.e. of the next growth stage.
Definitions.PlantDefinition	getPlantDefinition()
Vector3f	getPlantPosition() Gets the world position of the plant as a Vector3f.
float	getPlantPositionX() Gets the world x position of the plant.
float	getPlantPositionY() Gets the world y position of the plant.
float	getPlantPositionZ() Gets the world z position of the plant.
Quaternion	getPlantRotation() Gets the current rotation of the plant as a Quaternion.
short	getPlantTypeID() Gets the current type ID of the plant.
boolean	isCancelled() Determines if the event is cancelled.
boolean	isGrowable() Gets whether or not this new plant stage can grow.
void	setCancelled(boolean cancel) Cancels this event.
void	setNextGrowthTime(int growthTime) Sets the growth time (seconds) for the next plant stage, i.e. how long it takes until this plant grows and reaches the next growth stage.
void	setNextStageTypeID(int typeID) Changes the type ID of the next growth stage.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlantGrowEvent

public PlantGrowEvent(short plantid,
                      short nextstageid,
                      int growthTime,
                      int cx,
                      int cy,
                      int cz,
                      short px,
                      short py,
                      short pz,
                      short rx,
                      short ry,
                      short rz)

Method Detail

getPlantTypeID

public short getPlantTypeID()

Gets the current type ID of the plant.

Returns:

the plant type ID.

getNextStageTypeID

public short getNextStageTypeID()

Gets the next type ID of the plant, i.e. of the next growth stage.

Returns:

the type ID of the next growth stage.

setNextStageTypeID

public void setNextStageTypeID(int typeID)

Changes the type ID of the next growth stage.

Parameters:

typeID - the new type ID.

Example: If a plant grows, it should turn into scrubs, no matter which plant it is

1	@EventMethod
2	public void onPlantGrowth(PlantGrowEvent event){
3	//Get the definition for the "scrub1" plant
4	Definitions.PlantDefinition plantDef = Definitions.getPlantDefinition("scrub1");
5
6	//Change the next growth stage type ID to the "scrub1" ID
7	event.setNextStageTypeID(plantDef.getID());
8	}

getNextGrowthTime

public int getNextGrowthTime()

Gets the growth time for the next plant stage (in seconds). The growth time determines how long it takes until this plant grows (until it reaches the next growth stage). Returns 0 if this plant cannot grow.

Returns:

the growth time, in seconds.

setNextGrowthTime

public void setNextGrowthTime(int growthTime)

Sets the growth time (seconds) for the next plant stage, i.e. how long it takes until this plant grows and reaches the next growth stage. Has no effect if this plant cannot grow (see getNextGrowthTime().

Parameters:

growthTime - the growth time, in seconds.

See Also:

isGrowable()

isGrowable

public boolean isGrowable()

Gets whether or not this new plant stage can grow. If this method returns false, it means that the final growth stage is already reached (i.e. fully grown tree, for example).

Returns:

true if the plant can still grow, false if not.

getChunkPositionX

public int getChunkPositionX()

Gets the x offset of the chunk (which contains the plant).

Returns:

the x chunk offset.

getChunkPositionY

public int getChunkPositionY()

Gets the y offset of the chunk (which contains the plant).

Returns:

the y chunk offset.

getChunkPositionZ

public int getChunkPositionZ()

Gets the z offset of the chunk (which contains the plant).

Returns:

the z chunk offset.

getPlantPosition

public Vector3f getPlantPosition()

Gets the world position of the plant as a Vector3f.

Returns:

the global plant position as a Vector3f.

getPlantPositionX

public float getPlantPositionX()

Gets the world x position of the plant.

Returns:

the global plant x position.

getPlantPositionY

public float getPlantPositionY()

Gets the world y position of the plant.

Returns:

the global plant y position.

getPlantPositionZ

public float getPlantPositionZ()

Gets the world z position of the plant.

Returns:

the global plant z position.

getPlantRotation

public Quaternion getPlantRotation()

Gets the current rotation of the plant as a Quaternion. Keep in mind that the rotation can change for the new growth stage.

Returns:

the current plant rotation as a Quaternion.

getPlantDefinition

public Definitions.PlantDefinition getPlantDefinition()

getNextStagePlantDefinition

public Definitions.PlantDefinition getNextStagePlantDefinition()

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.