//project/dev.jaims.mcutils.bukkit/KotlinPlugin

KotlinPlugin

abstract class KotlinPlugin : JavaPlugin

Functions

disable

jvm

Disable logic.

abstract fun disable()

enable

jvm

Code to run in the onEnable block.

abstract fun enable()

equals

jvm

operator override fun equals(other: Any?): Boolean

getClassLoader

jvm

@NotNull()

override fun getClassLoader(): ClassLoader

getCommand

jvm

@Nullable()

open override fun getCommand(@NotNull() p0: String): PluginCommand?

getConfig

jvm

@NotNull()

open override fun getConfig(): FileConfiguration

getDataFolder

jvm

@NotNull()

override fun getDataFolder(): File

getDefaultWorldGenerator

jvm

@Nullable()

open override fun getDefaultWorldGenerator(@NotNull() p0: String, @Nullable() p1: String?): ChunkGenerator?

getDescription

jvm

@NotNull()

override fun getDescription(): PluginDescriptionFile

getFile

jvm

@NotNull()

open override fun getFile(): File

getLogger

jvm

@NotNull()

open override fun getLogger(): Logger

getName

jvm

@NotNull()

override fun getName(): String

getPluginLoader

jvm

@NotNull()

override fun getPluginLoader(): PluginLoader

getResource

jvm

@Nullable()

open override fun getResource(@NotNull() p0: String): InputStream?

getServer

jvm

@NotNull()

override fun getServer(): Server

getSLF4JLogger

jvm

@NotNull()

open override fun getSLF4JLogger(): Logger

getTextResource

jvm

@Nullable()

override fun getTextResource(@NotNull() p0: String): Reader?

hashCode

jvm

override fun hashCode(): Int

init

jvm

override fun init(@NotNull() p0: PluginLoader, @NotNull() p1: Server, @NotNull() p2: PluginDescriptionFile, @NotNull() p3: File, @NotNull() p4: File, @NotNull() p5: ClassLoader)

isEnabled

jvm

override fun isEnabled(): Boolean

isNaggable

jvm

override fun isNaggable(): Boolean

onCommand

jvm

open override fun onCommand(@NotNull() p0: CommandSender, @NotNull() p1: Command, @NotNull() p2: String, @NotNull() p3: Array<String>): Boolean

onDisable

jvm

open override fun onDisable()

onEnable

jvm

We override onEnable to call all of our register methods and then our enable code.

open override fun onEnable()

onLoad

jvm

open override fun onLoad()

onTabComplete

jvm

@Nullable()

open override fun onTabComplete(@NotNull() p0: CommandSender, @NotNull() p1: Command, @NotNull() p2: String, @NotNull() p3: Array<String>): MutableList<String>?

registerCommands

jvm

Code to register commands.

abstract fun registerCommands()

registerListeners

jvm

Code the register all the plugins listeners.

abstract fun registerListeners()

registerManagers

jvm

Code to register all managers/api things.

abstract fun registerManagers()

reloadConfig

jvm

open override fun reloadConfig()

saveConfig

jvm

open override fun saveConfig()

saveDefaultConfig

jvm

open override fun saveDefaultConfig()

saveResource

jvm

open override fun saveResource(@NotNull() p0: String, p1: Boolean)

setEnabled

jvm

override fun setEnabled(p0: Boolean)

setNaggable

jvm

override fun setNaggable(p0: Boolean)

toString

jvm

@NotNull()

open override fun toString(): String

Properties

classLoader

jvm

override val classLoader: ClassLoader

configFile

jvm

override val configFile: File

dataFolder

jvm

override val dataFolder: File

description

jvm

override val description: PluginDescriptionFile

file

jvm

override val file: File

isEnabled

jvm

override val isEnabled: Boolean

loader

jvm

override val loader: PluginLoader

logger

jvm

override val logger: Logger

naggable

jvm

override val naggable: Boolean

newConfig

jvm

override val newConfig: FileConfiguration

server

jvm

override val server: Server

Extensions

listenForEvent

jvm

Listen for an event as long as this plugin is Enabled. The predicate is optional. It can be nice for quick events, but it also default to true to allow for customization. You can also set ignoreCancelled and priority When this is detected, if the predicate is matched, the action is run

inline fun <T : Event> KotlinPlugin.listenForEvent(ignoreCancelled: Boolean, priority: EventPriority, crossinline predicate: (T) -> Boolean, crossinline action: (T) -> Unit)

waitForEvent

jvm

Wait for an event to occur, then unregister it on a timeout or when the event occurs once. Useful for listening to chat messages for example.

inline fun <T : Event> KotlinPlugin.waitForEvent(timeoutTicks: Long, ignoreCancelled: Boolean, priority: EventPriority, crossinline predicate: (T) -> Boolean, crossinline timeoutAction: () -> Unit, crossinline action: (T) -> Unit)