net.risingworld.api.events.player

Class PlayerTeleportEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerTeleportEvent

All Implemented Interfaces:

Cancellable

public class PlayerTeleportEvent
extends PlayerEvent
implements Cancellable

Called when a player is teleported to another location. Cancelling this event prevents the player from teleporting.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerTeleportEvent.Cause Determines what caused the teleportation

Constructor Summary

Constructors

Constructor and Description
PlayerTeleportEvent(Player player, Vector3f targetPosition, PlayerTeleportEvent.Cause cause)

Method Summary

Modifier and Type	Method and Description
PlayerTeleportEvent.Cause	getCause() Gets the "cause", i.e. the reason why this player was teleported.
Vector3f	getTargetPosition() Gets the new position of the player.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setTargetPosition(float x, float y, float z)
void	setTargetPosition(Vector3f position)

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

PlayerTeleportEvent

public PlayerTeleportEvent(Player player,
                           Vector3f targetPosition,
                           PlayerTeleportEvent.Cause cause)

Method Detail

setTargetPosition

public void setTargetPosition(Vector3f position)

setTargetPosition

public void setTargetPosition(float x,
                              float y,
                              float z)

getTargetPosition

public Vector3f getTargetPosition()

Gets the new position of the player.

Returns:

current position of the player.

getCause

public PlayerTeleportEvent.Cause getCause()

Gets the "cause", i.e. the reason why this player was teleported.

Returns:

the cause why the player was teleported.

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.