Package net.risingworld.api.events.player

Class PlayerFishingStartEvent

java.lang.Object
net.risingworld.api.events.Event
net.risingworld.api.events.player.PlayerEvent
net.risingworld.api.events.player.PlayerFishingStartEvent
All Implemented Interfaces:
Cancellable
public final class PlayerFishingStartEvent extends PlayerEvent implements Cancellable
Called when a player starts fishing. At this stage the server already calculated a possible "catch" for the player.

  • Method Details

    • getBobberPosition

      public Vector3f getBobberPosition()
      Gets the the bobber position (which should be in water).
      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;

    • getFishingDefinition

      public Fishing.FishingDefinition getFishingDefinition()
      Gets the definition of the fish/loot the player might catch.
      Returns:
      the fishing definition.

    • setFishingDefinition

      public void setFishingDefinition(Fishing.FishingDefinition definition)
      Changes the definition of the fish/loot the player might catch.
      Parameters:
      definition - the new fishing definition.

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

      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - set to true if you want to cancel this event.
      Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area
      1//Listener class
      2public class PlayerListener implements Listener{
      3 @EventMethod
      4 public void onEnterArea(PlayerEnterAreaEvent evt){
      5 //Now the player will not be able to enter the area, i.e.
      6 //he will be teleported back to his old position (outside the area)
      7 evt.setCancelled(true);
      8 }
      9}