Home Migration Guide Getting Started With Scripts Commands Examples
BracketHandlers

Rarity

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.api.item.Rarity;

Enum Constants

Rarity is an enum. It has 4 enum constants. They are accessible using the code below.

script.zs
Rarity.COMMON
Rarity.UNCOMMON
Rarity.RARE
Rarity.EPIC

Static Methods

Creates a new Rarity with the given name and given color.

Returns: A new Rarity with the given name and color
Return Type: Rarity

script.zs
// Rarity.create(name as string, formatting as TextFormatting) as Rarity
Rarity.create("insanely_epic", <formatting:obfucated>);
ParameterTypeDescription
Parameter
name
Type
string
Description
The name of the new Rarity.
Parameter
formatting
Type
TextFormatting
Description
The color of the rarity.

Methods

Gets the color of this Rarity

Returns: The color of this Rarity.
Return Type: TextFormatting

script.zs
// Rarity.color() as TextFormatting
myRarity.color();

Properties

NameTypeHas GetterHas SetterDescription
Name
color
Type
TextFormatting
Has Getter
true
Has Setter
false
Description
Gets the color of this Rarity