net.risingworld.api.events.player

Class PlayerDeathEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerDeathEvent

All Implemented Interfaces:

Cancellable

public class PlayerDeathEvent
extends PlayerEvent
implements Cancellable

Called when a player dies.

See Also:

PlayerRespawnEvent

Constructor Summary

Constructors

Constructor and Description
PlayerDeathEvent(Player player, Player killer, Vector3f deathPosition)

Method Summary

Modifier and Type	Method and Description
Vector3f	getDeathPosition() Gets the position where the player died.
Player	getKiller() Gets the killer, i.e. the player who is responsible for the death of this player.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

PlayerDeathEvent

public PlayerDeathEvent(Player player,
                        Player killer,
                        Vector3f deathPosition)

Method Detail

getDeathPosition

public Vector3f getDeathPosition()

Gets the position where the player died.

Returns:

global position where the player died.

getKiller

public Player getKiller()

Gets the killer, i.e. the player who is responsible for the death of this player. If there is no killer (e.g. player died due to falldamage, or if he was killed by an NPC etc), null is returned.

Returns:

the killer, or null if there is no killer.

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.