net.risingworld.api.events.player

Class PlayerChangePositionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerChangePositionEvent

All Implemented Interfaces:

Cancellable

public class PlayerChangePositionEvent
extends PlayerEvent
implements Cancellable

Called when a player changes his position (for example by moving).

Attention: This is a high frequency event! Be careful when doing extensive computations in this event or calling blocking methods, since that may have a big impact on Performance

See Also:

PlayerChangeBlockPositionEvent, PlayerEnterChunkEvent, PlayerEnterWorldpartEvent

Constructor Summary

Constructors

Constructor and Description
PlayerChangePositionEvent(Player player, Vector3f position, Quaternion rotation)

Method Summary

Modifier and Type	Method and Description
Vector3f	getPosition() Gets the new position of the player.
Quaternion	getRotation()
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setPosition(float x, float y, float z)
void	setPosition(Vector3f position)
void	setRotation(Quaternion quaternion)

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

PlayerChangePositionEvent

public PlayerChangePositionEvent(Player player,
                                 Vector3f position,
                                 Quaternion rotation)

Method Detail

setPosition

public void setPosition(Vector3f position)

setPosition

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

getPosition

public Vector3f getPosition()

Gets the new position of the player.

Returns:

current position of the player.

setRotation

public void setRotation(Quaternion quaternion)

getRotation

public Quaternion getRotation()

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.