paper/dev.s7a.strata.runtime.paper/StrataPlugin

StrataPlugin

class StrataPlugin : JavaPlugin, Listener, PluginMessageListener(source)

Installable Paper plugin owning messaging registrations and Paper or Folia entity-region UI scheduling. Other plugins use PaperUi and declare Strata as a dependency.

Constructors

StrataPlugin

constructor()

Properties

componentLogger

@get:NotNull

open val componentLogger: @NotNull ComponentLogger

config

@get:NotNull

open val config: @NotNull FileConfiguration

dataFolder

@get:NotNull

val dataFolder: @NotNull File

description

@get:NotNull

val description: @NotNull PluginDescriptionFile

isEnabled

@set:ApiStatus.Internal

var isEnabled: Boolean

isNaggable

var isNaggable: Boolean

log4JLogger

@get:NotNull

open val log4JLogger: @NotNull Logger

logger

@get:NotNull

open val logger: @NotNull Logger

name

@get:NotNull

val name: @NotNull String

pluginLoader

@get:NotNull

val pluginLoader: @NotNull PluginLoader

pluginMeta

@get:NotNull

val pluginMeta: @NotNull PluginMeta

server

@get:NotNull

val server: @NotNull Server

slF4JLogger

@get:NotNull

open val slF4JLogger: @NotNull Logger

Functions

getCommand

@Nullable

open fun getCommand(@NotNull name: @NotNull String): @Nullable PluginCommand?

getDefaultBiomeProvider

@Nullable

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

getDefaultWorldGenerator

@Nullable

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

getResource

@Nullable

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

init

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

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

onCommand

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

onDisable

open override fun onDisable()

onEnable

open override fun onEnable()

onInventoryClose

fun onInventoryClose(event: InventoryCloseEvent)

Prevents a screen from retaining operations for a container that has been closed.

onInventoryOpen

fun onInventoryOpen(event: InventoryOpenEvent)

Retires the prior screen after an accepted native inventory replacement.

onJoin

fun onJoin(event: PlayerJoinEvent)

Starts negotiation only after a player has joined the server.

onLoad

open fun onLoad()

onPluginDisable

fun onPluginDisable(event: PluginDisableEvent)

Ends dependent-plugin screens before their handlers become unavailable.

onPluginMessageReceived

open override fun onPluginMessageReceived(channel: String, player: Player, message: ByteArray)

onQuit

fun onQuit(event: PlayerQuitEvent)

Releases the departed player's screen and all transport buffers.

onTabComplete

@Nullable

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

reloadConfig

open fun reloadConfig()

saveConfig

open fun saveConfig()

saveDefaultConfig

open fun saveDefaultConfig()

saveResource

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