Record Class MapDecoration

java.lang.Object

java.lang.Record

fr.fidorial.map.MapDecoration

Record Components:

type - what icon to draw, see MapDecorationTypeKeys

x - the column of the center of the icon, 0-128

y - the row of the center of the icon, 0-128

direction - how far the icon is turned, in sixteenths of a turn clockwise, 0-15: 0 upright, a player arrow pointing up (north on a terrain map), 4 pointing right (east), 8 down; see MapManager.directionOf(float)

label - a name written under the icon, or null

public record MapDecoration(TypedKey<MapDecorationType> type, double x, double y, int direction, @Nullable Component label)
extends Record

An icon drawn over a map: a player arrow, a banner flag, a treasure cross...

Positions are in canvas pixels, like MapCanvas: (0, 0) is the top left corner and (64, 64) the center. The client places icons on a grid of half pixels and clamps them to the map. Use MapView.pixelX(double) and MapView.pixelY(double) to place an icon at world coordinates.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
MapDecoration(TypedKey<MapDecorationType> type, double x, double y, int direction, @Nullable Component label)	Creates an instance of a MapDecoration record class.

Method Summary

Modifier and Type	Method	Description
int	direction()	Returns the value of the direction 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.
@Nullable Component	label()	Returns the value of the label record component.
final String	toString()	Returns a string representation of this record class.
TypedKey<MapDecorationType>	type()	Returns the value of the type record component.
double	x()	Returns the value of the x record component.
double	y()	Returns the value of the y record component.

Methods inherited from class Object

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

Constructor Details

MapDecoration

public MapDecoration(TypedKey<MapDecorationType> type,
 double x,
 double y,
 int direction,
 @Nullable Component label)

Creates an instance of a MapDecoration record class.

Parameters:

type - the value for the type record component

x - the value for the x record component

y - the value for the y record component

direction - the value for the direction record component

label - the value for the label 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 the compare method from their corresponding wrapper classes.

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.

type

public TypedKey<MapDecorationType> type()

Returns the value of the type record component.

Returns:

the value of the type record component

x

public double x()

Returns the value of the x record component.

Returns:

the value of the x record component

y

public double y()

Returns the value of the y record component.

Returns:

the value of the y record component

direction

public int direction()

Returns the value of the direction record component.

Returns:

the value of the direction record component

label

public @Nullable Component label()

Returns the value of the label record component.

Returns:

the value of the label record component