coll1234567 / Bukkit / 3741079b38c

Commits

Parker Hawke authored and md_5 committed 3741079b38c 19 Mar 2023

#824: Expand upon PotionEffect API to better accommodate infinite durations

src/main/java/org/bukkit/potion/PotionEffect.java

Modified

-13
+import org.jetbrains.annotations.Nullable;
-14
-15
+/**
-16
+ * Represents a potion effect, that can be added to a {@link LivingEntity}. A
-17
+ * potion effect has a duration that it will last for, an amplifier that will
-18
+ * enhance its effects, and a {@link PotionEffectType}, that represents its
-19
+ * effect on an entity.
-20
+ */
-21
+@SerializableAs("PotionEffect")
-22
+public class PotionEffect implements ConfigurationSerializable {
-+
+    /**
-+
+     * A constant denoting infinite potion duration.
-+
+     */
-+
+    public static final int INFINITE_DURATION = -1;
-+
-28
+    private static final String AMPLIFIER = "amplifier";
-29
+    private static final String DURATION = "duration";
-30
+    private static final String TYPE = "effect";
-31
+    private static final String AMBIENT = "ambient";
-32
+    private static final String PARTICLES = "has-particles";
-33
+    private static final String ICON = "has-icon";
-34
+    private final int amplifier;
-35
+    private final int duration;
-36
+    private final PotionEffectType type;
-37
+    private final boolean ambient;
-177
+     * @return The effect amplifier
-178
+     */
-179
+    public int getAmplifier() {
-180
+        return amplifier;
-181
+    }
-182
-183
+    /**
-184
+     * Returns the duration (in ticks) that this effect will run for when
-185
+     * applied to a {@link LivingEntity}.
-186
+     *
--
+     * @return The duration of the effect
-+
+     * @return The duration of the effect, or {@value #INFINITE_DURATION} if
-+
+     * this effect is infinite
-+
+     * @see #isInfinite()
-190
+     */
-191
+    public int getDuration() {
-192
+        return duration;
-193
+    }
-194
-+
+    /**
-+
+     * Returns whether or not this potion effect has an infinite duration. Potion
-+
+     * effects with infinite durations will display an infinite symbol and never
-+
+     * expire unless manually removed.
-+
+     *
-+
+     * @return whether this duration is infinite or not
-+
+     */
-+
+    public boolean isInfinite() {
-+
+        return duration == INFINITE_DURATION;
-+
+    }
-+
-+
+    /**
-+
+     * Returns whether or not this potion effect has a shorter duration than the
-+
+     * provided potion effect.
-+
+     * <p>
-+
+     * An infinite duration is considered longer than non-infinite durations. If
-+
+     * both potion effects have infinite durations, then neither is shorter than
-+
+     * the other and this method will return false.
-+
+     *
-+
+     * @param other the other effect
-+
+     * @return true if this effect is shorter than the other, false if longer or equal
-+
+     */
-+
+    public boolean isShorterThan(@NotNull PotionEffect other) {
-+
+        return !isInfinite() && (duration < other.duration || other.isInfinite());
-+
+    }
-+
-221
+    /**
-222
+     * Returns the {@link PotionEffectType} of this effect.
-223
+     *
-224
+     * @return The potion type of this effect
-225
+     */
-226
+    @NotNull
-227
+    public PotionEffectType getType() {
-228
+        return type;
-229
+    }
-230

Bukkit

Commits

Jira Issues

Add shortcut