Home Commands Examples Getting Started With Scripts Global Keywords

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.property.Rarity;

Enum Constants

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

script.zs
<constant:minecraft:item/rarity:common>
<constant:minecraft:item/rarity:uncommon>
<constant:minecraft:item/rarity:rare>
<constant:minecraft:item/rarity:epic>

Methods

Gets the color of this Rarity

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

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

Properties

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