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 final 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	Description
static enum	PlayerTeleportEvent.Cause	Determines what caused the teleportation

Field Summary

Fields inherited from class Event

cancelled, pointer

Method Summary

Modifier and Type	Method	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()	/////////////////////////////////////////////////////////////////////////
void	setCancelled(boolean cancel)	Cancels this event.
void	setTargetPosition(float x, float y, float z)
void	setTargetPosition(Vector3f position)

Methods inherited from class PlayerEvent

getPlayer

Methods inherited from class Event

equals, hashCode, isValid

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

getTargetPosition

public Vector3f getTargetPosition()

Gets the new position of the player.

Returns:

current position of the player.

setTargetPosition

public void setTargetPosition(Vector3f position)

setTargetPosition

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

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()

/////////////////////////////////////////////////////////////////////////

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.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.

Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onEnterArea(PlayerEnterAreaEvent evt){
5	//Now the player will not be able to enter the area, i.e.
6	//he will be teleported back to his old position (outside the area)
7	evt.setCancelled(true);
8	}
9	}