org.bukkit.entity

Interface Firework

All Superinterfaces:

net.kyori.adventure.audience.Audience, CommandSender, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, Projectile, ServerOperator

public interface Firework
extends Projectile

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
void	detonate() Cause this firework to explode at earliest opportunity, as if it has no remaining fuse.
@Nullable LivingEntity	getBoostedEntity() If this firework is boosting an entity, return it
@NotNull FireworkMeta	getFireworkMeta() Get a copy of the fireworks meta
UUID	getSpawningEntity()
boolean	isShotAtAngle() Gets if the firework was shot at an angle (i.e.
void	setFireworkMeta(@NotNull FireworkMeta meta) Apply the provided meta to the fireworks
void	setShotAtAngle(boolean shotAtAngle) Sets if the firework was shot at an angle (i.e.

Methods inherited from interface org.bukkit.entity.Projectile

doesBounce, getShooter, setBounce, setShooter

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface net.kyori.adventure.audience.Audience

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Method Detail

getFireworkMeta

@NotNull
@NotNull FireworkMeta getFireworkMeta()

Get a copy of the fireworks meta

Returns:

A copy of the current Firework meta

setFireworkMeta

void setFireworkMeta(@NotNull
                     @NotNull FireworkMeta meta)

Apply the provided meta to the fireworks

Parameters:

meta - The FireworkMeta to apply

detonate

void detonate()

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

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

getSpawningEntity

@Nullable
UUID getSpawningEntity()

getBoostedEntity

@Nullable
@Nullable LivingEntity getBoostedEntity()

If this firework is boosting an entity, return it

Returns:

The entity being boosted