Package net.risingworld.api.events.npc

Class NpcDeathEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.npc.NpcDeathEvent
All Implemented Interfaces:
Cancellable
public final class NpcDeathEvent extends Event implements Cancellable
Called when an npc dies. Cancelling this event revives the npc (although this does not work if the npc is trapped in lava, for example).
See Also:

  • Method Details

    • getNpc

      public Npc getNpc()
      Gets the npc which died.
      Returns:
      the npc which died.

    • getDeathPosition

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

    • getKiller

      public Object getKiller()
      Gets the killer, i.e the player who is responsible for the death of this npc. If this npc wasn't killed by a player (e.g it died due to fall damage, or if it was killed by another npc etc), null is return.
      Returns:
      the killer, or null if there is no killer.
      See Also:

    • getCorpse

      public Corpse getCorpse()
      Gets the dead body of the npc (if a dead body was spawned).
      Returns:
      the dead body of the npc, or null if no corpse was spawned.

    • getStorageID

      public long getStorageID()
      If a storage was created for this (typically for the corpse)
      Returns:

    • getCause

      public NpcDeathEvent.Cause getCause()
      Gets the cause (why the npc died).
      Returns:
      the reason why the npc died.

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