UnderscoreEnchantsAPI/com.roughlyunderscore.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@Since(version = "2.2")

annotation class Beta

This annotation is used to mark an items that are not yet confirmed to be stable and production-ready to the fullest extent.

MarkedForRemoval

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@Since(version = "2.2")

annotation class MarkedForRemoval

This annotation is used to mark an items that are marked for removal in the next major release. It is used to discourage the use of the item, and to give a warning to the developer.

Since

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

@Since(version = "2.2")

annotation class Since(val version: String = "")

This annotation is used to mark a class, function, property or field as being available since a given version.

Stable

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@Since(version = "2.2")

annotation class Stable

This annotation is used to mark an item as stable and ready for production use.

Undiscovered

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

@Since(version = "2.2")

annotation class Undiscovered

This annotation is used to indicate that a Registrable loaded in an enchantment has not been discovered in the registry. This may happen when an enchantment is loaded but some Registrable item that it uses is provided by another plugin that is not loaded yet. The annotation is used internally to mark such Registrables and reload the enchantments that have Undiscovered items when receiving UEAPIRegistry.provide.