net.risingworld.api.events.player

Class PlayerEnterChunkEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerEnterChunkEvent

All Implemented Interfaces:

Cancellable

public class PlayerEnterChunkEvent
extends PlayerEvent
implements Cancellable

Called when a player enters a new chunk.

See Also:

PlayerChangePositionEvent, PlayerChangeBlockPositionEvent, PlayerEnterWorldpartEvent

Constructor Summary

Constructors

Constructor and Description
PlayerEnterChunkEvent(Player player, Vector3i newChunk, Vector3i oldChunk)

Method Summary

Modifier and Type	Method and Description
Vector3i	getNewChunkCoordinates() Gets the coordinates of the new chunk.
Vector3i	getOldChunkCoordinates() Gets the coordinates of the old, previous chunk.
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

PlayerEnterChunkEvent

public PlayerEnterChunkEvent(Player player,
                             Vector3i newChunk,
                             Vector3i oldChunk)

Method Detail

getNewChunkCoordinates

public Vector3i getNewChunkCoordinates()

Gets the coordinates of the new chunk.

Returns:

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

getOldChunkCoordinates

public Vector3i getOldChunkCoordinates()

Gets the coordinates of the old, previous chunk.

Returns:

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

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.