Overview

Here is an itemized list of the explanations for various badges you will encounter while reading this documentation

Badge Conventions

– Version

This Badge marks in which API release version the function or class was created

Example

1.0.0

– Minecraft Version

This Badge marks the minimum supported Minecraft function

Example

1.19.2

– Minecraft Mapping

This Badge marks using which Minecraft mappings the function or class was created in

Example

yarn

– Conversion Safe

This Badge marks if a Registries returned value can be converted to a minecraft Object type such as an Item, Block or BlockEntityType

Example

– Not Conversion Safe

This Badge marks if a Registries returned value can NOT be converted to a minecraft Object type such as an Item, Block or BlockEntityType

Example

Warning

This Badge warns you about important information

Example

This is a warning

– Deprecated since

This Badge marks since which API version a class or function has been Deprecated

Example

1.0.0

Replacement – Deprecated Function's Replacement

This Badge, when clicked on, brings the user to the function replacing the deprecated function it is attached to

Example

Replacement