Record Class MapTraceResult
java.lang.Object
java.lang.Record
de.pianoman911.mapengine.api.util.MapTraceResult
- Record Components:
viewPos
- the position of where the player would click the displaydisplay
- the display that the player is looking atworldPos
- the position in the world where the player would click the displayclickDistance
- the distance at which the player would click the display
public record MapTraceResult(Vec2i viewPos, IMapDisplay display, org.bukkit.Location worldPos, double clickDistance)
extends Record
Used to hold the result of tracing a map display using
MapEngineApi.traceDisplayInView(Player, int)
.-
Constructor Summary
ConstructorsConstructorDescriptionMapTraceResult
(Vec2i viewPos, IMapDisplay display, org.bukkit.Location worldPos, double clickDistance) Creates an instance of aMapTraceResult
record class. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Returns the value of theclickDistance
record component.display()
Returns the value of thedisplay
record component.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.final String
toString()
Returns a string representation of this record class.viewPos()
Returns the value of theviewPos
record component.org.bukkit.Location
worldPos()
Returns the value of theworldPos
record component.
-
Constructor Details
-
MapTraceResult
public MapTraceResult(Vec2i viewPos, IMapDisplay display, org.bukkit.Location worldPos, double clickDistance) Creates an instance of aMapTraceResult
record class.- Parameters:
viewPos
- the value for theviewPos
record componentdisplay
- the value for thedisplay
record componentworldPos
- the value for theworldPos
record componentclickDistance
- the value for theclickDistance
record component
-
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
viewPos
Returns the value of theviewPos
record component.- Returns:
- the value of the
viewPos
record component
-
display
Returns the value of thedisplay
record component.- Returns:
- the value of the
display
record component
-
worldPos
public org.bukkit.Location worldPos()Returns the value of theworldPos
record component.- Returns:
- the value of the
worldPos
record component
-
clickDistance
public double clickDistance()Returns the value of theclickDistance
record component.- Returns:
- the value of the
clickDistance
record component
-