org.pepsoft.worldpainter

Class Dimension.Anchor

java.lang.Object

org.pepsoft.worldpainter.Dimension.Anchor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

Dimension

public static final class Dimension.Anchor
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	dim The game dimension to which this anchor refers.
static Dimension.Anchor	END_DETAIL Convenience constant for the default End dimension (End detail dimension, not inverted, layer zero).
static Dimension.Anchor	END_DETAIL_CEILING Convenience constant for the default End dimension ceiling (End detail dimension, inverted, layer zero).
int	id A unique identifier that identifies this anchor within the same (dim, role, invert) combo.
boolean	invert Whether this anchor should be exported inverted (e.g.
static Dimension.Anchor	NETHER_DETAIL Convenience constant for the default Nether dimension (Nether detail dimension, not inverted, layer zero).
static Dimension.Anchor	NETHER_DETAIL_CEILING Convenience constant for the default Nether dimension ceiling (Nether detail dimension, inverted, layer zero).
static Dimension.Anchor	NORMAL_DETAIL Convenience constant for the default dimension (surface detail dimension, not inverted, layer zero).
static Dimension.Anchor	NORMAL_DETAIL_CEILING Convenience constant for the default dimension ceiling (surface detail dimension, inverted, layer zero).
static Dimension.Anchor	NORMAL_MASTER Convenience constant for the default Master dimension (surface master dimension, not inverted, layer zero).
Dimension.Role	role The role this anchor plays in the specified game dimension.

Constructor Summary

Constructors

Constructor and Description
Anchor(int dim, Dimension.Role role, boolean invert, int id)

Method Summary

Modifier and Type	Method and Description
int	compareTo(@NotNull java.lang.Object o)
boolean	equals(java.lang.Object o)
static Dimension.Anchor	fromString(java.lang.String str) Parse a string previously produced by toString() into a new Anchor instance.
java.lang.String	getDefaultName()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dim

public final int dim

The game dimension to which this anchor refers. See Constants.DIM_NORMAL, Constants.DIM_NETHER and Constants.DIM_END for predefined values. Note that they don't correspond to the dimension numbers in Minecraft.

role

public final Dimension.Role role

The role this anchor plays in the specified game dimension.

invert

public final boolean invert

Whether this anchor should be exported inverted (e.g. as a ceiling).

id

public final int id

A unique identifier that identifies this anchor within the same (dim, role, invert) combo. ID 0 should always exist and be the "main" or "default" anchor. Other values may or may not imply an ordering.

NORMAL_DETAIL

public static final Dimension.Anchor NORMAL_DETAIL

Convenience constant for the default dimension (surface detail dimension, not inverted, layer zero).

NORMAL_MASTER

public static final Dimension.Anchor NORMAL_MASTER

Convenience constant for the default Master dimension (surface master dimension, not inverted, layer zero).

NETHER_DETAIL

public static final Dimension.Anchor NETHER_DETAIL

Convenience constant for the default Nether dimension (Nether detail dimension, not inverted, layer zero).

END_DETAIL

public static final Dimension.Anchor END_DETAIL

Convenience constant for the default End dimension (End detail dimension, not inverted, layer zero).

NORMAL_DETAIL_CEILING

public static final Dimension.Anchor NORMAL_DETAIL_CEILING

Convenience constant for the default dimension ceiling (surface detail dimension, inverted, layer zero).

NETHER_DETAIL_CEILING

public static final Dimension.Anchor NETHER_DETAIL_CEILING

Convenience constant for the default Nether dimension ceiling (Nether detail dimension, inverted, layer zero).

END_DETAIL_CEILING

public static final Dimension.Anchor END_DETAIL_CEILING

Convenience constant for the default End dimension ceiling (End detail dimension, inverted, layer zero).

Constructor Detail

Anchor

public Anchor(int dim,
              Dimension.Role role,
              boolean invert,
              int id)

Method Detail

getDefaultName

public java.lang.String getDefaultName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(@NotNull
                     @NotNull java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

fromString

public static Dimension.Anchor fromString(java.lang.String str)

Parse a string previously produced by toString() into a new Anchor instance.