eu.wauz.wauzcore.mobs.pets

Enum WauzPetRarity

java.lang.Object

java.lang.Enum<WauzPetRarity>

eu.wauz.wauzcore.mobs.pets.WauzPetRarity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WauzPetRarity>

public enum WauzPetRarity
extends java.lang.Enum<WauzPetRarity>

The rarity of a pet, containing name, color and max stat multiplier.

Author:

Wauzmons

Enum Constant Summary

Enum Constants

Enum Constant and Description
EPIC The fourth rarity for pets "Epic", in dark purple, with max stat a multiplier of 4.
MAGIC The second rarity for pets "Magic", in blue, with a max stat multiplier of 2.
NORMAL The first rarity for pets "Normal", in green, with a max stat multiplier of 1.
RARE The third rarity for pets "Rare", in gold, with a max stat multiplier of 3.
UNIQUE The fifth rarity for pets "Unique", in dark red, with a max stat multiplier of 5.

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.ChatColor	color The color of the pet rarity.
private org.bukkit.Material	material The spawn egg material of the pet rarity.
private int	multiplier The max stat multiplier of the pet rarity.
private java.lang.String	name The name of the pet rarity.
private java.lang.String	rarityStars The stars of the pet rarity.

Method Summary

Modifier and Type	Method and Description
static WauzPetRarity	determineRarity(org.bukkit.inventory.ItemStack itemStack) Determines the pet rarity of the given item stack's material.
org.bukkit.ChatColor	getColor()
org.bukkit.Material	getMaterial()
int	getMultiplier()
java.lang.String	getName()
java.lang.String	getStars()
static WauzPetRarity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WauzPetRarity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final WauzPetRarity NORMAL

The first rarity for pets "Normal", in green, with a max stat multiplier of 1.

MAGIC

public static final WauzPetRarity MAGIC

The second rarity for pets "Magic", in blue, with a max stat multiplier of 2.

RARE

public static final WauzPetRarity RARE

The third rarity for pets "Rare", in gold, with a max stat multiplier of 3.

EPIC

public static final WauzPetRarity EPIC

The fourth rarity for pets "Epic", in dark purple, with max stat a multiplier of 4.

UNIQUE

public static final WauzPetRarity UNIQUE

The fifth rarity for pets "Unique", in dark red, with a max stat multiplier of 5.

Field Detail

name

private final java.lang.String name

The name of the pet rarity.

multiplier

private final int multiplier

The max stat multiplier of the pet rarity. Also acts as star count.

rarityStars

private final java.lang.String rarityStars

The stars of the pet rarity.

color

private final org.bukkit.ChatColor color

The color of the pet rarity.

material

private final org.bukkit.Material material

The spawn egg material of the pet rarity.

Method Detail

values

public static WauzPetRarity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WauzPetRarity c : WauzPetRarity.values())
    System.out.println(c);

Returns:

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

valueOf

public static WauzPetRarity valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

determineRarity

public static WauzPetRarity determineRarity(org.bukkit.inventory.ItemStack itemStack)

Determines the pet rarity of the given item stack's material.

Parameters:

itemStack - The item stack to get the rarity of.

Returns:

The rarity. Returns the lowest rarity when the material is unknown.

getName

public java.lang.String getName()

Returns:

The name of the pet rarity.

getMultiplier

public int getMultiplier()

Returns:

The max stat multiplier of the pet rarity. Also acts as star count.

getStars

public java.lang.String getStars()

Returns:

The stars of the pet rarity.

getColor

public org.bukkit.ChatColor getColor()

Returns:

The color of the pet rarity.

getMaterial

public org.bukkit.Material getMaterial()

Returns:

The spawn egg material of the pet rarity.