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 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:

NpcHitNpcEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NpcDeathEvent.Cause Determines why the NpcDeathEvent was triggered exactly (i.e. why the npc actually died).

Constructor Summary

Constructors

Constructor and Description
NpcDeathEvent(Npc npc, java.lang.Object killer, Vector3f deathPosition, NpcDeathEvent.Cause cause)

Method Summary

Modifier and Type	Method and Description
NpcDeathEvent.Cause	getCause() Gets the cause (why the npc died).
Vector3f	getDeathPosition() Gets the position where the npc died.
java.lang.Object	getKiller() Gets the killer, i.e. the player who is responsible for the death of this npc.
Npc	getNpc() Gets the npc which died.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NpcDeathEvent

public NpcDeathEvent(Npc npc,
                     java.lang.Object killer,
                     Vector3f deathPosition,
                     NpcDeathEvent.Cause cause)

Method Detail

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 java.lang.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:

getCause()

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.

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.