net.risingworld.api.events.player

Class PlayerStartFishingEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerStartFishingEvent

All Implemented Interfaces:

Cancellable

public class PlayerStartFishingEvent
extends PlayerEvent
implements Cancellable

Called when a player starts fishing. At this stage the server already calculated a possible "catch" for the player.

Constructor Summary

Constructors

Constructor and Description
PlayerStartFishingEvent(Player player, Vector3f fishingPosition, int waterdepth, byte watertype, boolean hasBait, int waitTime, short catchItemID)

Method Summary

Modifier and Type	Method and Description
short	getCatchItem()
Vector3f	getFishingPosition() Gets the fishing position, or more precisely, the bobber position.
int	getWaitTime() Gets the time (in seconds) the player has to wait until a fish bites.
int	getWaterDepth() Gets the current water depth.
byte	getWaterID() Gets the water ID, i.e. salt water, fresh water etc.
boolean	hasBait() Gets whether or not the player has a bait in his inventory (which will be used in this case).
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setCatchItem(short id)
void	setWaitTime(int seconds) Changes the wait time, i.e. the duration until a fish bites.

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

PlayerStartFishingEvent

public PlayerStartFishingEvent(Player player,
                               Vector3f fishingPosition,
                               int waterdepth,
                               byte watertype,
                               boolean hasBait,
                               int waitTime,
                               short catchItemID)

Method Detail

getFishingPosition

public Vector3f getFishingPosition()

Gets the fishing position, or more precisely, the bobber position.

Returns:

the bobber world position.

getWaitTime

public int getWaitTime()

Gets the time (in seconds) the player has to wait until a fish bites.

Returns:

the "wait time" in seconds.

setWaitTime

public void setWaitTime(int seconds)

Changes the wait time, i.e. the duration until a fish bites.

Parameters:

seconds - the new wait time, in seconds.

hasBait

public boolean hasBait()

Gets whether or not the player has a bait in his inventory (which will be used in this case).

Returns:

true if there is a bait in the players inventory, false if not.

getWaterDepth

public int getWaterDepth()

Gets the current water depth.

Returns:

the current water depth;

getWaterID

public byte getWaterID()

Gets the water ID, i.e. salt water, fresh water etc.

Returns:

the water ID

getCatchItem

public short getCatchItem()

setCatchItem

public void setCatchItem(short id)

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.