ColosseumPlugin

abstract class ColosseumPlugin : JavaPlugin

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The logger for the plugin. Used to log messages to the console.

Link copied to clipboard

The command registrant for the plugin. Used to register commands.

Link copied to clipboard
@get:NotNull
open val componentLogger: @NotNull ComponentLogger
Link copied to clipboard
open val config: FileConfiguration
Link copied to clipboard
Link copied to clipboard
@get:NotNull
open val dataPath: @NotNull Path
Link copied to clipboard
val description: PluginDescriptionFile
Link copied to clipboard
val gson: Gson

The singleton GSON instance for the plugin.

Link copied to clipboard
Link copied to clipboard
@set:ApiStatus.Internal
var isEnabled: Boolean
Link copied to clipboard
Link copied to clipboard
val lifecycleManager: LifecycleEventManager<Plugin>
Link copied to clipboard
@get:NotNull
open val log4JLogger: @NotNull Logger
Link copied to clipboard
open override val logger: Logger
Link copied to clipboard

The message formatter for the plugin. Used to format messages with the plugin prefix.

Link copied to clipboard
@get:NotNull
val name: @NotNull String
Link copied to clipboard
val pluginLoader: PluginLoader
Link copied to clipboard
val pluginMeta: PluginMeta
Link copied to clipboard

The scheduler for the plugin. Used to run tasks asynchronously or synchronously.

Link copied to clipboard
val server: Server
Link copied to clipboard

The Minecraft server revision the plugin is running on.

Link copied to clipboard

The Minecraft server version the plugin is running on.

Link copied to clipboard
@get:NotNull
open val slF4JLogger: @NotNull Logger

Functions

Link copied to clipboard

Builds the i18n manager for the plugin. If the i18n manager is already built, it returns the existing instance. This should be called during plugin initialization.

Link copied to clipboard
fun checkForUpdates(repo: String, consumer: (String) -> Unit)

Checks for updates for the plugin on GitHub.

Link copied to clipboard
open fun getCommand(name: String): @Nullable PluginCommand?
Link copied to clipboard
open fun getDefaultBiomeProvider(worldName: String, id: @Nullable String?): @Nullable BiomeProvider?
Link copied to clipboard
open fun getDefaultWorldGenerator(worldName: String, id: @Nullable String?): @Nullable ChunkGenerator?
Link copied to clipboard
open override fun getLogger(): Logger

The logger for the plugin.

Link copied to clipboard
open fun getResource(filename: String): @Nullable InputStream?
Link copied to clipboard
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)
Link copied to clipboard
@NotNull
open fun namespace(): @NotNull String
Link copied to clipboard
open fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean
Link copied to clipboard
open fun onDisable()
Link copied to clipboard
open fun onEnable()
Link copied to clipboard
open fun onLoad()
Link copied to clipboard
open fun onTabComplete(sender: CommandSender, command: Command, alias: String, args: Array<out String>): @Nullable List<String>??
Link copied to clipboard
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)
Link copied to clipboard

Registers commands for the plugin. This should be called during plugin initialization.

Link copied to clipboard
open fun reloadConfig()
Link copied to clipboard
open fun saveConfig()
Link copied to clipboard
Link copied to clipboard
open fun saveResource(resourcePath: String, replace: Boolean)