mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-21 18:15:54 +01:00
8c5b837e05
Firstly, the old methods all routed to the CompletableFuture method. However, the CF method could not guarantee that if the caller was off-main that the future would be "completed" on-main. Since the callback methods used the CF one, this meant that the callback methods did not guarantee that the callbacks were to be called on the main thread. Now, all methods route to getChunkAtAsync(x, z, gen, urgent, cb) so that the methods with the callback are guaranteed to invoke the callback on the main thread. The CF behavior remains unchanged; it may still appear to complete on main if invoked off-main. Secondly, remove the scheduleOnMain invocation in the async chunk completion. This unnecessarily delays the callback by 1 tick. Thirdly, add getChunksAtAsync(minX, minZ, maxX, maxZ, ...) which will load chunks within an area. This method is provided as a helper as keeping all chunks loaded within an area can be complicated to implement for plugins (due to the lacking ticket API), and is already implemented internally anyways. Fourthly, remove the ticket addition that occured with getChunkAt and getChunkAtAsync. The ticket addition may delay the unloading of the chunk unnecessarily. It also fixes a very rare timing bug where the future/callback would be completed after the chunk unloads.
117 lines
6.2 KiB
Diff
117 lines
6.2 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: TonytheMacaroni <tonythemacaroni123@gmail.com>
|
|
Date: Wed, 6 Sep 2023 19:24:53 -0400
|
|
Subject: [PATCH] Add predicate for blocks when raytracing
|
|
|
|
|
|
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
|
|
index 24eaf74420f6fbd4f0a0f13b719f57b50696aef3..9a473448427b48038e097796459ff0352f5a54cc 100644
|
|
--- a/src/main/java/org/bukkit/World.java
|
|
+++ b/src/main/java/org/bukkit/World.java
|
|
@@ -1686,6 +1686,27 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
|
@Nullable
|
|
public RayTraceResult rayTraceEntities(@NotNull Location start, @NotNull Vector direction, double maxDistance, double raySize, @Nullable Predicate<? super Entity> filter);
|
|
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Performs a ray trace that checks for entity collisions.
|
|
+ * <p>
|
|
+ * This may not consider entities in currently unloaded chunks. Some
|
|
+ * implementations may impose artificial restrictions on the maximum
|
|
+ * distance.
|
|
+ *
|
|
+ * @param start the start position
|
|
+ * @param direction the ray direction
|
|
+ * @param maxDistance the maximum distance
|
|
+ * @param raySize entity bounding boxes will be uniformly expanded (or
|
|
+ * shrinked) by this value before doing collision checks
|
|
+ * @param filter only entities that fulfill this predicate are considered,
|
|
+ * or <code>null</code> to consider all entities
|
|
+ * @return the closest ray trace hit result, or <code>null</code> if there
|
|
+ * is no hit
|
|
+ */
|
|
+ @Nullable RayTraceResult rayTraceEntities(io.papermc.paper.math.@NotNull Position start, @NotNull Vector direction, double maxDistance, double raySize, @Nullable Predicate<? super Entity> filter);
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Performs a ray trace that checks for block collisions using the blocks'
|
|
* precise collision shapes.
|
|
@@ -1749,6 +1770,34 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
|
@Nullable
|
|
public RayTraceResult rayTraceBlocks(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks);
|
|
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Performs a ray trace that checks for block collisions using the blocks'
|
|
+ * precise collision shapes.
|
|
+ * <p>
|
|
+ * If collisions with passable blocks are ignored, fluid collisions are
|
|
+ * ignored as well regardless of the fluid collision mode.
|
|
+ * <p>
|
|
+ * Portal blocks are only considered passable if the ray starts within
|
|
+ * them. Apart from that collisions with portal blocks will be considered
|
|
+ * even if collisions with passable blocks are otherwise ignored.
|
|
+ * <p>
|
|
+ * This may cause loading of chunks! Some implementations may impose
|
|
+ * artificial restrictions on the maximum distance.
|
|
+ *
|
|
+ * @param start the start position
|
|
+ * @param direction the ray direction
|
|
+ * @param maxDistance the maximum distance
|
|
+ * @param fluidCollisionMode the fluid collision mode
|
|
+ * @param ignorePassableBlocks whether to ignore passable but collidable
|
|
+ * blocks (ex. tall grass, signs, fluids, ..)
|
|
+ * @param canCollide predicate for blocks the ray can potentially collide
|
|
+ * with, or <code>null</code> to consider all blocks
|
|
+ * @return the ray trace hit result, or <code>null</code> if there is no hit
|
|
+ */
|
|
+ @Nullable RayTraceResult rayTraceBlocks(io.papermc.paper.math.@NotNull Position start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, @Nullable Predicate<? super Block> canCollide);
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Performs a ray trace that checks for both block and entity collisions.
|
|
* <p>
|
|
@@ -1782,6 +1831,42 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
|
@Nullable
|
|
public RayTraceResult rayTrace(@NotNull Location start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, double raySize, @Nullable Predicate<? super Entity> filter);
|
|
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Performs a ray trace that checks for both block and entity collisions.
|
|
+ * <p>
|
|
+ * Block collisions use the blocks' precise collision shapes. The
|
|
+ * <code>raySize</code> parameter is only taken into account for entity
|
|
+ * collision checks.
|
|
+ * <p>
|
|
+ * If collisions with passable blocks are ignored, fluid collisions are
|
|
+ * ignored as well regardless of the fluid collision mode.
|
|
+ * <p>
|
|
+ * Portal blocks are only considered passable if the ray starts within them.
|
|
+ * Apart from that collisions with portal blocks will be considered even if
|
|
+ * collisions with passable blocks are otherwise ignored.
|
|
+ * <p>
|
|
+ * This may cause loading of chunks! Some implementations may impose
|
|
+ * artificial restrictions on the maximum distance.
|
|
+ *
|
|
+ * @param start the start position
|
|
+ * @param direction the ray direction
|
|
+ * @param maxDistance the maximum distance
|
|
+ * @param fluidCollisionMode the fluid collision mode
|
|
+ * @param ignorePassableBlocks whether to ignore passable but collidable
|
|
+ * blocks (ex. tall grass, signs, fluids, ..)
|
|
+ * @param raySize entity bounding boxes will be uniformly expanded (or
|
|
+ * shrinked) by this value before doing collision checks
|
|
+ * @param filter only entities that fulfill this predicate are considered,
|
|
+ * or <code>null</code> to consider all entities
|
|
+ * @param canCollide predicate for blocks the ray can potentially collide
|
|
+ * with, or <code>null</code> to consider all blocks
|
|
+ * @return the closest ray trace hit result with either a block or an
|
|
+ * entity, or <code>null</code> if there is no hit
|
|
+ */
|
|
+ @Nullable RayTraceResult rayTrace(io.papermc.paper.math.@NotNull Position start, @NotNull Vector direction, double maxDistance, @NotNull FluidCollisionMode fluidCollisionMode, boolean ignorePassableBlocks, double raySize, @Nullable Predicate<? super Entity> filter, @Nullable Predicate<? super Block> canCollide);
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Gets the default spawn {@link Location} of this world
|
|
*
|