aboutsummaryrefslogtreecommitdiffhomepage
path: root/patches/api/0215-Player-elytra-boost-API.patch
blob: 29d59234941c7f3b8eaf23d53f9bd49e9f008d68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Trigary <trigary0@gmail.com>
Date: Tue, 14 Apr 2020 12:06:14 +0200
Subject: [PATCH] Player elytra boost API


diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index b0c0fd6687af5676d85094304ced25c1c444bc90..28a811be93b29f105dad1db91a8adccbdf9fcaf7 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -3289,6 +3289,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 {