Rarity 1.1.1-SNAPSHOT API

All Implemented Interfaces:

java.io.Serializable , kotlin.Comparable
```
public enum Rarity
extends Enum<Rarity>
                    
```
Represents a Rarity, applicable to a BattleCard

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Double`	`maxCardExperience`
`private final ChatColor`	`color`
`private final Double`	`experienceModifier`
`private final Integer`	`maxCardLevel`
`private final String`	`name`
`private final Integer`	`ordinal`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BASIC`	Represents the Basic rarity
`COMMON`	Represents the Common rarity
`UNCOMMON`	Represents the Uncommon rarity
`RARE`	Represents the Rare rarity
`EPIC`	Represents the Epic rarity
`LEGEND`	Represents the Legend rarity
`MYTHICAL`	Represents the Mythical rarity
`ULTIMATE`	Represents the Ultimate rarity

Method Summary

Modifier and Type	Method	Description
`String`	`toString()`
`final Rarity`	`valueOf(String value)`	Returns the enum constant of this type with the specified name.
`final Array<Rarity>`	`values()`	Returns an array containing the constants of this enum type, in the order they're declared.
`final Double`	`getMaxCardExperience()`	Fetches the maximum experience a BattleCard can have for this rarity.
`final ChatColor`	`getColor()`	Fetches the color of this rarity.
`final Double`	`getExperienceModifier()`	Fetches the experience modifier for this rarity, which is used to calculate the amount of experience a player needs to increase the Card's Level.
`final Integer`	`getMaxCardLevel()`	Fetches the maximum level a BattleCard can be for this rarity.

Methods inherited from class kotlin.Enum
getName, getOrdinal
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - toString
```
 String toString()
```
  - valueOf
```
 final Rarity valueOf(String value)
```
    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.)
  - values
```
 final Array<Rarity> values()
```
    Returns an array containing the constants of this enum type, in the order they're declared.
    This method may be used to iterate over the constants.
  - getMaxCardExperience
```
 final Double getMaxCardExperience()
```
    Fetches the maximum experience a BattleCard can have for this rarity.
  - getColor
```
 final ChatColor getColor()
```
    Fetches the color of this rarity.
  - getExperienceModifier
```
 final Double getExperienceModifier()
```
    Fetches the experience modifier for this rarity, which is used to calculate the amount of experience a player needs to increase the Card's Level.
  - getMaxCardLevel
```
 final Integer getMaxCardLevel()
```
    Fetches the maximum level a BattleCard can be for this rarity.