* The default is 100 ticks (5 seconds).
* Note that this is before applying lure.
*
* @return Minimum number of ticks one has to wait for a fish appearing
*/
public int getMinWaitTime();
/**
* Set the minimum number of ticks one has to wait for a fish appearing.
*
* The default is 100 ticks (5 seconds).
* Note that this is before applying lure.
*
* @param minWaitTime Minimum number of ticks one has to wait for a fish
* appearing
*/
public void setMinWaitTime(int minWaitTime);
/**
* Get the maximum number of ticks one has to wait for a fish appearing.
*
* The default is 600 ticks (30 seconds).
* Note that this is before applying lure.
*
* @return Maximum number of ticks one has to wait for a fish appearing
*/
public int getMaxWaitTime();
/**
* Set the maximum number of ticks one has to wait for a fish appearing.
*
* The default is 600 ticks (30 seconds).
* Note that this is before applying lure.
*
* @param maxWaitTime Maximum number of ticks one has to wait for a fish
* appearing
*/
public void setMaxWaitTime(int maxWaitTime);
/**
* Set both the minimum (default 100) and maximum (default 600) amount
* of ticks one has to wait for a fish appearing.
*
* @param min minimum ticks for a fish to appear
* @param max maximum ticks for a fish to appear
*/
public void setWaitTime(int min, int max);
/**
* Get the minimum number of ticks one has to wait for a fish to bite
* after appearing.
*
* The default is 20 ticks (1 second).
* Lure does not affect this value.
* This will also effect the radius (0.1 * lureTime) of where
* the fish will appear.
*
* @return Minimum number of ticks one has to wait for a fish to bite
*/
public int getMinLureTime();
/**
* Set the minimum number of ticks one has to wait for a fish to bite
* after appearing.
*
* The default is 20 ticks (1 second).
* Lure does not affect this value.
* This will also effect the radius (0.1 * lureTime) of where
* the fish will appear.
*
* @param minLureTime Minimum number of ticks one has to wait for a fish
* to bite
*/
public void setMinLureTime(int minLureTime);
/**
* Get the maximum number of ticks one has to wait for a fish to bite
* after appearing.
*
* The default is 80 ticks (4 second).
* Lure does not affect this value.
* This will also effect the radius (0.1 * lureTime) of where
* the fish will appear.
*
* @return Maximum number of ticks one has to wait for a fish to bite
*/
public int getMaxLureTime();
/**
* Set the maximum number of ticks one has to wait for a fish to bite
* after appearing.
*
* The default is 80 ticks (4 second).
* Lure does not affect this value.
* This will also effect the radius (0.1 * lureTime) of where
* the fish will appear.
*
* @param maxLureTime Maximum number of ticks one has to wait for a fish
* to bite
*/
public void setMaxLureTime(int maxLureTime);
/**
* Set both the minimum (default 20) and maximum (default 80) amount
* of ticks one has to wait for a fish to bite after appearing.
*
* @param min minimum ticks to wait for a bite
* @param max maximum ticks to wait for a bite
*/
public void setLureTime(int min, int max);
/**
* Get the minimum angle (in degrees, 0 being positive Z 90 being negative
* X) of where a fish will appear after the wait time.
*
* The default is 0 degrees. * * @return Minimum angle of where a fish will appear */ public float getMinLureAngle(); /** * Set the minimum angle (in degrees, 0 being positive Z 90 being negative * X) of where a fish will appear after the wait time. *
* The default is 0 degrees. * * @param minLureAngle Minimum angle of where a fish may appear */ public void setMinLureAngle(float minLureAngle); /** * Get the maximum angle (in degrees, 0 being positive Z 90 being negative * X) of where a fish will appear after the wait time. *
* The default is 360 degrees. * * @return Maximum angle of where a fish will appear */ public float getMaxLureAngle(); /** * Set the maximum angle (in degrees, 0 being positive Z 90 being negative * X) of where a fish will appear after the wait time. *
* The default is 360 degrees. * * @param maxLureAngle Maximum angle of where a fish may appear */ public void setMaxLureAngle(float maxLureAngle); /** * Set both the minimum (default 0) and maximum (default 360) angle of where * a fish will appear after the wait time. * * 0 degrees is positive Z, 90 degrees is negative X. * * @param min minimum angle in degrees * @param max maximum angle in degrees */ public void setLureAngle(float min, float max); /** * Get whether the lure enchantment should be applied to reduce the wait * time. *
* The default is true.
* Lure reduces the wait time by 100 ticks (5 seconds) for each level of the
* enchantment.
*
* @return Whether the lure enchantment should be applied to reduce the wait
* time
*/
public boolean getApplyLure();
/**
* Set whether the lure enchantment should be applied to reduce the wait
* time.
*
* The default is true.
* Lure reduces the wait time by 100 ticks (5 seconds) for each level of the
* enchantment.
*
* @param applyLure Whether the lure enchantment should be applied to reduce
* the wait time
*/
public void setApplyLure(boolean applyLure);
/**
* Gets the chance of a fish biting.
*
* 0.0 = No Chance.
* 1.0 = Instant catch.
*
* @return chance the bite chance
* @deprecated has no effect in newer Minecraft versions
*/
@Deprecated(since = "1.9.2")
public 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
* @deprecated has no effect in newer Minecraft versions
*/
@Deprecated(since = "1.9.2")
public void setBiteChance(double chance) throws IllegalArgumentException;
/**
* Check whether or not this fish hook is in open water.
*
* Open water is defined by a 5x4x5 area of water, air and lily pads. If in * open water, treasure items may be caught. * * @return true if in open water, false otherwise */ public boolean isInOpenWater(); /** * Get the entity hooked by this fish hook. * * @return the hooked entity. null if none */ @Nullable public Entity getHookedEntity(); /** * Set the entity hooked by this fish hook. * * @param entity the entity to set, or null to unhook */ public void setHookedEntity(@Nullable Entity entity); /** * Pull the hooked entity to the caster of this fish hook. If no entity is * hooked, this method has no effect. * * @return true if pulled, false if no entity is hooked */ public boolean pullHookedEntity(); /** * Whether or not wait and lure time will be impacted by direct sky access. * * True by default, causes a 50% time increase on average. * * @return skylight access influences catch rate */ public boolean isSkyInfluenced(); /** * Set whether or not wait and lure time will be impacted by direct sky * access. * * True by default, causes a 50% time increase on average. * * @param skyInfluenced if this hook is influenced by skylight access */ public void setSkyInfluenced(boolean skyInfluenced); /** * Whether or not wait and lure time will be impacted by rain. * * True by default, causes a 25% time decrease on average. * * @return rain influences catch rate */ public boolean isRainInfluenced(); /** * Set whether or not wait and lure time will be impacted by rain. * * True by default, causes a 25% time decrease on average. * * @param rainInfluenced if this hook is influenced by rain */ public void setRainInfluenced(boolean rainInfluenced); /** * Get the current state of this fish hook. * * @return the fish hook state */ @NotNull public HookState getState(); /** * Represents a state in which a fishing hook may be. */ public enum HookState { /** * The fishing hook has been cast and is either in the air or resting * against a block on the ground. */ UNHOOKED, /** * The fishing hook has hooked an entity. */ HOOKED_ENTITY, /** * The fishing hook is bobbing in the water, waiting for a bite. */ BOBBING; } // Paper start - More FishHook API /** * Get the number of ticks the hook needs to wait for a fish to bite. * * @return Number of ticks */ int getWaitTime(); /** * Sets the number of ticks the hook needs to wait for a fish to bite. * * @param ticks Number of ticks */ void setWaitTime(int ticks); /** * Get the number of ticks the fish has to swim until biting the hook. * The {@link #getWaitTime()} has to be zero or below for the fish to start the time until bite timer. * * @return number of ticks. * A value of one indicates that the fish bites the very next time the fish hook is ticked * while a value of zero represents a fish that has already bitten the hook. * @see #getWaitTime() */ @org.jetbrains.annotations.Range(from = 0, to = Integer.MAX_VALUE) int getTimeUntilBite(); /** * Sets the number of ticks the fish has to swim until biting the hook. * * @param ticks number of ticks. * One is the minimum that can be passed to this method and instructs the fish to bite the very next tick. * @throws IllegalArgumentException if the passed tick value is less than one. */ void setTimeUntilBite(@org.jetbrains.annotations.Range(from = 1, to = Integer.MAX_VALUE) int ticks) throws IllegalArgumentException; /** * Completely resets this fishing hook's fishing state, re-randomizing the time needed until a fish is lured and * bites the hook. *
* This method takes all properties of the fishing hook into account when resetting said values, such as a lure * enchantment. */ void resetFishingState(); // Paper end }