Package org.bukkit.entity

Interface Arrow

All Superinterfaces:

AbstractArrow, CommandSender, Entity, Metadatable, Nameable, Permissible, PersistentDataHolder, Projectile, ServerOperator

All Known Subinterfaces:

TippedArrow

public interface Arrow
extends AbstractArrow

Nested Class Summary

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

AbstractArrow.PickupStatus

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

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
boolean	addCustomEffect(PotionEffect effect, boolean overwrite)	Adds a custom potion effect to this arrow.
void	clearCustomEffects()	Removes all custom potion effects from this arrow.
PotionData	getBasePotionData()	Deprecated. Upgraded / extended potions are now their own PotionType use getBasePotionType() instead.
PotionType	getBasePotionType()	Returns the potion type about the base potion
Color	getColor()	Gets the color of this arrow.
List<PotionEffect>	getCustomEffects()	Gets an immutable list containing all custom potion effects applied to this arrow.
boolean	hasCustomEffect(PotionEffectType type)	Checks for a specific custom potion effect type on this arrow.
boolean	hasCustomEffects()	Checks for the presence of custom potion effects.
boolean	removeCustomEffect(PotionEffectType type)	Removes a custom potion effect from this arrow.
void	setBasePotionData(PotionData data)	Deprecated. Upgraded / extended potions are now their own PotionType use setBasePotionType(org.bukkit.potion.PotionType) instead.
void	setBasePotionType(PotionType type)	Sets the underlying potion type
void	setColor(Color color)	Sets the color of this arrow.

Methods inherited from interface org.bukkit.entity.AbstractArrow

getAttachedBlock, getDamage, getItem, getKnockbackStrength, getPickupStatus, getPierceLevel, getWeapon, isCritical, isInBlock, isShotFromCrossbow, setCritical, setDamage, setItem, setKnockbackStrength, setPickupStatus, setPierceLevel, setShotFromCrossbow, setWeapon

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, copy, copy, createSnapshot, eject, getAsString, getBoundingBox, getEntityId, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isFrozen, isGlowing, isInsideVehicle, isInvulnerable, isInWater, isInWorld, isOnGround, isPersistent, isSilent, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, spigot, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.Nameable

getCustomName, setCustomName

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.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface org.bukkit.entity.Projectile

doesBounce, getShooter, setBounce, setShooter

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Method Details

setBasePotionData

@Deprecated(since="1.20.6")
void setBasePotionData(@Nullable
 PotionData data)

Deprecated.

Upgraded / extended potions are now their own PotionType use setBasePotionType(org.bukkit.potion.PotionType) instead.

Sets the underlying potion data

Parameters:

data - PotionData to set the base potion state to

getBasePotionData

@Nullable
@Deprecated(since="1.20.6")
PotionData getBasePotionData()

Deprecated.

Upgraded / extended potions are now their own PotionType use getBasePotionType() instead.

Returns the potion data about the base potion

Returns:

a PotionData object

setBasePotionType

void setBasePotionType(@Nullable
 PotionType type)

Sets the underlying potion type

Parameters:

type - PotionType to set the base potion state to

getBasePotionType

@Nullable
PotionType getBasePotionType()

Returns the potion type about the base potion

Returns:

a PotionType object

getColor

@Nullable
Color getColor()

Gets the color of this arrow.

Returns:

arrow Color or null if not color is set

setColor

void setColor(@Nullable
 Color color)

Sets the color of this arrow. Will be applied as a tint to its particles.

Parameters:

color - arrow color, null to clear the color

hasCustomEffects

boolean hasCustomEffects()

Checks for the presence of custom potion effects.

Returns:

true if custom potion effects are applied

getCustomEffects

@NotNull
List<PotionEffect> getCustomEffects()

Gets an immutable list containing all custom potion effects applied to this arrow.

Plugins should check that hasCustomEffects() returns true before calling this method.

Returns:

the immutable list of custom potion effects

addCustomEffect

boolean addCustomEffect(@NotNull
 PotionEffect effect,
 boolean overwrite)

Adds a custom potion effect to this arrow.

Parameters:

effect - the potion effect to add

overwrite - true if any existing effect of the same type should be overwritten

Returns:

true if the effect was added as a result of this call

removeCustomEffect

boolean removeCustomEffect(@NotNull
 PotionEffectType type)

Removes a custom potion effect from this arrow.

Parameters:

type - the potion effect type to remove

Returns:

true if the an effect was removed as a result of this call

Throws:

IllegalArgumentException - if this operation would leave the Arrow in a state with no Custom Effects and PotionType.UNCRAFTABLE

hasCustomEffect

boolean hasCustomEffect(@Nullable
 PotionEffectType type)

Checks for a specific custom potion effect type on this arrow.

Parameters:

type - the potion effect type to check for

Returns:

true if the potion has this effect

clearCustomEffects

void clearCustomEffects()

Removes all custom potion effects from this arrow.

Throws:

IllegalArgumentException - if this operation would leave the Arrow in a state with no Custom Effects and PotionType.UNCRAFTABLE