Update documentation around PlayerJumpEvent

This commit is contained in:
Zach Brown
2017-09-29 14:58:24 -04:00
parent 563ee0f840
commit 91e639e718
3 changed files with 22 additions and 6 deletions

View File

@@ -6,7 +6,7 @@ Subject: [PATCH] Add PlayerJumpEvent
diff --git a/src/main/java/com/destroystokyo/paper/event/player/PlayerJumpEvent.java b/src/main/java/com/destroystokyo/paper/event/player/PlayerJumpEvent.java
new file mode 100644
index 00000000..1ea9c65f
index 00000000..dd24f9b0
--- /dev/null
+++ b/src/main/java/com/destroystokyo/paper/event/player/PlayerJumpEvent.java
@@ -0,0 +0,0 @@
@@ -20,7 +20,11 @@ index 00000000..1ea9c65f
+import org.bukkit.event.player.PlayerEvent;
+
+/**
+ * Holds information for player jump events
+ * Called when the server detects the player is jumping.
+ * <p>
+ * Added to avoid the overhead and special case logic that many plugins use
+ * when checking for jumps via PlayerMoveEvent, this event is fired whenever
+ * the server detects that the player is jumping.
+ */
+public class PlayerJumpEvent extends PlayerEvent implements Cancellable {
+ private static final HandlerList handlers = new HandlerList();
@@ -95,7 +99,7 @@ index 00000000..1ea9c65f
+
+ private void validateLocation(Location loc) {
+ Preconditions.checkArgument(loc != null, "Cannot use null location!");
+ Preconditions.checkArgument(loc.getWorld() != null, "Cannot use null location with null world!");
+ Preconditions.checkArgument(loc.getWorld() != null, "Cannot use location with null world!");
+ }
+
+ @Override