rebar/io.github.pylonmc.rebar/Rebar

Rebar

object Rebar : JavaPlugin, RebarAddon(source)

The one and only Rebar plugin!

Properties

componentLogger

@get:NotNull

open val componentLogger: @NotNull ComponentLogger

open val config: FileConfiguration

val dataFolder: File

@get:NotNull

open val dataPath: @NotNull Path

val description: PluginDescriptionFile

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.

var isEnabled: Boolean

var isNaggable: Boolean

open override val javaPlugin: Rebar

Must return this

open override val key: NamespacedKey

open override val languages: Set<Locale>

The set of Locales this addon has translations for.

lifecycleManager

val lifecycleManager: LifecycleEventManager<Plugin>

@get:NotNull

open val log4JLogger: @NotNull Logger

open val logger: Logger

mainThreadDispatcher

val mainThreadDispatcher: BukkitMainThreadDispatcher

Ticks once per tick

open override val material: Material

The material to represent this addon in menus.

@get:NotNull

val name: @NotNull String

val pluginLoader: PluginLoader

val pluginMeta: PluginMeta

val scope: CoroutineScope

By default, dispatches on the main thread

val server: Server

@get:NotNull

open val slF4JLogger: @NotNull Logger

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 fun getCommand(name: String): @Nullable PluginCommand?

getDefaultBiomeProvider

open fun getDefaultBiomeProvider(worldName: String, id: @Nullable String?): @Nullable BiomeProvider?

getDefaultWorldGenerator

open fun getDefaultWorldGenerator(worldName: String, id: @Nullable String?): @Nullable ChunkGenerator?

open override fun getKey(): NamespacedKey

open fun getResource(filename: String): @Nullable InputStream?

fun init(loader: PluginLoader, server: Server, description: PluginDescriptionFile, dataFolder: File, file: File, classLoader: ClassLoader)

fun init(server: Server, description: PluginDescriptionFile, dataFolder: File, file: File, classLoader: ClassLoader, configuration: @Nullable PluginMeta?, logger: Logger)

open fun key(): @NotNull Key

@NotNull

open fun namespace(): @NotNull String

open fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean

open override fun onDisable()

open override fun onEnable()

open fun onLoad()

open fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: Array<out String>): @Nullable List<String>??

registerCommand

open fun registerCommand(label: String, basicCommand: BasicCommand)

open fun registerCommand(label: String, description: @Nullable String?, basicCommand: BasicCommand)

open fun registerCommand(label: String, aliases: Collection<String>, basicCommand: BasicCommand)

open fun registerCommand(label: String, description: @Nullable String?, aliases: Collection<String>, basicCommand: BasicCommand)

registerWithRebar

@ApiStatus.NonExtendable

open fun registerWithRebar()

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

open fun reloadConfig()

open fun saveConfig()

saveDefaultConfig

open fun saveDefaultConfig()

open fun saveResource(resourcePath: String, replace: Boolean)