TheCreeperCow / Bukkit / 9ae3f10f8fa

Commits

Parker Hawke authored and md_5 committed 9ae3f10f8fa 12 Sep 2022

SPIGOT-3842: Add Player#fireworkBoost() and expand Firework API

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

Modified

-1
+package org.bukkit.entity;
-2
-3
+import org.bukkit.inventory.meta.FireworkMeta;
-4
+import org.jetbrains.annotations.NotNull;
-+
+import org.jetbrains.annotations.Nullable;
-6
-7
+public interface Firework extends Projectile {
-8
-9
+    /**
-10
+     * Get a copy of the fireworks meta
-11
+     *
-12
+     * @return A copy of the current Firework meta
-13
+     */
-14
+    @NotNull
-15
+    FireworkMeta getFireworkMeta();
-16
-17
+    /**
-18
+     * Apply the provided meta to the fireworks
-19
+     *
-20
+     * @param meta The FireworkMeta to apply
-21
+     */
-22
+    void setFireworkMeta(@NotNull FireworkMeta meta);
-23
-+
+    /**
-+
+     * Set the {@link LivingEntity} to which this firework is attached.
-+
+     * <p>
-+
+     * When attached to an entity, the firework effect will act as normal but
-+
+     * remain positioned on the entity. If the entity {@code LivingEntity#isGliding()
-+
+     * is gliding}, then the entity will receive a boost in the direction that
-+
+     * they are looking.
-+
+     *
-+
+     * @param entity the entity to which the firework should be attached, or
-+
+     * null to remove the attached entity
-+
+     * @return true if the entity could be attached, false if the firework was
-+
+     * already detonated
-+
+     */
-+
+    boolean setAttachedTo(@Nullable LivingEntity entity);
-+
-+
+    /**
-+
+     * Get the {@link LivingEntity} to which this firework is attached.
-+
+     * <p>
-+
+     * When attached to an entity, the firework effect will act as normal but
-+
+     * remain positioned on the entity. If the entity {@code LivingEntity#isGliding()
-+
+     * is gliding}, then the entity will receive a boost in the direction that
-+
+     * they are looking.
-+
+     *
-+
+     * @return the attached entity, or null if none
-+
+     */
-+
+    @Nullable
-+
+    LivingEntity getAttachedTo();
-+
-+
+    /**
-+
+     * Set the ticks that this firework has been alive. If this value exceeds
-+
+     * {@link #getMaxLife()}, the firework will detonate.
-+
+     *
-+
+     * @param ticks the ticks to set. Must be greater than or equal to 0
-+
+     * @return true if the life was set, false if this firework has already detonated
-+
+     */
-+
+    boolean setLife(int ticks);
-+
-+
+    /**
-+
+     * Get the ticks that this firework has been alive. When this value reaches
-+
+     * {@link #getMaxLife()}, the firework will detonate.
-+
+     *
-+
+     * @return the life ticks
-+
+     */
-+
+    int getLife();
-+
-+
+    /**
-+
+     * Set the time in ticks this firework will exist until it is detonated.
-+
+     *
-+
+     * @param ticks the ticks to set. Must be greater than 0
-+
+     * @return true if the time was set, false if this firework has already detonated
-+
+     */
-+
+    boolean setMaxLife(int ticks);
-+
-+
+    /**
-+
+     * Get the time in ticks this firework will exist until it is detonated.
-+
+     *
-+
+     * @return the maximum life in ticks
-+
+     */
-+
+    int getMaxLife();
-+
-84
+    /**
-85
+     * Cause this firework to explode at earliest opportunity, as if it has no
-86
+     * remaining fuse.
-87
+     */
-88
+    void detonate();
-89
-+
+    /**
-+
+     * Check whether or not this firework has detonated.
-+
+     *
-+
+     * @return true if detonated, false if still in the world
-+
+     */
-+
+    boolean isDetonated();
-+
-97
+    /**
-98
+     * Gets if the firework was shot at an angle (i.e. from a crossbow).
-99
+     *
-100
+     * A firework which was not shot at an angle will fly straight upwards.
-101
+     *
-102
+     * @return shot at angle status
-103
+     */
-104
+    boolean isShotAtAngle();
-105
-106
+    /**

Bukkit

Commits

Jira Issues

Add shortcut