pylon-core/io.github.pylonmc.pylon.core.addon/PylonAddon

PylonAddon

interface PylonAddon : Keyed(source)

Welcome to the place where it all begins: the Pylon addon!

Inheritors

Properties

Link copied to clipboard
open val displayName: TranslatableComponent

The name used to represent this addon in the item tooltips. By default, a blue italic pylon.<your-addon-key>.addon translation key.

Link copied to clipboard
abstract val javaPlugin: JavaPlugin

Must return this

Link copied to clipboard
abstract val languages: Set<Locale>

The set of Locales this addon has translations for.

Link copied to clipboard
abstract val material: Material

The material to represent this addon in menus.

Link copied to clipboard
@get:JvmName(name = "suppressAddonNameWarning")
open val suppressAddonNameWarning: Boolean

If you use something besides the default pylon.<your-addon-key>.addon translation key for the addon name, set this to true to suppress warnings about the "missing" key.

Link copied to clipboard
@JvmStatic
@get:JvmName(name = "getTranslatorForAddon")
val PylonAddon.translator: PylonTranslator

Functions

Link copied to clipboard
open override fun getKey(): NamespacedKey
Link copied to clipboard
open override fun key(): @NotNull Key
Link copied to clipboard
@ApiStatus.NonExtendable
open fun registerWithPylon()

Must be called as the first thing in your plugin's onEnable