net.risingworld.api.events.player.world

Class PlayerPlaceVegetationEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerVegetationEvent

net.risingworld.api.events.player.world.PlayerPlaceVegetationEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PlayerCreativePlaceVegetationEvent

public class PlayerPlaceVegetationEvent
extends PlayerVegetationEvent
implements Cancellable

Called when the player places a plant (saplings, seedlings etc).

Example: Check if the plant can grow, in this case, place the fully grown version instead

1	@EventMethod
2	public void onPlayerPlaceVegetationEvent(PlayerPlaceVegetationEvent e){
3	//First we have to get the plant definition to find out if it can grow
4	Definitions.PlantDefinition plantDef = e.getPlantDefinition();
5
6	//Check if the plant is "growable"
7	if(plantDef.isGrowable()){
8	//Now it's getting tricky: We have to find the final growth stage.
9	//The only way to get it is to iterate over all growth stages. If one of
10	//these stages is no longer "growable", it's the "final stage"
11	while(plantDef.isGrowable()){
12	//Get the name of the next growth stage
13	String next = plantDef.getNextGrowthStage();
14
15	//If the next stage is not null, we update the plantDef to the next stage
16	if(next != null){
17	plantDef = Definitions.getPlantDefinition(next);
18	}
19	//Otherwise we can break the loop here
20	else{
21	break;
22	}
23	}
24
25	//Update the plant type id of this event to the new type id. That's it!
26	e.setPlantTypeID(plantDef.getID());
27	}
28	}

Constructor Summary

Constructors

Constructor and Description
PlayerPlaceVegetationEvent(Player player, short plantid, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, int growthTime)

Method Summary

Modifier and Type	Method and Description
int	getGrowthTime() Gets the growth time for this plant in seconds.
boolean	isCancelled() Determines if the event is cancelled.
boolean	isGrowable() Gets whether or not this plant can grow.
void	setCancelled(boolean cancel) Cancels this event.
void	setGrowthTime(int growthTime) Sets the growth time (seconds) for this plant, i.e. how long it takes until this plant grows and reaches the next growth stage.
void	setPlantPosition(float x, float y, float z) Changes the plant position.
void	setPlantPosition(Vector3f position) Changes the plant position.
void	setPlantRotation(float pitch, float yaw, float roll) Changes the plant rotation.
void	setPlantRotation(Quaternion rotation) Changes the plant rotation.
void	setPlantTypeID(short id) Sets the type ID of the plant.

Methods inherited from class net.risingworld.api.events.player.world.PlayerVegetationEvent

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getPlantDefinition, getPlantPosition, getPlantPositionX, getPlantPositionY, getPlantPositionZ, getPlantRotation, getPlantRotationX, getPlantRotationY, getPlantRotationZ, getPlantTypeID, getPX, getPY, getPZ, getRX, getRY, getRZ

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerPlaceVegetationEvent

public PlayerPlaceVegetationEvent(Player player,
                                  short plantid,
                                  int cx,
                                  int cy,
                                  int cz,
                                  short px,
                                  short py,
                                  short pz,
                                  short rx,
                                  short ry,
                                  short rz,
                                  int growthTime)

Method Detail

setPlantTypeID

public void setPlantTypeID(short id)

Sets the type ID of the plant.

Parameters:

id - the new plant type ID.

setPlantPosition

public void setPlantPosition(Vector3f position)

Changes the plant position.

Parameters:

position - the new plant world position.

setPlantPosition

public void setPlantPosition(float x,
                             float y,
                             float z)

Changes the plant position.

Parameters:

x - the new plant world x position.

y - the new plant world y position.

z - the new plant world z position.

setPlantRotation

public void setPlantRotation(Quaternion rotation)

Changes the plant rotation.

Parameters:

rotation - the new plant rotation. Set to null to reset the rotation (Quaternion.IDENTITY).

setPlantRotation

public void setPlantRotation(float pitch,
                             float yaw,
                             float roll)

Changes the plant rotation.

Parameters:

pitch - the new x angle, as euler rotation (pitch).

yaw - the new y angle, as euler rotation (yaw).

roll - the new z angle, as euler rotation (roll).

Example: Set a random plant rotation

1	@EventMethod
2	public void onPlantPlace(PlayerPlaceVegetationEvent event){
3	//Select a random plant y rotation (0-360), we can use the "nextRandomFloat()"
4	//method in the MathUtils, which returns a random float value between 0 and 1.
5	//If we multiply this value with TWO_PI (360°), we get a random rotation between 0 and 360
6	float rot = Utils.MathUtils.nextRandomFloat() * Utils.MathUtils.TWO_PI;
7
8	//Set the new rotation. We didn't change the x and z rotation.
9	event.setPlantRotation(event.getPlantRotationX(), rot, event.getPlantRotationZ());
10	}

isGrowable

public boolean isGrowable()

Gets whether or not this plant can grow.

Returns:

true if this plant can grow (e.g. saplings, seedlings etc), false if not.

getGrowthTime

public int getGrowthTime()

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

Returns:

the growth time, in seconds.

setGrowthTime

public void setGrowthTime(int growthTime)

Sets the growth time (seconds) for this plant, 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 getGrowthTime().

Parameters:

growthTime - the growth time, in seconds.

See Also:

isGrowable(), PlantGrowEvent

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.