SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SPIGOT-4819: Continue refactoring of Arrow-related APIs

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2019-04-30 21:12:59 +10:00
parent cfe800dd65
commit 822d06fd4b
6 changed files with 198 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
paper-api/src/main/java/org/bukkit/entity/TippedArrow.java
View File

@@ -1,97 +1,8 @@
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 TippedArrow extends Arrow {
/**
* 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 color
*/
@NotNull
Color getColor();
/**
* Sets the color of this arrow. Will be applied as a tint to its particles.
*
* @param color arrow color
*/
void setColor(@NotNull 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();
}
/**
* @deprecated tipped status depends only on base potion type not being
* UNCRAFTABLE and effects being empty.
*/
@Deprecated
public interface TippedArrow extends Arrow { }