UnderscoreEnchantsAPI/com.roughlyunderscore.data

Package-level declarations

Types

@Since(version = "2.2")

data class EnchantmentAction(val action: RegistrableAction, val chance: Double, val delay: Time, val target: TargetType, val arguments: List<String>, val conditions: List<EnchantmentCondition>) : Describable<EnchantmentAction>

This class represents an enchantment action, which includes a RegistrableAction, a chance of execution, a delay before execution and the arguments for this action.

EnchantmentCondition

@Since(version = "2.2")

data class EnchantmentCondition(val condition: RegistrableCondition, val negate: Boolean, val target: TargetType, val arguments: List<String>) : Describable<EnchantmentCondition>

This class represents an enchantment condition, which includes a RegistrableCondition, a negation indicator, the target value and arguments, if any.

EnchantmentLevel

@Since(version = "2.2")

data class EnchantmentLevel(val level: Int, val conditions: List<EnchantmentCondition>, val chance: Double, val cooldown: Time, val actions: List<EnchantmentAction>) : Describable<EnchantmentLevel>

This class represents an enchantment level.

EnchantmentObtainmentRestriction

@Since(version = "2.2")

data class EnchantmentObtainmentRestriction(val means: EnchantmentObtainmentMeans, val levels: List<Int>) : Describable<EnchantmentObtainmentRestriction>

This class represents the obtainment limitations for an enchantment.

EnchantmentPack

@Since(version = "2.2")

data class EnchantmentPack(val metadata: EnchantmentPackMetadata, val enchantments: List<RegistrableEnchantment>) : Describable<EnchantmentPack>

This class represents an enchantment pack.

EnchantmentPackMetadata

@Since(version = "2.2")

data class EnchantmentPackMetadata(val name: String, val version: String, val authors: List<String>, val description: List<String>, val website: String?, val worldBlacklist: List<String>, val worldWhitelist: List<String>, val item: Material) : Describable<EnchantmentPackMetadata>

This class contains metadata about an enchantment pack.

EventModifications

@Since(version = "2.2")

class EventModifications(val fieldModifications: Map<Field, Any>?, val methodsToCall: Map<Method, List<Any?>>?)

A list of event modifications. By itself, this class is just a data holder. It is used by RegistrableActions to modify events.

RequiredEnchantment

@Since(version = "2.2")

data class RequiredEnchantment(val enchantmentKey: NamespacedKey, val seekers: List<RegistrableEnchantmentSeeker>, val levels: List<Int>) : Keyed, Describable<RequiredEnchantment>

This object represents an enchantment being required as a part of another enchantment. For example, an enchantment might require the player to have Fire Aspect of any level on the same item, or Sharpness from II to V on the offhand item.

RequiredPlugin

@Since(version = "2.2")

data class RequiredPlugin(val pluginName: String, val displayName: String, val link: String) : Describable<RequiredPlugin>

This object represents a plugin that is required for an enchantment to load. This is used to ensure that the enchantment that depends on some other plugin (e.g. a provider of new actions) is not loaded if the plugin is not present.

TriggerDataHolder

@Since(version = "2.2")

class TriggerDataHolder

This class helps store RegistrableTrigger's event-related data, such as the event class and its data retrieval methods.

UELocale

@Since(version = "2.2")

@Serializable

@Stable

class UELocale(val localeIdentifier: String)

This class serves the purpose of storing all messages used by the plugin. They are loaded from the respective message file. Everything but the locale identifier is nullable, because the plugin will not crash if a message is missing.