net.risingworld.api.events.player.world

Class PlayerWorldEditEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerWorldEditEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PlayerCreativePlaceBlockEvent, PlayerCreativeTerrainEditEvent, PlayerDestroyBlockEvent, PlayerDestroyTerrainEvent, PlayerPlaceBlockEvent, PlayerPlaceGrassEvent, PlayerPlaceTerrainEvent, PlayerPlaceWaterEvent, PlayerRemoveGrassEvent, PlayerRemoveWaterEvent, PlayerWorldHitEvent

public abstract class PlayerWorldEditEvent
extends PlayerEvent
implements Cancellable

Base class for all player world/terrain events. This only covers changes to terrain (including grass), blocks and water.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlayerWorldEditEvent(Player player, int cx, int cy, int cz, int bx, int by, int bz)

Method Summary

Modifier and Type	Method and Description
int	getBlockPositionX() Gets the x block position in the chunk.
int	getBlockPositionY() Gets the y block position in the chunk.
int	getBlockPositionZ() Gets the z block position in the chunk.
int	getChunkPositionX() Gets the x offset of the chunk.
int	getChunkPositionY() Gets the y offset of the chunk.
int	getChunkPositionZ() Gets the z offset of the chunk.
int	getGlobalBlockPositionX()
int	getGlobalBlockPositionY()
int	getGlobalBlockPositionZ()
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerWorldEditEvent

protected PlayerWorldEditEvent(Player player,
                               int cx,
                               int cy,
                               int cz,
                               int bx,
                               int by,
                               int bz)

Method Detail

getChunkPositionX

public int getChunkPositionX()

Gets the x offset of the chunk.

Returns:

the x chunk offset.

getChunkPositionY

public int getChunkPositionY()

Gets the y offset of the chunk.

Returns:

the y chunk offset.

getChunkPositionZ

public int getChunkPositionZ()

Gets the z offset of the chunk.

Returns:

the z chunk offset.

getBlockPositionX

public int getBlockPositionX()

Gets the x block position in the chunk.

Returns:

the x block position.

getBlockPositionY

public int getBlockPositionY()

Gets the y block position in the chunk.

Returns:

the y block position.

getBlockPositionZ

public int getBlockPositionZ()

Gets the z block position in the chunk.

Returns:

the z block position.

getGlobalBlockPositionX

public int getGlobalBlockPositionX()

getGlobalBlockPositionY

public int getGlobalBlockPositionY()

getGlobalBlockPositionZ

public int getGlobalBlockPositionZ()

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.