net.risingworld.api.events.player

Class PlayerMountNpcEvent

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.PlayerMountNpcEvent

All Implemented Interfaces:

Cancellable

public class PlayerMountNpcEvent
extends PlayerNpcEvent
implements Cancellable

Called when a player mounts an npc / animal (e.g. a horse).

See Also:

PlayerDismountNpcEvent

Constructor Summary

Constructors

Constructor and Description
PlayerMountNpcEvent(Player player, Npc targetNpc)

Method Summary

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

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

PlayerMountNpcEvent

public PlayerMountNpcEvent(Player player,
                           Npc targetNpc)

Method Detail

getNpc

public Npc getNpc()

Description copied from class: PlayerNpcEvent

Gets the npc.

Overrides:

getNpc in class PlayerNpcEvent

Returns:

the npc.

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.