Package de.pianoman911.mapengine.api.util

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 display

display - the display that the player is looking at

worldPos - the position in the world where the player would click the display

clickDistance - 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

Constructors

Constructor	Description
MapTraceResult(Vec2i viewPos, IMapDisplay display, org.bukkit.Location worldPos, double clickDistance)	Creates an instance of a MapTraceResult record class.

Method Summary

Modifier and Type	Method	Description
double	clickDistance()	Returns the value of the clickDistance record component.
IMapDisplay	display()	Returns the value of the display record component.
final boolean	equals(Object o)	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.
Vec2i	viewPos()	Returns the value of the viewPos record component.
org.bukkit.Location	worldPos()	Returns the value of the worldPos record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MapTraceResult

public MapTraceResult(Vec2i viewPos,
 IMapDisplay display,
 org.bukkit.Location worldPos,
 double clickDistance)

Creates an instance of a MapTraceResult record class.

Parameters:

viewPos - the value for the viewPos record component

display - the value for the display record component

worldPos - the value for the worldPos record component

clickDistance - the value for the clickDistance record component

Method Details

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

viewPos

public Vec2i viewPos()

Returns the value of the viewPos record component.

Returns:

the value of the viewPos record component

display

public IMapDisplay display()

Returns the value of the display record component.

Returns:

the value of the display record component

worldPos

public org.bukkit.Location worldPos()

Returns the value of the worldPos record component.

Returns:

the value of the worldPos record component

clickDistance

public double clickDistance()

Returns the value of the clickDistance record component.

Returns:

the value of the clickDistance record component