Package me.gamercoder215.starcosmetics.api.cosmetics.particle

Enum Class ParticleReducer

java.lang.Object

java.lang.Enum<ParticleReducer>

me.gamercoder215.starcosmetics.api.cosmetics.particle.ParticleReducer

All Implemented Interfaces:

Serializable, Comparable<ParticleReducer>, Constable

public enum ParticleReducer
extends Enum<ParticleReducer>

Represents a modifier applied to the amount of Particles used in a shape.

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
HIGH	High reduction (divide/multiply by 5)
MAXIMUM	Maximum reduction (divide/multiply by 10)
MINIMAL	Minimal reduction (divide/multiply by 2)
MODERATE	Moderate reduction (divide/multiply by 3)
NORMAL	No reduction (divide/multiply by 1)
VERY_HIGH	Very high reduction (divide/multiply by 7)

Method Summary

Modifier and Type	Method	Description
int	getModifier()	Fetches the divider used to reduce the particle count.
static ParticleReducer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParticleReducer[]	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

NORMAL

public static final ParticleReducer NORMAL

No reduction (divide/multiply by 1)

MINIMAL

public static final ParticleReducer MINIMAL

Minimal reduction (divide/multiply by 2)

MODERATE

public static final ParticleReducer MODERATE

Moderate reduction (divide/multiply by 3)

HIGH

public static final ParticleReducer HIGH

High reduction (divide/multiply by 5)

VERY_HIGH

public static final ParticleReducer VERY_HIGH

Very high reduction (divide/multiply by 7)

MAXIMUM

public static final ParticleReducer MAXIMUM

Maximum reduction (divide/multiply by 10)

Method Details

values

public static ParticleReducer[] 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 ParticleReducer 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

getModifier

public int getModifier()

Fetches the divider used to reduce the particle count.

Returns:

Divider of this ParticleReducer