Package megamek.common.units

Record Class UnitPosition

java.lang.Object

java.lang.Record

megamek.common.units.UnitPosition

public record UnitPosition(Coords position, Set<Coords> secondaryPositions, Facing facing, int elevation, int altitude, int height)
extends Record

Constructor Summary

Constructors

Constructor	Description
UnitPosition(Coords position, Set<Coords> secondaryPositions, Facing facing, int elevation, int altitude, int height)	Unit Position Data Object

Method Summary

Modifier and Type	Method	Description
int	altitude()	Returns the value of the altitude record component.
int	elevation()	Returns the value of the elevation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Facing	facing()	Returns the value of the facing record component.
int	facingAngle()
Collection<Coords>	getCoords()
final int	hashCode()	Returns a hash code value for this object.
int	height()	Returns the value of the height record component.
static UnitPosition	of(List<Coords> coords)
static UnitPosition	of(Coords coords)
static UnitPosition	of(Coords position, int facing)
static UnitPosition	of(Coords position, Facing facing)
static UnitPosition	of(Targetable targetable)
Coords	position()	Returns the value of the position record component.
int	relativeDotProduct(Coords target)	Deprecated, for removal: This API element is subject to removal in a future version.
int	relativeDotProduct(Coords origin, Coords target)
Set<Coords>	secondaryPositions()	Returns the value of the secondaryPositions record component.
final String	toString()	Returns a string representation of this record class.
static UnitPosition	withFacingOf(Targetable targetable, int facing)

Methods inherited from class java.lang.Object

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

Constructor Details

UnitPosition

public UnitPosition(Coords position,
 Set<Coords> secondaryPositions,
 Facing facing,
 int elevation,
 int altitude,
 int height)

Unit Position Data Object

Parameters:

position - unit position using offset coordinates

secondaryPositions - Set of secondary positions of the unit

facing - Facing of the unit, units with no facing are treated as if they were facing north

elevation - current topographical elevation

altitude - current altitude if airborne

height - height of the unit, 0 indexed.

Method Details

of

public static UnitPosition of(Coords coords)

of

public static UnitPosition of(List<Coords> coords)

of

public static UnitPosition of(Coords position,
 int facing)

of

public static UnitPosition of(Coords position,
 Facing facing)

of

public static UnitPosition of(Targetable targetable)

withFacingOf

public static UnitPosition withFacingOf(Targetable targetable,
 int facing)

facingAngle

public int facingAngle()

relativeDotProduct

@Deprecated(since="0.51.0",
            forRemoval=true)
public int relativeDotProduct(Coords target)

Deprecated, for removal: This API element is subject to removal in a future version.

relativeDotProduct

public int relativeDotProduct(Coords origin,
 Coords target)

getCoords

public Collection<Coords> getCoords()

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.

position

public Coords position()

Returns the value of the position record component.

Returns:

the value of the position record component

secondaryPositions

public Set<Coords> secondaryPositions()

Returns the value of the secondaryPositions record component.

Returns:

the value of the secondaryPositions record component

facing

public Facing facing()

Returns the value of the facing record component.

Returns:

the value of the facing record component

elevation

public int elevation()

Returns the value of the elevation record component.

Returns:

the value of the elevation record component

altitude

public int altitude()

Returns the value of the altitude record component.

Returns:

the value of the altitude record component

height

public int height()

Returns the value of the height record component.

Returns:

the value of the height record component