org.bukkit.entity.FishHook Maven / Gradle / Ivy

Go to download
package org.bukkit.entity;

/**
 * Represents a fishing hook.
 */
public interface FishHook extends Projectile {
  /**
   * Gets the chance of a fish biting.
   * 
   * 0.0 = No Chance.

   * 1.0 = Instant catch.
   *
   * @return chance the bite chance
   */
  double getBiteChance();

  /**
   * Sets the chance of a fish biting.
   * 
   * 0.0 = No Chance.

   * 1.0 = Instant catch.
   *
   * @param chance the bite chance
   * @throws IllegalArgumentException if the bite chance is not between 0
   *                                  and 1
   */
  void setBiteChance(double chance) throws IllegalArgumentException;
}