net.risingworld.api.events.player

Class PlayerRespawnEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerRespawnEvent

All Implemented Interfaces:

Cancellable

public class PlayerRespawnEvent
extends PlayerEvent
implements Cancellable

Called when a player respawns after death.

See Also:

PlayerDeathEvent, PlayerSpawnEvent

Constructor Summary

Constructors

Constructor and Description
PlayerRespawnEvent(Player player, Vector3f spawnPosition, Quaternion spawnRotation, boolean keepInventory)

Method Summary

Modifier and Type	Method and Description
Vector3f	getSpawnPosition() Gets the spawn position.
Quaternion	getSpawnRotation() Gets the spawn rotation.
boolean	isCancelled() Determines if the event is cancelled.
boolean	isKeepingInventory() Gets whether or not the player will keep his inventory upon respawn.
void	setCancelled(boolean cancel) Cancels this event.
void	setKeepInventory(boolean set) Setting this to true causes the player to keep his current inventory.
void	setSpawnPosition(float x, float y, float z) Sets the spawn position of the player.
void	setSpawnPosition(Vector3f position) Sets the spawn position of the player.
void	setSpawnRotation(Quaternion rotation) Sets the spawn rotation of the player.

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

PlayerRespawnEvent

public PlayerRespawnEvent(Player player,
                          Vector3f spawnPosition,
                          Quaternion spawnRotation,
                          boolean keepInventory)

Method Detail

getSpawnPosition

public Vector3f getSpawnPosition()

Gets the spawn position.

Returns:

the global spawn position as a Vector3f.

getSpawnRotation

public Quaternion getSpawnRotation()

Gets the spawn rotation.

Returns:

the spawn rotation as a Quaternion.

setSpawnPosition

public void setSpawnPosition(Vector3f position)

Sets the spawn position of the player.

Parameters:

position - a Vector3f containing the global spawn coordinates.

setSpawnPosition

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

Sets the spawn position of the player.

Parameters:

x - global X spawn coordinate.

y - global Y spawn coordinate.

z - global Z spawn coordinate.

setSpawnRotation

public void setSpawnRotation(Quaternion rotation)

Sets the spawn rotation of the player.

Parameters:

rotation - a Quaternion which describes the spawn rotation.

setKeepInventory

public void setKeepInventory(boolean set)

Setting this to true causes the player to keep his current inventory. This also enables you to change the inventory within this event, e.g. if you want a certain player to respawn only with a sword (without having to change the global default spawn inventory), you can clear his inventory, then insert a sword and call this method (set it to true).

Parameters:

set - true to let the player keep his inventory, or false if you want him to respawn with the default spawn inventory.

Example: Clear player inventory once he respawns

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onPlayerRespawn(PlayerRespawnEvent evt){
5	evt.setKeepInventory(true);
6	Inventory inventory = evt.getPlayer().getInventory();
7	inventory.clear();
8	}
9	}

isKeepingInventory

public boolean isKeepingInventory()

Gets whether or not the player will keep his inventory upon respawn. This either happens if it was set to true previously (setKeepInventory(boolean)), or if the particular player permission (general_keepinventory) is set to true.

Returns:

true if the player will keep his inventory upon respawn, false if he will be equipped with the default spawn inventory instead.

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.