98 lines
2.8 KiB
Java
98 lines
2.8 KiB
Java
package org.bukkit.entity;
|
|
|
|
import java.util.List;
|
|
import org.bukkit.Color;
|
|
import org.bukkit.potion.PotionData;
|
|
import org.bukkit.potion.PotionEffect;
|
|
import org.bukkit.potion.PotionEffectType;
|
|
import org.jetbrains.annotations.NotNull;
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
public interface Arrow extends AbstractArrow {
|
|
|
|
/**
|
|
* Sets the underlying potion data
|
|
*
|
|
* @param data PotionData to set the base potion state to
|
|
*/
|
|
void setBasePotionData(@NotNull PotionData data);
|
|
|
|
/**
|
|
* Returns the potion data about the base potion
|
|
*
|
|
* @return a PotionData object
|
|
*/
|
|
@NotNull
|
|
PotionData getBasePotionData();
|
|
|
|
/**
|
|
* Gets the color of this arrow.
|
|
*
|
|
* @return arrow {@link Color} or null if not color is set
|
|
*/
|
|
@Nullable
|
|
Color getColor();
|
|
|
|
/**
|
|
* Sets the color of this arrow. Will be applied as a tint to its particles.
|
|
*
|
|
* @param color arrow color, null to clear the color
|
|
*/
|
|
void setColor(@Nullable Color color);
|
|
|
|
/**
|
|
* Checks for the presence of custom potion effects.
|
|
*
|
|
* @return true if custom potion effects are applied
|
|
*/
|
|
boolean hasCustomEffects();
|
|
|
|
/**
|
|
* Gets an immutable list containing all custom potion effects applied to
|
|
* this arrow.
|
|
* <p>
|
|
* Plugins should check that hasCustomEffects() returns true before calling
|
|
* this method.
|
|
*
|
|
* @return the immutable list of custom potion effects
|
|
*/
|
|
@NotNull
|
|
List<PotionEffect> getCustomEffects();
|
|
|
|
/**
|
|
* Adds a custom potion effect to this arrow.
|
|
*
|
|
* @param effect the potion effect to add
|
|
* @param overwrite true if any existing effect of the same type should be
|
|
* overwritten
|
|
* @return true if the effect was added as a result of this call
|
|
*/
|
|
boolean addCustomEffect(@NotNull PotionEffect effect, boolean overwrite);
|
|
|
|
/**
|
|
* Removes a custom potion effect from this arrow.
|
|
*
|
|
* @param type the potion effect type to remove
|
|
* @return 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
|
|
*/
|
|
boolean removeCustomEffect(@NotNull PotionEffectType type);
|
|
|
|
/**
|
|
* Checks for a specific custom potion effect type on this arrow.
|
|
*
|
|
* @param type the potion effect type to check for
|
|
* @return true if the potion has this effect
|
|
*/
|
|
boolean hasCustomEffect(@Nullable PotionEffectType type);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
void clearCustomEffects();
|
|
}
|