KSpigot

This is the main instance of kSpigot.

This class replaces (and inherits from) the JavaPlugin class. Your main plugin class should inherit from this abstract class.

Instead of overriding onLoad(), onEnable() and onDisable()override:

  • load() (called first)

  • startup() (called second)

  • shutdown() (called in the "end")

abstract class KSpigot : JavaPlugin

Constructors

KSpigot
Link copied to clipboard
fun KSpigot()

Functions

equals
Link copied to clipboard
operator override fun equals(other: Any?): Boolean
getClassLoader
Link copied to clipboard
@NotNull()
override fun getClassLoader(): ClassLoader
getCommand
Link copied to clipboard
@Nullable()
open override fun getCommand(@NotNull() p0: String): PluginCommand?
getConfig
Link copied to clipboard
@NotNull()
open override fun getConfig(): FileConfiguration
getDataFolder
Link copied to clipboard
@NotNull()
override fun getDataFolder(): File
getDefaultWorldGenerator
Link copied to clipboard
@Nullable()
open override fun getDefaultWorldGenerator(@NotNull() p0: String, @Nullable() p1: String?): ChunkGenerator?
getDescription
Link copied to clipboard
@NotNull()
override fun getDescription(): PluginDescriptionFile
getFile
Link copied to clipboard
@NotNull()
open override fun getFile(): File
getLogger
Link copied to clipboard
@NotNull()
open override fun getLogger(): Logger
getName
Link copied to clipboard
@NotNull()
override fun getName(): String
getPluginLoader
Link copied to clipboard
@NotNull()
override fun getPluginLoader(): PluginLoader
getResource
Link copied to clipboard
@Nullable()
open override fun getResource(@NotNull() p0: String): InputStream?
getServer
Link copied to clipboard
@NotNull()
override fun getServer(): Server
getTextResource
Link copied to clipboard
@Nullable()
override fun getTextResource(@NotNull() p0: String): Reader?
hashCode
Link copied to clipboard
override fun hashCode(): Int
init
Link copied to clipboard
override fun init(@NotNull() p0: PluginLoader, @NotNull() p1: Server, @NotNull() p2: PluginDescriptionFile, @NotNull() p3: File, @NotNull() p4: File, @NotNull() p5: ClassLoader)
isEnabled
Link copied to clipboard
override fun isEnabled(): Boolean
isNaggable
Link copied to clipboard
override fun isNaggable(): Boolean
load
Link copied to clipboard

Called when the plugin was loaded

open fun load()
onCommand
Link copied to clipboard
open override fun onCommand(@NotNull() p0: CommandSender, @NotNull() p1: Command, @NotNull() p2: String, @NotNull() p3: Array<String>): Boolean
onDisable
Link copied to clipboard
override fun onDisable()
onEnable
Link copied to clipboard
override fun onEnable()
onLoad
Link copied to clipboard
override fun onLoad()
onTabComplete
Link copied to clipboard
@Nullable()
open override fun onTabComplete(@NotNull() p0: CommandSender, @NotNull() p1: Command, @NotNull() p2: String, @NotNull() p3: Array<String>): MutableList<String>?
reloadConfig
Link copied to clipboard
open override fun reloadConfig()
saveConfig
Link copied to clipboard
open override fun saveConfig()
saveDefaultConfig
Link copied to clipboard
open override fun saveDefaultConfig()
saveResource
Link copied to clipboard
open override fun saveResource(@NotNull() p0: String, p1: Boolean)
setEnabled
Link copied to clipboard
override fun setEnabled(p0: Boolean)
setNaggable
Link copied to clipboard
override fun setNaggable(p0: Boolean)
shutdown
Link copied to clipboard

Called when the plugin gets disabled

open fun shutdown()
startup
Link copied to clipboard

Called when the plugin was enabled

open fun startup()
toString
Link copied to clipboard
@NotNull()
open override fun toString(): String

Properties

classLoader
Link copied to clipboard
override val classLoader: ClassLoader
configFile
Link copied to clipboard
override val configFile: File
dataFolder
Link copied to clipboard
override val dataFolder: File
description
Link copied to clipboard
override val description: PluginDescriptionFile
file
Link copied to clipboard
override val file: File
inventoryGUIHolder
Link copied to clipboard
val inventoryGUIHolder: InventoryGUIHolder
isEnabled
Link copied to clipboard
override val isEnabled: Boolean
kRunnableHolder
Link copied to clipboard
val kRunnableHolder: KRunnableHolder
loader
Link copied to clipboard
override val loader: PluginLoader
logger
Link copied to clipboard
override val logger: PluginLogger
naggable
Link copied to clipboard
override val naggable: Boolean
newConfig
Link copied to clipboard
override val newConfig: FileConfiguration
server
Link copied to clipboard
override val server: Server

Extensions

inventoryGUI
Link copied to clipboard
inline fun <T : ForInventory> KSpigot.inventoryGUI(type: InventoryType<T>, builder: InventoryGUIBuilder<T>.() -> Unit): InventoryGUIShared<T>
task
Link copied to clipboard

Starts a new BukkitRunnable.

fun KSpigot.task(sync: Boolean, delay: Long, period: Long?, howOften: Long?, safe: Boolean, endCallback: () -> Unit?, runnable: (KSpigotRunnable) -> Unit?)