Player elytra boost API

This commit is contained in:
Trigary 2020-04-14 12:06:14 +02:00
parent 60a89bc804
commit a3a9180c51

View file

@ -3382,6 +3382,25 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
<T> @NotNull T getClientOption(com.destroystokyo.paper.@NotNull ClientOption<T> option);
// Paper end - client option API
// Paper start - elytra boost API
/**
* Boost a Player that's {@link #isGliding()} using a {@link Firework}.
* If the creation of the entity is cancelled, no boosting is done.
* This method does not fire {@link com.destroystokyo.paper.event.player.PlayerElytraBoostEvent}.
*
* @param firework The {@link Material#FIREWORK_ROCKET} to boost the player with
* @return The {@link Firework} boosting the Player or null if the spawning of the entity was cancelled
* @throws IllegalArgumentException if {@link #isGliding()} is false
* or if the {@code firework} isn't a {@link Material#FIREWORK_ROCKET}
* @deprecated use {@link HumanEntity#fireworkBoost(ItemStack)} instead. Note that this method <b>does not</b>
* check if the player is gliding or not.
*/
default @Nullable Firework boostElytra(final @NotNull ItemStack firework) {
com.google.common.base.Preconditions.checkState(this.isGliding(), "Player must be gliding");
return this.fireworkBoost(firework);
}
// Paper end - elytra boost API
// Spigot start
public class Spigot extends Entity.Spigot {