coll1234567 / Bukkit / 2e13cff7448

Commits

Martoph authored and md_5 committed 2e13cff7448 16 Apr 2023

#589: Expand the FishHook API

src/main/java/org/bukkit/entity/FishHook.java

Modified

-1
+package org.bukkit.entity;
-2
-3
+import org.jetbrains.annotations.NotNull;
-4
+import org.jetbrains.annotations.Nullable;
-5
-6
+/**
-7
+ * Represents a fishing hook.
-8
+ */
-9
+public interface FishHook extends Projectile {
-10
-11
+    /**
--
+     * Get the minimum number of ticks one has to wait for a fish biting.
-+
+     * Get the minimum number of ticks one has to wait for a fish appearing.
-13
+     * <p>
-14
+     * The default is 100 ticks (5 seconds).<br>
-15
+     * Note that this is before applying lure.
-16
+     *
--
+     * @return Minimum number of ticks one has to wait for a fish biting
-+
+     * @return Minimum number of ticks one has to wait for a fish appearing
-18
+     */
-19
+    public int getMinWaitTime();
-20
-21
+    /**
--
+     * Set the minimum number of ticks one has to wait for a fish biting.
-+
+     * Set the minimum number of ticks one has to wait for a fish appearing.
-23
+     * <p>
-24
+     * The default is 100 ticks (5 seconds).<br>
-25
+     * Note that this is before applying lure.
-26
+     *
-27
+     * @param minWaitTime Minimum number of ticks one has to wait for a fish
--
+     * biting
-+
+     * appearing
-29
+     */
-30
+    public void setMinWaitTime(int minWaitTime);
-31
-32
+    /**
--
+     * Get the maximum number of ticks one has to wait for a fish biting.
-+
+     * Get the maximum number of ticks one has to wait for a fish appearing.
-34
+     * <p>
-35
+     * The default is 600 ticks (30 seconds).<br>
-36
+     * Note that this is before applying lure.
-37
+     *
--
+     * @return Maximum number of ticks one has to wait for a fish biting
-+
+     * @return Maximum number of ticks one has to wait for a fish appearing
-39
+     */
-40
+    public int getMaxWaitTime();
-41
-42
+    /**
--
+     * Set the maximum number of ticks one has to wait for a fish biting.
-+
+     * Set the maximum number of ticks one has to wait for a fish appearing.
-44
+     * <p>
-45
+     * The default is 600 ticks (30 seconds).<br>
-46
+     * Note that this is before applying lure.
-47
+     *
-48
+     * @param maxWaitTime Maximum number of ticks one has to wait for a fish
--
+     * biting
-+
+     * appearing
-50
+     */
-51
+    public void setMaxWaitTime(int maxWaitTime);
-52
-+
+    /**
-+
+     * 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.
-+
+     * <p>
-+
+     * The default is 20 ticks (1 second).<br>
-+
+     * 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.
-+
+     * <p>
-+
+     * The default is 20 ticks (1 second).<br>
-+
+     * 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.
-+
+     * <p>
-+
+     * The default is 80 ticks (4 second).<br>
-+
+     * 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.
-+
+     * <p>
-+
+     * The default is 80 ticks (4 second).<br>
-+
+     * 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.
-+
+     * <p>
-+
+     * 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.
-+
+     * <p>
-+
+     * 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.
-+
+     * <p>
-+
+     * 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.
-+
+     * <p>
-+
+     * 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);
-+
-176
+    /**
-177
+     * Get whether the lure enchantment should be applied to reduce the wait
-178
+     * time.
-179
+     * <p>
-180
+     * The default is true.<br>
-181
+     * Lure reduces the wait time by 100 ticks (5 seconds) for each level of the
-182
+     * enchantment.
-183
+     *
-184
+     * @return Whether the lure enchantment should be applied to reduce the wait
-185
+     * time
-251
+    public void setHookedEntity(@Nullable Entity entity);
-252
-253
+    /**
-254
+     * Pull the hooked entity to the caster of this fish hook. If no entity is
-255
+     * hooked, this method has no effect.
-256
+     *
-257
+     * @return true if pulled, false if no entity is hooked
-258
+     */
-259
+    public boolean pullHookedEntity();
-260
-+
+    /**
-+
+     * 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);
-+
-298
+    /**
-299
+     * Get the current state of this fish hook.
-300
+     *
-301
+     * @return the fish hook state
-302
+     */
-303
+    @NotNull
-304
+    public HookState getState();
-305
-306
+    /**
-307
+     * Represents a state in which a fishing hook may be.

Bukkit

Commits

Jira Issues

Add shortcut