net.risingworld.api.events.player

Class PlayerCatchFishEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerCatchFishEvent

All Implemented Interfaces:

Cancellable

public class PlayerCatchFishEvent
extends PlayerEvent
implements Cancellable

Called when a player catches a fish (or another item). This is the moment when the fish is actually added to the inventory.

Constructor Summary

Constructors

Constructor and Description
PlayerCatchFishEvent(Player player, Vector3f fishingPosition, Item catchedItem, boolean removeBait)

Method Summary

Modifier and Type	Method and Description
Item	getCatchedItem() Gets the item the player has catched.
Vector3f	getFishingPosition() Gets the previous bobber position, before the bobber/fish was pulled out of the water.
boolean	isCancelled() Determines if the event is cancelled.
void	removeBait(boolean set) Determines if the bait will be consumed or not.
boolean	removesBait() Gets whether or not a bait will be consumed.
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

PlayerCatchFishEvent

public PlayerCatchFishEvent(Player player,
                            Vector3f fishingPosition,
                            Item catchedItem,
                            boolean removeBait)

Method Detail

getFishingPosition

public Vector3f getFishingPosition()

Gets the previous bobber position, before the bobber/fish was pulled out of the water.

Returns:

the previous bobber water position.

getCatchedItem

public Item getCatchedItem()

Gets the item the player has catched.

Returns:

the catched item.

removesBait

public boolean removesBait()

Gets whether or not a bait will be consumed.

Returns:

true if a bait will be consumed, false if not.

removeBait

public void removeBait(boolean set)

Determines if the bait will be consumed or not.

Parameters:

set - true to consume the bait, false to keep it.

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.