Package dev.jorel.commandapi

Class MockCommandAPIPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

dev.jorel.commandapi.MockCommandAPIPlugin

All Implemented Interfaces:

io.papermc.paper.plugin.lifecycle.event.LifecycleEventOwner, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class MockCommandAPIPlugin
extends org.bukkit.plugin.java.JavaPlugin

A JavaPlugin that loads the CommandAPI in a testing environment. If your plugin depends on the CommandAPI plugin when running on a server (you aren't shading the CommandAPI), load this class before loading your own plugin with MockBukkit. You can do this directly using MockBukkit.load(MockCommandAPIPlugin.class);, or with load(). If you need to configure settings usually located in the CommandAPI's plugin.yml, use load(Consumer).

Constructor Summary

Constructors

Constructor	Description
MockCommandAPIPlugin()

Method Summary

Modifier and Type	Method	Description
static MockCommandAPIPlugin	load()	Loads the CommandAPI plugin using MockBukkit.load(Class).
static MockCommandAPIPlugin	load(Consumer<CommandAPIBukkitConfig> configureSettings)	Loads the CommandAPI plugin using MockBukkit.load(Class).
void	onDisable()
void	onEnable()
void	onLoad()

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLifecycleManager, getLogger, getPlugin, getPluginLoader, getPluginMeta, getProvidingPlugin, getResource, getServer, getTextResource, init, init, isEnabled, isNaggable, onCommand, onTabComplete, registerCommand, registerCommand, registerCommand, registerCommand, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.plugin.Plugin

getComponentLogger, getDataPath, getLog4JLogger, getSLF4JLogger

Constructor Details

MockCommandAPIPlugin

public MockCommandAPIPlugin()

Method Details

load

public static MockCommandAPIPlugin load()

Loads the CommandAPI plugin using MockBukkit.load(Class).

Returns:

The MockCommandAPIPlugin instance that was loaded.

load

public static MockCommandAPIPlugin load(Consumer<CommandAPIBukkitConfig> configureSettings)

Loads the CommandAPI plugin using MockBukkit.load(Class).

Parameters:

configureSettings - A Consumer that can configure the settings of the CommandAPIBukkitConfig before it is used to load the CommandAPI plugin.

Returns:

The MockCommandAPIPlugin instance that was loaded.

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

Overrides:

onLoad in class org.bukkit.plugin.java.JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin