RegistrableEnchantment

This interface represents UnderscoreEnchants' registrable enchantments.

At no point should you implement this interface, as it is only used internally by UnderscoreEnchants to register enchantments that are available to the API.

Properties

Link copied to clipboard
@Since(version = "2.2")
abstract val activationChance: Double

The enchantment's activation chance.

Link copied to clipboard

The enchantment's activation indicator.

Link copied to clipboard
@Since(version = "2.2")
abstract val aliases: List<String>

The aliases for this registrable.

Link copied to clipboard
@Since(version = "2.2")
abstract val applicables: List<RegistrableApplicable>

The enchantment's applicables.

Link copied to clipboard
@Since(version = "2.2")
abstract val author: String

The author of the enchantment.

Link copied to clipboard
@Since(version = "2.2")
abstract val conditions: List<EnchantmentCondition>

The enchantment's conditions.

Link copied to clipboard
@Since(version = "2.2")
abstract val conflicts: List<String>

The enchantment's conflicts. Note that this list contains the NamespacedKey's keys of those enchantments with which this enchantment conflicts (e.g., "frost_walker" for "minecraft:frost_walker"). Additionally, The enchantment can still be applied to the same item as any of these enchantments via the API.

Link copied to clipboard
@Since(version = "2.2")
abstract val cooldown: Time

The enchantment's cooldown in ticks.

Link copied to clipboard
@Since(version = "2.2")
abstract val description: List<String>

The description of the enchantment.

Link copied to clipboard

The enchantment seekers that this enchantment uses.

Link copied to clipboard
@Since(version = "2.2")
abstract val forbiddenMaterials: List<Material>

The enchantment's forbidden materials. Note that while it cannot legally be applied to any of these materials (e.g., via an enchanting table), it can still be applied to these materials via the API or commands.

Link copied to clipboard
@Since(version = "2.2")
abstract val levels: List<EnchantmentLevel>

The enchantment's levels.

Link copied to clipboard

The enchantment's obtainment restrictions.

Link copied to clipboard
@Since(version = "2.2")
abstract val requiredEnchantments: List<RequiredEnchantment>

All enchantments required to be present on the player in some way.

Link copied to clipboard
@Since(version = "2.2")
abstract val requiredPlugins: List<RequiredPlugin>

All plugins that are required for this enchantment to load.

Link copied to clipboard
@Since(version = "2.2")
abstract val stackable: Boolean

Whether the enchantment is stackable. If this value is set to true, all actions are repeated the amount of times that the enchantment is found with the seekers.

Link copied to clipboard
@Since(version = "2.2")
abstract val trigger: RegistrableTrigger

The enchantment's trigger.

Link copied to clipboard
@Since(version = "2.2")
abstract val unique: Boolean

Whether the enchantment is unique. Unique enchantments are those that can be the only enchantment applied to an item.

Link copied to clipboard
@Since(version = "2.2")
abstract val worldBlacklist: List<String>

All worlds that are blacklisted for this enchantment.

Link copied to clipboard
@Since(version = "2.2")
abstract val worldWhitelist: List<String>

All worlds that are whitelisted for this enchantment.

Functions

Link copied to clipboard
@Since(version = "2.2")
abstract fun getDescriber(): Describer<RegistrableEnchantment>

Gets the describer for the object.

Link copied to clipboard
@NotNull
abstract fun getKey(): NamespacedKey