Package 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 final class PlayerDeathEvent extends PlayerEvent implements Cancellable
Called when a player dies.
See Also:

  • Method Details

    • getDeathPosition

      public Vector3f getDeathPosition()
      Gets the position where the player died.
      Returns:
      global position where the player died.

    • getKiller

      public Object getKiller()
      Gets the killer, i.e the one who killed this player. This may be either another player (then you can cast the returned object to "Player"), an NPC (then you can cast the object to "Npc" accordingly), or null if there was no killer (e.g player died due to falldamage etc)
      Returns:
      the killer (either a Player or Npc object), or null if there is no killer.

    • getCause

      public PlayerDeathEvent.Cause getCause()

    • 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.

      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
      2public 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}