journeymap.api.v2.client.display

Class Displayable

java.lang.Object

journeymap.api.v2.client.display.Displayable

All Implemented Interfaces:

java.lang.Comparable<Displayable>

Direct Known Subclasses:

Overlay

@ParametersAreNonnullByDefault
public abstract class Displayable
extends java.lang.Object
implements java.lang.Comparable<Displayable>

Base class for Overlays and Waypoints. Mods should not extend this class directly. Use one of the provided implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected DisplayType	displayType
protected java.lang.String	id
protected java.lang.String	modId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Displayable(java.lang.String modId) Constructor with explicit display id.

Method Summary

Modifier and Type	Method and Description
static float	clampOpacity(float opacity) Clamps an rgb int value to the allowable range of 0F-1F.
static int	clampRGB(int rgb) Clamps an rgb int value to the allowable range.
int	compareTo(Displayable o) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o) Equality is based on either reference equality or GUID.
abstract int	getDisplayOrder() Used to determine display order, lower first.
DisplayType	getDisplayType() DisplayType enum for the object.
java.lang.String	getGuid() Dash-delimited GUID for the display object in the form of "modid-displayType-displayId".
java.lang.String	getId() A unique id for the object.
java.lang.String	getModId() Your mod id.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

modId

@Since(value=1.1)
protected final java.lang.String modId

id

@Since(value=1.1)
protected final java.lang.String id

displayType

@Since(value=1.1)
protected final DisplayType displayType

Constructor Detail

Displayable

protected Displayable(java.lang.String modId)

Constructor with explicit display id.

Parameters:

modId - the mod id

Method Detail

clampRGB

public static int clampRGB(int rgb)

Clamps an rgb int value to the allowable range. If an ARGB value is passed in, alpha is masked to FF.

Parameters:

rgb - color

Returns:

clamped color

clampOpacity

public static float clampOpacity(float opacity)

Clamps an rgb int value to the allowable range of 0F-1F.

Parameters:

opacity - opacity

Returns:

clamped opacity

getDisplayOrder

public abstract int getDisplayOrder()

Used to determine display order, lower first.

Returns:

order

getModId

public final java.lang.String getModId()

Your mod id.

Returns:

modId mod id

getId

public final java.lang.String getId()

A unique id for the object. Uniqueness is only needed among instances of the same class.

Returns:

displayId display id

getDisplayType

public final DisplayType getDisplayType()

DisplayType enum for the object.

Returns:

enum value

getGuid

public final java.lang.String getGuid()

Dash-delimited GUID for the display object in the form of "modid-displayType-displayId".

Returns:

the guid

equals

public boolean equals(java.lang.Object o)

Equality is based on either reference equality or GUID.

Overrides:

equals in class java.lang.Object

Parameters:

o - other

Returns:

true if equal

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Displayable o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable<Displayable>

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.NullPointerException - if the specified object is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.