api/kr.toxicity.model.api/BetterModelPlugin

BetterModelPlugin

Represents the main plugin interface for BetterModel.

This interface extends Plugin and provides access to core managers, configuration, versioning, and reloading functionality. It serves as the central hub for the plugin's operations.

Since

1.15.2

Types

ReloadResult

interface ReloadResult

Represents the outcome of a plugin reload operation.

Functions

addReloadEndHandler

abstract fun addReloadEndHandler(@NotNull consumer: @NotNull Consumer<BetterModelPlugin.ReloadResult>)

Registers a handler to be executed when a reload ends.

addReloadStartHandler

abstract fun addReloadStartHandler(@NotNull consumer: @NotNull Consumer<PackZipper>)

Registers a handler to be executed when a reload starts.

config

@NotNull

abstract fun config(): @NotNull BetterModelConfig

Returns the plugin's configuration manager.

evaluator

@NotNull

abstract fun evaluator(): @NotNull BetterModelEvaluator

Returns the expression evaluator.

getComponentLogger

open fun getComponentLogger(): @NotNull ComponentLogger

getConfig

abstract fun getConfig(): @NotNull FileConfiguration

getDataFolder

abstract fun getDataFolder(): @NotNull File

getDataPath

open fun getDataPath(): @NotNull Path

getDefaultBiomeProvider

abstract fun getDefaultBiomeProvider(p: @NotNull String, p1: @Nullable String): @Nullable BiomeProvider

getDefaultWorldGenerator

abstract fun getDefaultWorldGenerator(p: @NotNull String, p1: @Nullable String): @Nullable ChunkGenerator

getDescription

abstract fun getDescription(): @NotNull PluginDescriptionFile

getLifecycleManager

abstract fun getLifecycleManager(): @NotNull LifecycleEventManager<Plugin>

getLog4JLogger

open fun getLog4JLogger(): @NotNull Logger

getLogger

abstract fun getLogger(): @NotNull Logger

getName

abstract fun getName(): @NotNull String

getPluginLoader

abstract fun getPluginLoader(): @NotNull PluginLoader

getPluginMeta

abstract fun getPluginMeta(): @NotNull PluginMeta

getResource

@Nullable

abstract fun getResource(@NotNull path: @NotNull String): @Nullable InputStream

Retrieves a resource from the plugin's JAR file.

getServer

abstract fun getServer(): @NotNull Server

getSLF4JLogger

open fun getSLF4JLogger(): @NotNull Logger

isEnabled

abstract fun isEnabled(): Boolean

isNaggable

abstract fun isNaggable(): Boolean

isSnapshot

abstract fun isSnapshot(): Boolean

Checks if the running version of BetterModel is a snapshot build.

logger

@NotNull

abstract fun logger(): @NotNull BetterModelLogger

Returns the plugin's logger.

modelManager

@NotNull

abstract fun modelManager(): @NotNull ModelManager

Returns the model manager.

namespace

abstract fun namespace(): @NotNull String

nms

@NotNull

abstract fun nms(): @NotNull NMS

Returns the NMS (Net.Minecraft.Server) handler for version-specific operations.

onCommand

abstract fun onCommand(p: @NotNull CommandSender, p1: @NotNull Command, p2: @NotNull String, p3: @NotNull Array<@NotNull String>): Boolean

onDisable

abstract fun onDisable()

onEnable

abstract fun onEnable()

onLoad

abstract fun onLoad()

onTabComplete

abstract fun onTabComplete(p: @NotNull CommandSender, p1: @NotNull Command, p2: @NotNull String, p3: @NotNull Array<@NotNull String>): @Nullable List<String>

playerManager

@NotNull

abstract fun playerManager(): @NotNull PlayerManager

Returns the player manager.

profileManager

@NotNull

abstract fun profileManager(): @NotNull ProfileManager

Returns the profile manager.

reload

@NotNull

open fun reload(): @NotNull BetterModelPlugin.ReloadResult

Reloads the plugin with default settings (console sender).