Package org.strassburger.cookieclickerz.util.cookieevents

Enum Class CookieEventType

java.lang.Object

java.lang.Enum<CookieEventType>

org.strassburger.cookieclickerz.util.cookieevents.CookieEventType

All Implemented Interfaces:

Serializable, Comparable<CookieEventType>, java.lang.constant.Constable

public enum CookieEventType
extends Enum<CookieEventType>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLICK_FRENZY
COOKIE_FRENZY
CURSED_FINGER
LUCKY
RUIN

Method Summary

Modifier and Type	Method	Description
double	getAppearanceRate()
long	getDuration()
String	getId()
static @Nullable CookieEventType	getRandom()	Get a random CookieEventType based on appearance rates or null if no event should happen.
boolean	isInstant()
boolean	isPositive()
abstract void	run(CookieClickerZ plugin, UUID uuid)
static CookieEventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CookieEventType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COOKIE_FRENZY

public static final CookieEventType COOKIE_FRENZY

LUCKY

public static final CookieEventType LUCKY

CLICK_FRENZY

public static final CookieEventType CLICK_FRENZY

RUIN

public static final CookieEventType RUIN

CURSED_FINGER

public static final CookieEventType CURSED_FINGER

Method Details

values

public static CookieEventType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CookieEventType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public String getId()

Returns:

the id of the event

isPositive

public boolean isPositive()

Returns:

true if the event is positive, false otherwise

getAppearanceRate

public double getAppearanceRate()

Returns:

appearance rate of the event

getDuration

public long getDuration()

Returns:

duration of the event in ticks (0 if the event is instant)

isInstant

public boolean isInstant()

Returns:

true if the event is instant, false otherwise

run

public abstract void run(CookieClickerZ plugin,
 UUID uuid)

getRandom

@Nullable
public static @Nullable CookieEventType getRandom()

Get a random CookieEventType based on appearance rates or null if no event should happen.

Returns:

a random CookieEventType or null