Paper/patches/api/0367-Add-EntityPortalReadyEvent.patch

107 lines
3.4 KiB
Diff
Raw Normal View History

2022-07-23 01:23:12 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Wed, 12 May 2021 04:30:53 -0700
Subject: [PATCH] Add EntityPortalReadyEvent
diff --git a/src/main/java/io/papermc/paper/event/entity/EntityPortalReadyEvent.java b/src/main/java/io/papermc/paper/event/entity/EntityPortalReadyEvent.java
new file mode 100644
2024-02-01 10:15:57 +01:00
index 0000000000000000000000000000000000000000..3450735c86a8af45491c010a796262ae892f14dc
2022-07-23 01:23:12 +02:00
--- /dev/null
+++ b/src/main/java/io/papermc/paper/event/entity/EntityPortalReadyEvent.java
2024-02-01 10:15:57 +01:00
@@ -0,0 +1,94 @@
2022-07-23 01:23:12 +02:00
+package io.papermc.paper.event.entity;
+
+import org.bukkit.PortalType;
+import org.bukkit.World;
+import org.bukkit.entity.Entity;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.entity.EntityEvent;
2024-02-01 10:15:57 +01:00
+import org.bukkit.event.entity.EntityPortalEvent;
+import org.bukkit.event.player.PlayerPortalEvent;
+import org.jetbrains.annotations.ApiStatus;
2022-07-23 01:23:12 +02:00
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Called when an entity is ready to be teleported by a plugin.
+ * Currently this is only called after the required
+ * ticks have passed for a Nether Portal.
+ * <p>
+ * Cancelling this event resets the entity's readiness
+ * regarding the current portal.
+ */
+public class EntityPortalReadyEvent extends EntityEvent implements Cancellable {
+
+ private static final HandlerList HANDLER_LIST = new HandlerList();
+
+ private final PortalType portalType;
2024-02-01 10:15:57 +01:00
+ private World targetWorld;
+
2022-07-23 01:23:12 +02:00
+ private boolean cancelled;
+
2024-02-01 10:15:57 +01:00
+ @ApiStatus.Internal
2022-07-23 01:23:12 +02:00
+ public EntityPortalReadyEvent(final @NotNull Entity entity, final @Nullable World targetWorld, final @NotNull PortalType portalType) {
+ super(entity);
+ this.targetWorld = targetWorld;
+ this.portalType = portalType;
+ }
+
+ /**
+ * Gets the world this portal will teleport to.
2024-02-01 10:15:57 +01:00
+ * Can be {@code null} if "allow-nether" is false in server.properties
2022-07-23 01:23:12 +02:00
+ * or if there is another situation where there is no world to teleport to.
+ * <p>
2024-02-01 10:15:57 +01:00
+ * This world may be modified by later events such as {@link PlayerPortalEvent}
+ * or {@link EntityPortalEvent}.
2022-07-23 01:23:12 +02:00
+ *
+ * @return the world the portal will teleport the entity to.
+ */
+ public @Nullable World getTargetWorld() {
2024-02-01 10:15:57 +01:00
+ return this.targetWorld;
2022-07-23 01:23:12 +02:00
+ }
+
+ /**
2024-02-01 10:15:57 +01:00
+ * Sets the world this portal will teleport to. A {@code null} value
2022-07-23 01:23:12 +02:00
+ * will essentially cancel the teleport and prevent further events
2024-02-01 10:15:57 +01:00
+ * such as {@link PlayerPortalEvent} from firing.
2022-07-23 01:23:12 +02:00
+ * <p>
2024-02-01 10:15:57 +01:00
+ * This world may be modified by later events such as {@link PlayerPortalEvent}
+ * or {@link EntityPortalEvent}.
2022-07-23 01:23:12 +02:00
+ *
+ * @param targetWorld the world
+ */
+ public void setTargetWorld(final @Nullable World targetWorld) {
+ this.targetWorld = targetWorld;
+ }
+
+ /**
+ * Gets the portal type for this event.
+ *
+ * @return the portal type
+ */
+ public @NotNull PortalType getPortalType() {
2024-02-01 10:15:57 +01:00
+ return this.portalType;
2022-07-23 01:23:12 +02:00
+ }
+
+ @Override
+ public boolean isCancelled() {
2024-02-01 10:15:57 +01:00
+ return this.cancelled;
2022-07-23 01:23:12 +02:00
+ }
+
+ @Override
+ public void setCancelled(final boolean cancel) {
+ this.cancelled = cancel;
+ }
+
+ @Override
+ public @NotNull HandlerList getHandlers() {
+ return HANDLER_LIST;
+ }
+
+ public static @NotNull HandlerList getHandlerList() {
+ return HANDLER_LIST;
+ }
+}