net.risingworld.api.events.player

Class PlayerChangeBlockPositionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerChangeBlockPositionEvent

All Implemented Interfaces:

Cancellable

public class PlayerChangeBlockPositionEvent
extends PlayerEvent
implements Cancellable

Called when a player changes his block position (for example by moving).
If block-wise precision is sufficient, you should prefer this event over the PlayerChangePosition event (which is called very frequently!).

See Also:

PlayerChangePositionEvent, PlayerEnterChunkEvent, PlayerEnterWorldpartEvent

Constructor Summary

Constructors

Constructor and Description
PlayerChangeBlockPositionEvent(Player player, Vector3i newBlockPosition, Vector3i oldBlockPosition)

Method Summary

Modifier and Type	Method and Description
Vector3i	getNewBlockPosition() Gets the new block position of the player.
Vector3i	getOldBlockPosition() Gets the old block position of the player.
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

PlayerChangeBlockPositionEvent

public PlayerChangeBlockPositionEvent(Player player,
                                      Vector3i newBlockPosition,
                                      Vector3i oldBlockPosition)

Method Detail

getNewBlockPosition

public Vector3i getNewBlockPosition()

Gets the new block position of the player.

Returns:

a Vector3i containing the x, y and z position of the new block.

getOldBlockPosition

public Vector3i getOldBlockPosition()

Gets the old block position of the player.

Returns:

a Vector3i containing the x, y and z position of the previous block.

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.