Package 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
Called when an npc attacks another npc.
- See Also:
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the attacking npc, i.e the npc who hit the target npc.short
Gets the amount of damage this hit will cause.getNpc()
Gets the target npc, i.e the npc which was hit by the attacker.boolean
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.
-
Method Details
-
getAttacker
Gets the attacking npc, i.e the npc who hit the target npc.- Returns:
- the attacking 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 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
-