com.alpineclient.plugin.api.objects

Class Waypoint

java.lang.Object

com.alpineclient.plugin.api.objects.Waypoint

public final class Waypoint
extends java.lang.Object

Represents a location in the world that is highlighted to the user.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Waypoint.Builder Builder for Waypoint.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLOR The default color used in Waypoint.Builder.
static long	DEFAULT_DURATION The default duration used in Waypoint.Builder.
static java.lang.String	DEFAULT_WORLD The default world name used in Waypoint.Builder.
static long	NO_DURATION The value to be used for any Waypoint intended to last an infinite amount of time.

Method Summary

Modifier and Type	Method and Description
static @NotNull Waypoint.Builder	builder() Begins a new builder of this class.
boolean	equals(java.lang.Object obj)
int	getColor() Get the color of the waypoint.
long	getDuration() Get the duration of the waypoint in milliseconds.
@NotNull java.util.UUID	getId() Get the unique ID of the waypoint.
@NotNull java.lang.String	getName() Get the name of the waypoint.
@NotNull org.bukkit.Location	getPos() Get the position of the waypoint.
@NotNull java.lang.String	getWorld() Get the name of the world that the waypoint is in.
int	hashCode()
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLOR

public static final int DEFAULT_COLOR

The default color used in Waypoint.Builder.

DEFAULT_WORLD

public static final java.lang.String DEFAULT_WORLD

The default world name used in Waypoint.Builder.

See Also:

Constant Field Values

DEFAULT_DURATION

public static final long DEFAULT_DURATION

The default duration used in Waypoint.Builder.

See Also:

Constant Field Values

NO_DURATION

public static final long NO_DURATION

The value to be used for any Waypoint intended to last an infinite amount of time.

See Also:

Constant Field Values

Method Detail

getId

@NotNull
public @NotNull java.util.UUID getId()

Get the unique ID of the waypoint.

Returns:

the UUID

getName

@NotNull
public @NotNull java.lang.String getName()

Get the name of the waypoint.

Returns:

the name

getPos

@NotNull
public @NotNull org.bukkit.Location getPos()

Get the position of the waypoint.

Returns:

the position

getColor

public int getColor()

Get the color of the waypoint.

Returns:

the name

getWorld

@NotNull
public @NotNull java.lang.String getWorld()

Get the name of the world that the waypoint is in.

Returns:

the name of the world

getDuration

public long getDuration()

Get the duration of the waypoint in milliseconds.

Returns:

the duration in milliseconds

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

builder

@NotNull
public static @NotNull Waypoint.Builder builder()

Begins a new builder of this class.

Returns:

the builder