OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-30 16:19:03 +01:00
Code Issues Projects Releases Packages Wiki Activity

#937: Minor improvements to World#rayTrace documentation

Browse source 
By: Jishuna <joshl5324@gmail.com>
This commit is contained in:
Bukkit/Spigot 2023-11-16 15:36:28 +13:00
parent 72d2572304
commit 44cbcb80d4
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
paper-api/src/main/java/org/bukkit/World.java
View file

@ -680,6 +680,9 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
* This may not consider entities in currently unloaded chunks. Some * This may not consider entities in currently unloaded chunks. Some
* implementations may impose artificial restrictions on the maximum * implementations may impose artificial restrictions on the maximum
* distance. * distance.
* <p>
* <b>Note:</b> Due to display entities having a zero size hitbox, this method will not detect them.
* To detect display entities use {@link #rayTraceEntities(Location, Vector, double, double)} with a positive raySize
* *
* @param start the start position * @param start the start position
* @param direction the ray direction * @param direction the ray direction
@ -702,7 +705,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
* @param direction the ray direction * @param direction the ray direction
* @param maxDistance the maximum distance * @param maxDistance the maximum distance
* @param raySize entity bounding boxes will be uniformly expanded (or * @param raySize entity bounding boxes will be uniformly expanded (or
* shrinked) by this value before doing collision checks * shrunk) by this value before doing collision checks
* @return the closest ray trace hit result, or <code>null</code> if there * @return the closest ray trace hit result, or <code>null</code> if there
* is no hit * is no hit
* @see #rayTraceEntities(Location, Vector, double, double, Predicate) * @see #rayTraceEntities(Location, Vector, double, double, Predicate)
@ -716,6 +719,9 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
* This may not consider entities in currently unloaded chunks. Some * This may not consider entities in currently unloaded chunks. Some
* implementations may impose artificial restrictions on the maximum * implementations may impose artificial restrictions on the maximum
* distance. * distance.
* <p>
* <b>Note:</b> Due to display entities having a zero size hitbox, this method will not detect them.
* To detect display entities use {@link #rayTraceEntities(Location, Vector, double, double, Predicate)} with a positive raySize
* *
* @param start the start position * @param start the start position
* @param direction the ray direction * @param direction the ray direction
@ -740,7 +746,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
* @param direction the ray direction * @param direction the ray direction
* @param maxDistance the maximum distance * @param maxDistance the maximum distance
* @param raySize entity bounding boxes will be uniformly expanded (or * @param raySize entity bounding boxes will be uniformly expanded (or
* shrinked) by this value before doing collision checks * shrunk) by this value before doing collision checks
* @param filter only entities that fulfill this predicate are considered, * @param filter only entities that fulfill this predicate are considered,
* or <code>null</code> to consider all entities * or <code>null</code> to consider all entities
* @return the closest ray trace hit result, or <code>null</code> if there * @return the closest ray trace hit result, or <code>null</code> if there
@ -836,7 +842,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
* @param ignorePassableBlocks whether to ignore passable but collidable * @param ignorePassableBlocks whether to ignore passable but collidable
* blocks (ex. tall grass, signs, fluids, ..) * blocks (ex. tall grass, signs, fluids, ..)
* @param raySize entity bounding boxes will be uniformly expanded (or * @param raySize entity bounding boxes will be uniformly expanded (or
* shrinked) by this value before doing collision checks * shrunk) by this value before doing collision checks
* @param filter only entities that fulfill this predicate are considered, * @param filter only entities that fulfill this predicate are considered,
* or <code>null</code> to consider all entities * or <code>null</code> to consider all entities
* @return the closest ray trace hit result with either a block or an * @return the closest ray trace hit result with either a block or an