net.risingworld.api.events.player.world

Class PlayerRemoveVegetationEvent

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.PlayerRemoveVegetationEvent

All Implemented Interfaces:

Cancellable

public class PlayerRemoveVegetationEvent
extends PlayerVegetationEvent
implements Cancellable

Called when the player removes a plant without destroying it.

Constructor Summary

Constructors

Constructor and Description
PlayerRemoveVegetationEvent(Player player, commons.world.Plant plant)
PlayerRemoveVegetationEvent(Player player, short plantid, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, boolean cut)

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerRemoveVegetationEvent

public PlayerRemoveVegetationEvent(Player player,
                                   commons.world.Plant plant)

PlayerRemoveVegetationEvent

public PlayerRemoveVegetationEvent(Player player,
                                   short plantid,
                                   int cx,
                                   int cy,
                                   int cz,
                                   short px,
                                   short py,
                                   short pz,
                                   short rx,
                                   short ry,
                                   short rz,
                                   boolean cut)

Method Detail

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.