Package org.bukkit.entity

Interface Firework

All Superinterfaces:
CommandSender, Entity, Metadatable, Nameable, Permissible, PersistentDataHolder, Projectile, ServerOperator
public interface Firework extends Projectile

  • Method Details

    • getFireworkMeta

      @NotNull FireworkMeta getFireworkMeta()
      Get a copy of the fireworks meta
      Returns:
      A copy of the current Firework meta

    • setFireworkMeta

      void setFireworkMeta(@NotNull FireworkMeta meta)
      Apply the provided meta to the fireworks
      Parameters:
      meta - The FireworkMeta to apply

    • setAttachedTo

      boolean setAttachedTo(@Nullable LivingEntity entity)
      Set the LivingEntity to which this firework is attached.

      When attached to an entity, the firework effect will act as normal but remain positioned on the entity. If the entity LivingEntity#isGliding() is gliding, then the entity will receive a boost in the direction that they are looking.

      Parameters:
      entity - the entity to which the firework should be attached, or null to remove the attached entity
      Returns:
      true if the entity could be attached, false if the firework was already detonated

    • getAttachedTo

      @Nullable LivingEntity getAttachedTo()
      Get the LivingEntity to which this firework is attached.

      When attached to an entity, the firework effect will act as normal but remain positioned on the entity. If the entity LivingEntity#isGliding() is gliding, then the entity will receive a boost in the direction that they are looking.

      Returns:
      the attached entity, or null if none

    • setLife

      boolean setLife(int ticks)
      Set the ticks that this firework has been alive. If this value exceeds getMaxLife(), the firework will detonate.
      Parameters:
      ticks - the ticks to set. Must be greater than or equal to 0
      Returns:
      true if the life was set, false if this firework has already detonated

    • getLife

      int getLife()
      Get the ticks that this firework has been alive. When this value reaches getMaxLife(), the firework will detonate.
      Returns:
      the life ticks

    • setMaxLife

      boolean setMaxLife(int ticks)
      Set the time in ticks this firework will exist until it is detonated.
      Parameters:
      ticks - the ticks to set. Must be greater than 0
      Returns:
      true if the time was set, false if this firework has already detonated

    • getMaxLife

      int getMaxLife()
      Get the time in ticks this firework will exist until it is detonated.
      Returns:
      the maximum life in ticks

    • detonate

      void detonate()
      Cause this firework to explode at earliest opportunity, as if it has no remaining fuse.

    • isDetonated

      boolean isDetonated()
      Check whether or not this firework has detonated.
      Returns:
      true if detonated, false if still in the world

    • isShotAtAngle

      boolean isShotAtAngle()
      Gets if the firework was shot at an angle (i.e. from a crossbow). A firework which was not shot at an angle will fly straight upwards.
      Returns:
      shot at angle status

    • setShotAtAngle

      void setShotAtAngle(boolean shotAtAngle)
      Sets if the firework was shot at an angle (i.e. from a crossbow). A firework which was not shot at an angle will fly straight upwards.
      Parameters:
      shotAtAngle - the new shotAtAngle