Files
KSpigot/docs/-k-spigot/net.axay.kspigot.main/-k-spigot/index.md
bluefireoly 69b2e6cd17 Updated docs
2020-10-16 02:13:42 +02:00

15 KiB

title
title
KSpigot -

//KSpigot/net.axay.kspigot.main/KSpigot

KSpigot

[jvm]

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

Name Summary
KSpigot [jvm] fun KSpigot()

Functions

Name Summary
equals [jvm]
Content
operator override fun equals(other: Any?): Boolean


getClassLoader [jvm]
Content
@NotNull()

override fun getClassLoader(): ClassLoader


getCommand [jvm]
Content
@Nullable()

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


getConfig [jvm]
Content
@NotNull()

open override fun getConfig(): FileConfiguration


getDataFolder [jvm]
Content
@NotNull()

override fun getDataFolder(): File


getDefaultWorldGenerator [jvm]
Content
@Nullable()

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


getDescription [jvm]
Content
@NotNull()

override fun getDescription(): PluginDescriptionFile


getFile [jvm]
Content
@NotNull()

open override fun getFile(): File


getLogger [jvm]
Content
@NotNull()

open override fun getLogger(): Logger


getName [jvm]
Content
@NotNull()

override fun getName(): String


getPluginLoader [jvm]
Content
@NotNull()

override fun getPluginLoader(): PluginLoader


getResource [jvm]
Content
@Nullable()

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


getServer [jvm]
Content
@NotNull()

override fun getServer(): Server


getTextResource [jvm]
Content
@Nullable()

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


hashCode [jvm]
Content
override fun hashCode(): Int


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


isEnabled [jvm]
Content
override fun isEnabled(): Boolean


isNaggable [jvm]
Content
override fun isNaggable(): Boolean


load [jvm]
Brief description


Called when the plugin was loaded


Content
open fun load()


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


onDisable [jvm]
Content
override fun onDisable()


onEnable [jvm]
Content
override fun onEnable()


onLoad [jvm]
Content
override fun onLoad()


onTabComplete [jvm]
Content
@Nullable()

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


reloadConfig [jvm]
Content
open override fun reloadConfig()


saveConfig [jvm]
Content
open override fun saveConfig()


saveDefaultConfig [jvm]
Content
open override fun saveDefaultConfig()


saveResource [jvm]
Content
open override fun saveResource(@NotNull()p0: String, p1: Boolean)


setEnabled [jvm]
Content
override fun setEnabled(p0: Boolean)


setNaggable [jvm]
Content
override fun setNaggable(p0: Boolean)


shutdown [jvm]
Brief description


Called when the plugin gets disabled


Content
open fun shutdown()


startup [jvm]
Brief description


Called when the plugin was enabled


Content
open fun startup()


toString [jvm]
Content
@NotNull()

open override fun toString(): String


Properties

Name Summary
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: PluginLogger
naggable [jvm] override val naggable: Boolean
newConfig [jvm] override val newConfig: FileConfiguration
server [jvm] override val server: Server