com.alpineclient.plugin.api.objects

Class Cooldown

java.lang.Object

com.alpineclient.plugin.api.objects.Cooldown

public final class Cooldown
extends java.lang.Object

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

Since:

1.3.0

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLOR The default color used in Cooldown.Builder.

Method Summary

Modifier and Type	Method and Description
static @NotNull Cooldown.Builder	builder() Begins a new builder of this class.
boolean	equals(java.lang.Object obj)
int	getColor() Get the color of the cooldown.
long	getDuration() Get the duration of the cooldown in milliseconds.
@NotNull java.util.UUID	getId() Get the name of the cooldown.
@NotNull java.lang.String	getName() Get the name of the cooldown.
@NotNull ClientResource	getTexture() Get the texture of the notification.
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 Cooldown.Builder.

Method Detail

getId

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

Get the name of the cooldown.

Returns:

the name

getName

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

Get the name of the cooldown.

Returns:

the name

getColor

public int getColor()

Get the color of the cooldown.

Returns:

the name

getDuration

public long getDuration()

Get the duration of the cooldown in milliseconds.

Returns:

the duration in milliseconds

getTexture

@NotNull
public @NotNull ClientResource getTexture()

Get the texture of the notification.

Returns:

the ClientResource

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 Cooldown.Builder builder()

Begins a new builder of this class.

Returns:

The builder