net.risingworld.api.events.player

Class PlayerNpcInteractionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerNpcEvent

net.risingworld.api.events.player.PlayerNpcInteractionEvent

All Implemented Interfaces:

Cancellable

public class PlayerNpcInteractionEvent
extends PlayerNpcEvent
implements Cancellable

Called when a player interacts (i.e. presses the interaction key) with an npc. This event works for all npcs, however, only certain npc have special interaction routines (e.g. sheeps will be shorn when the player interacts with them etc).
Cancelling this event only has an effect if this npc has a default interaction routine.

Constructor Summary

Constructors

Constructor and Description
PlayerNpcInteractionEvent(Player player, Npc npc)

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

Methods inherited from class net.risingworld.api.events.player.PlayerNpcEvent

getNpc

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerNpcInteractionEvent

public PlayerNpcInteractionEvent(Player player,
                                 Npc npc)

Method Detail

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.