net.risingworld.api.events.npc

Class NpcHitNpcEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.npc.NpcHitNpcEvent

All Implemented Interfaces:

Cancellable

public class NpcHitNpcEvent
extends Event
implements Cancellable

Called when an npc attacks another npc.

See Also:

NpcDeathEvent

Constructor Summary

Constructors

Constructor and Description
NpcHitNpcEvent(Npc attackerNpc, Npc targetNpc, short damage, float distance)

Method Summary

Modifier and Type	Method and Description
Npc	getAttacker() Gets the attacking npc, i.e. the npc who hit the target npc.
short	getDamage() Gets the amount of damage this hit will cause.
Npc	getNpc() Gets the target npc, i.e. the npc which was hit by the attacker.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setDamage(short damage) Sets the amount of damage that will be caused by this hit.

Methods inherited from class java.lang.Object

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

Constructor Detail

NpcHitNpcEvent

public NpcHitNpcEvent(Npc attackerNpc,
                      Npc targetNpc,
                      short damage,
                      float distance)

Method Detail

getAttacker

public Npc getAttacker()

Gets the attacking npc, i.e. the npc who hit the target npc.

Returns:

the attacking npc.

getNpc

public Npc getNpc()

Gets the target npc, i.e. the npc which was hit by the attacker.

Returns:

the npc which was attacked (the "victim").

setDamage

public void setDamage(short damage)

Sets the amount of damage that will be caused by this hit.

Parameters:

damage - the new damage amount.

getDamage

public short getDamage()

Gets the amount of damage this hit will cause.

Returns:

the amount of damage.

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.