Package org.bukkit.util
Class RayTraceResult
java.lang.Object
org.bukkit.util.RayTraceResult
The hit result of a ray trace.
Only the hit position is guaranteed to always be available. The availability of the other attributes depends on what got hit and on the context in which the ray trace was performed.
-
Constructor Summary
ConstructorDescriptionRayTraceResult
(@NotNull Vector hitPosition) Creates a RayTraceResult.RayTraceResult
(@NotNull Vector hitPosition, @Nullable BlockFace hitBlockFace) Creates a RayTraceResult.RayTraceResult
(@NotNull Vector hitPosition, @Nullable Block hitBlock, @Nullable BlockFace hitBlockFace) Creates a RayTraceResult.RayTraceResult
(@NotNull Vector hitPosition, @Nullable Entity hitEntity) Creates a RayTraceResult.RayTraceResult
(@NotNull Vector hitPosition, @Nullable Entity hitEntity, @Nullable BlockFace hitBlockFace) Creates a RayTraceResult. -
Method Summary
-
Constructor Details
-
RayTraceResult
Creates a RayTraceResult.- Parameters:
hitPosition
- the hit position
-
RayTraceResult
public RayTraceResult(@NotNull @NotNull Vector hitPosition, @Nullable @Nullable BlockFace hitBlockFace) Creates a RayTraceResult.- Parameters:
hitPosition
- the hit positionhitBlockFace
- the hit block face
-
RayTraceResult
public RayTraceResult(@NotNull @NotNull Vector hitPosition, @Nullable @Nullable Block hitBlock, @Nullable @Nullable BlockFace hitBlockFace) Creates a RayTraceResult.- Parameters:
hitPosition
- the hit positionhitBlock
- the hit blockhitBlockFace
- the hit block face
-
RayTraceResult
Creates a RayTraceResult.- Parameters:
hitPosition
- the hit positionhitEntity
- the hit entity
-
RayTraceResult
public RayTraceResult(@NotNull @NotNull Vector hitPosition, @Nullable @Nullable Entity hitEntity, @Nullable @Nullable BlockFace hitBlockFace) Creates a RayTraceResult.- Parameters:
hitPosition
- the hit positionhitEntity
- the hit entityhitBlockFace
- the hit block face
-
-
Method Details
-
getHitPosition
Gets the exact position of the hit.- Returns:
- a copy of the exact hit position
-
getHitBlock
Gets the hit block.- Returns:
- the hit block, or
null
if not available
-
getHitBlockFace
Gets the hit block face.- Returns:
- the hit block face, or
null
if not available
-
getHitEntity
Gets the hit entity.- Returns:
- the hit entity, or
null
if not available
-
hashCode
public int hashCode() -
equals
-
toString
-