dev.polymodloader.api.stability

Generated

This page is generated from the source's Javadoc by ./gradlew apiReference. Do not edit it; fix the source comment and generate it again.

Type	Kind	Description
ApiStability	annotation	Declares the StabilityLevel of a Poly Mod Loader type.
StabilityLevel	enum	Compatibility promise of a Poly Mod Loader API element (design doc §5.4).

ApiStability

annotation · Stability PREVIEW · Since 0.1.0-alpha.4 or earlier

public @interface ApiStability extends Annotation

Declares the StabilityLevel of a Poly Mod Loader type. The annotation is Documented so the level appears in JavaDoc and IntelliJ quick documentation, and retained at run time so tools such as the API capability inspector can report it.

value()

StabilityLevel value()

Since 0.1.0-alpha.4 or earlier

The stability level of the annotated element.

Returns StabilityLevel

StabilityLevel

enum · Since 0.1.0-alpha.4 or earlier

public enum StabilityLevel

Compatibility promise of a Poly Mod Loader API element (design doc §5.4). Every public type declares one through ApiStability.

Constant	Description
STABLE	Public compatibility policy; breaking changes require an API version bump and migration notes.
PREVIEW	Usable, but the contract may still change. Changes are recorded in the changelog.
VERSION_BOUND	Bound to specific Minecraft versions and reached through a version adapter.
INTERNAL	Used only by Poly Mod Loader's own modules. Mods must not depend on it.
UNSAFE	Low-level behaviour that can crash the game or corrupt world data; requires explicit opt-in.