net.risingworld.api.events.player

Class PlayerEnterWorldpartEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerEnterWorldpartEvent

All Implemented Interfaces:

Cancellable

public class PlayerEnterWorldpartEvent
extends PlayerEvent
implements Cancellable

Called when a player enters a new worldpart.

See Also:

PlayerChangePositionEvent, PlayerChangeBlockPositionEvent, PlayerEnterChunkEvent

Constructor Summary

Constructors

Constructor and Description
PlayerEnterWorldpartEvent(Player player, Vector2i newWorldpart, Vector2i oldWorldpart)

Method Summary

Modifier and Type	Method and Description
Vector2i	getNewWorldpartCoordinates() Gets the coordinates of the new worldpart.
Vector2i	getOldWorldpartCoordinates() Gets the coordinates of the old, previous worldpart.
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

PlayerEnterWorldpartEvent

public PlayerEnterWorldpartEvent(Player player,
                                 Vector2i newWorldpart,
                                 Vector2i oldWorldpart)

Method Detail

getNewWorldpartCoordinates

public Vector2i getNewWorldpartCoordinates()

Gets the coordinates of the new worldpart.
Note: Worldparts only have two dimensional x and z coordinates (horizontally).
Since the coordinates are stored in a Vector2i, the z coordinate will be stored in the y value.

Returns:

a Vector2i containing the position of the new worldpart.

getOldWorldpartCoordinates

public Vector2i getOldWorldpartCoordinates()

Gets the coordinates of the old, previous worldpart.
Note: Worldparts only have two dimensional x and z coordinates (horizontally).
Since the coordinates are stored in a Vector2i, the z coordinate will be stored in the y value.

Returns:

a Vector2i containing the position of the previous worldpart.

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.