Spigot / Bukkit / 935e6dd9397

Commits

Hex authored and md_5 committed 935e6dd9397 05 Dec 2014

Add API to PotionEffect to determine whether particles are visible and displayed to the client.

Fixes SPIGOT-125

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

Modified

-19
+@SerializableAs("PotionEffect")
-20
+public class PotionEffect implements ConfigurationSerializable {
-21
+    private static final String AMPLIFIER = "amplifier";
-22
+    private static final String DURATION = "duration";
-23
+    private static final String TYPE = "effect";
-24
+    private static final String AMBIENT = "ambient";
-25
+    private final int amplifier;
-26
+    private final int duration;
-27
+    private final PotionEffectType type;
-28
+    private final boolean ambient;
-+
+    private final boolean particles;
-30
-31
+    /**
-32
+     * Creates a potion effect.
--
+     *
-33
+     * @param type effect type
-34
+     * @param duration measured in ticks, see {@link
-35
+     *     PotionEffect#getDuration()}
-36
+     * @param amplifier the amplifier, see {@link PotionEffect#getAmplifier()}
-37
+     * @param ambient the ambient status, see {@link PotionEffect#isAmbient()}
-+
+     * @param particles the particle status, see {@link PotionEffect#hasParticles()}
-39
+     */
--
+    public PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient) {
-+
+    public PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient, boolean particles){
-41
+        Validate.notNull(type, "effect type cannot be null");
-42
+        this.type = type;
-43
+        this.duration = duration;
-44
+        this.amplifier = amplifier;
-45
+        this.ambient = ambient;
-+
+        this.particles = particles;
-+
+    }
-+
-+
+    /**
-+
+     * Creates a potion effect. Assumes that particles are visible
-+
+     *
-+
+     * @param type effect type
-+
+     * @param duration measured in ticks, see {@link
-+
+     *     PotionEffect#getDuration()}
-+
+     * @param amplifier the amplifier, see {@link PotionEffect#getAmplifier()}
-+
+     * @param ambient the ambient status, see {@link PotionEffect#isAmbient()}
-+
+     */
-+
+    public PotionEffect(PotionEffectType type, int duration, int amplifier, boolean ambient) {
-+
+        this(type, duration, amplifier, ambient, true);
-60
+    }
-61
-62
+    /**
-63
+     * Creates a potion effect. Assumes ambient is true.
-64
+     *
-65
+     * @param type Effect type
-66
+     * @param duration measured in ticks
-67
+     * @param amplifier the amplifier for the effect
-68
+     * @see PotionEffect#PotionEffect(PotionEffectType, int, int, boolean)
-69
+     */
-170
-171
+    /**
-172
+     * Makes potion effect produce more, translucent, particles.
-173
+     *
-174
+     * @return if this effect is ambient
-175
+     */
-176
+    public boolean isAmbient() {
-177
+        return ambient;
-178
+    }
-179
-+
+    /**
-+
+     * @return whether this effect has particles or not
-+
+     */
-+
+    public boolean hasParticles(){
-+
+        return particles;
-+
+    }
-+
-187
+    @Override
-188
+    public int hashCode() {
-189
+        int hash = 1;
-190
+        hash = hash * 31 + type.hashCode();
-191
+        hash = hash * 31 + amplifier;
-192
+        hash = hash * 31 + duration;
-193
+        hash ^= 0x22222222 >> (ambient ? 1 : -1);
-194
+        return hash;
-195
+    }
-196

Bukkit

Commits

Jira Issues

Add shortcut