Package org.bukkit.entity
Interface Firework
- All Superinterfaces:
Audience
,CommandSender
,Entity
,HoverEventSource<HoverEvent.ShowEntity>
,Metadatable
,Nameable
,Permissible
,PersistentDataHolder
,PersistentDataViewHolder
,Pointered
,Projectile
,ServerOperator
,Sound.Emitter
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.bukkit.entity.Entity
Entity.Spigot
-
Method Summary
Modifier and TypeMethodDescriptionvoid
detonate()
Cause this firework to explode at earliest opportunity, as if it has no remaining fuse.Get theLivingEntity
to which this firework is attached.default @Nullable LivingEntity
Deprecated.Get a copy of the fireworks metagetItem()
Gets the item used in the firework.int
getLife()
Deprecated, for removal: This API element is subject to removal in a future version.usegetTicksFlown()
int
Deprecated, for removal: This API element is subject to removal in a future version.int
Gets the number of ticks the firework has flown.int
Gets the number of ticks the firework will detonate on.boolean
Check whether or not this firework has detonated.boolean
Gets if the firework was shot at an angle (i.e.boolean
setAttachedTo
(@Nullable LivingEntity entity) Set theLivingEntity
to which this firework is attached.void
Apply the provided meta to the fireworksvoid
Sets the item used in the firework.boolean
setLife
(int ticks) Deprecated, for removal: This API element is subject to removal in a future version.boolean
setMaxLife
(int ticks) Deprecated, for removal: This API element is subject to removal in a future version.void
setShotAtAngle
(boolean shotAtAngle) Sets if the firework was shot at an angle (i.e.void
setTicksFlown
(int ticks) Sets the number of ticks the firework has flown.void
setTicksToDetonate
(int ticks) Set the amount of ticks the firework will detonate on.Methods inherited from interface net.kyori.adventure.audience.Audience
clearResourcePacks, clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, sendResourcePacks, sendTitlePart, showBossBar, showTitle, stopSound, stopSound
Methods inherited from interface org.bukkit.command.CommandSender
getName, name, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlainMessage, sendRichMessage, sendRichMessage
Methods inherited from interface org.bukkit.entity.Entity
addPassenger, addScoreboardTag, asHoverEvent, broadcastHurtAnimation, collidesAt, copy, copy, createSnapshot, eject, fromMobSpawner, getAsString, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPitch, getPortalCooldown, getPose, getScheduler, getScoreboardEntryName, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getTrackedPlayers, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, getX, getY, getYaw, getZ, hasFixedPose, hasGravity, hasNoPhysics, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isInBubbleColumn, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvisible, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isInWorld, isOnGround, isPersistent, isSilent, isSneaking, isTicking, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvisible, setInvulnerable, setLastDamageCause, setNoPhysics, setPassenger, setPersistent, setPortalCooldown, setPose, setPose, setRotation, setSilent, setSneaking, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync, teleportAsync, wouldCollideUsing
Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource
asHoverEvent
Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata
Methods inherited from interface org.bukkit.Nameable
customName, customName, getCustomName, setCustomName
Methods inherited from interface org.bukkit.permissions.Permissible
addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, permissionValue, permissionValue, recalculatePermissions, removeAttachment
Methods inherited from interface org.bukkit.persistence.PersistentDataHolder
getPersistentDataContainer
Methods inherited from interface net.kyori.adventure.pointer.Pointered
get, getOrDefault, getOrDefaultFrom, pointers
Methods inherited from interface org.bukkit.entity.Projectile
canHitEntity, doesBounce, getOwnerUniqueId, getShooter, hasBeenShot, hasLeftShooter, hitEntity, hitEntity, setBounce, setHasBeenShot, setHasLeftShooter, setShooter
Methods inherited from interface org.bukkit.permissions.ServerOperator
isOp, setOp
-
Method Details
-
getFireworkMeta
Get a copy of the fireworks meta- Returns:
- A copy of the current Firework meta
-
setFireworkMeta
Apply the provided meta to the fireworksAdjusts detonation ticks automatically.
- Parameters:
meta
- The FireworkMeta to apply
-
setAttachedTo
Set theLivingEntity
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
Get theLivingEntity
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
Deprecated, for removal: This API element is subject to removal in a future version.Set the ticks that this firework has been alive. If this value exceedsgetMaxLife()
, 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
Deprecated, for removal: This API element is subject to removal in a future version.usegetTicksFlown()
Get the ticks that this firework has been alive. When this value reachesgetMaxLife()
, the firework will detonate.- Returns:
- the life ticks
-
setMaxLife
Deprecated, for removal: This API element is subject to removal in a future version.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
Deprecated, for removal: This API element is subject to removal in a future version.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
-
getSpawningEntity
-
getBoostedEntity
Deprecated.usegetAttachedTo()
If this firework is boosting an entity, return it- Returns:
- The entity being boosted
- See Also:
-
getItem
Gets the item used in the firework.- Returns:
- firework item
-
setItem
Sets the item used in the firework.Firework explosion effects are used from this item.
- Parameters:
itemStack
- item to set
-
getTicksFlown
int getTicksFlown()Gets the number of ticks the firework has flown.- Returns:
- ticks flown
-
setTicksFlown
void setTicksFlown(int ticks) Sets the number of ticks the firework has flown. Setting this greater than detonation ticks will cause the firework to explode.- Parameters:
ticks
- ticks flown
-
getTicksToDetonate
int getTicksToDetonate()Gets the number of ticks the firework will detonate on.- Returns:
- the tick to detonate on
-
setTicksToDetonate
void setTicksToDetonate(int ticks) Set the amount of ticks the firework will detonate on.- Parameters:
ticks
- ticks to detonate on
-
getAttachedTo()