rebar/io.github.pylonmc.rebar.addon/RebarAddon

RebarAddon

interface RebarAddon : Keyed(source)

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

Inheritors

Properties

open val displayName: TranslatableComponent

The name used to represent this addon in the guide and other places.

open val footerName: TranslatableComponent

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

abstract val javaPlugin: JavaPlugin

Must return this

open override val key: NamespacedKey

abstract val languages: Set<Locale>

The set of Locales this addon has translations for.

abstract val material: Material

The material to represent this addon in menus.

suppressAddonNameWarning

@get:JvmName(name = "suppressAddonNameWarning")

open val suppressAddonNameWarning: Boolean

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

@get:JvmName(name = "getTranslatorForAddon")

val RebarAddon.translator: RebarTranslator

Functions

open override fun getKey(): NamespacedKey

open fun key(): @NotNull Key

registerWithRebar

@ApiStatus.NonExtendable

open fun registerWithRebar()

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