Package net.risingworld.api.events.player

Klasse PlayerTeleportEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerTeleportEvent

Alle implementierten Schnittstellen:

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.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	PlayerTeleportEvent.Cause	Determines what caused the teleportation

Feldübersicht

Von Klasse geerbte Felder net.risingworld.api.events.Event

cancelled, pointer

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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)

Von Klasse geerbte Methoden net.risingworld.api.events.player.PlayerEvent

getPlayer

Von Klasse geerbte Methoden net.risingworld.api.events.Event

equals, hashCode, isValid

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

getTargetPosition

public Vector3f getTargetPosition()

Gets the new position of the player.

Gibt zurück:

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.

Gibt zurück:

the cause why the player was teleported.

isCancelled

public boolean isCancelled()

Beschreibung aus Schnittstelle kopiert: 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.

Angegeben von:

isCancelled in Schnittstelle Cancellable

Gibt zurück:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Beschreibung aus Schnittstelle kopiert: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Angegeben von:

setCancelled in Schnittstelle Cancellable

Parameter:

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	}