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
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Determines why theNpcDeathEvent
was triggered exactly (i.e why the npc actually died). -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Gets the cause (why the npc died).Gets the position where the npc died.Gets the killer, i.e the player who is responsible for the death of this npc.getNpc()
Gets the npc which died.boolean
Determines if the event is cancelled.void
setCancelled
(boolean cancel) Cancels this event.
-
Method Details
-
getNpc
Gets the npc which died.- Returns:
- the npc which died.
-
getDeathPosition
Gets the position where the npc died.- Returns:
- global position where the npc died.
-
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:
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- set to true if you want to cancel this event.- Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
-