Package dev.jorel.commandapi

Class CommandAPISpigot<Source>

java.lang.Object

dev.jorel.commandapi.CommandAPIBukkit<Source>

dev.jorel.commandapi.CommandAPISpigot<Source>

All Implemented Interfaces:

BukkitPlatform<Source>, CommandAPIPlatform<Argument<?>,org.bukkit.command.CommandSender,Source>, SpigotNMS<Source>

public abstract class CommandAPISpigot<Source>
extends CommandAPIBukkit<Source>
implements SpigotNMS<Source>

Field Summary

Fields inherited from class dev.jorel.commandapi.CommandAPIBukkit

config, nms, plugin

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandAPISpigot(InternalSpigotConfig config)

Method Summary

Modifier and Type	Method	Description
Platform	activePlatform()
static WrapperCommandSyntaxException	failWithBaseComponents(net.md_5.bungee.api.chat.BaseComponent... message)	Forces a command to return a success value of 0
org.bukkit.command.CommandMap	getCommandMap()
static InternalSpigotConfig	getConfiguration()
static <Source> CommandAPISpigot<Source>	getSpigot()
void	onEnable()	Enables the CommandAPI.
BukkitCommandSender<? extends org.bukkit.command.CommandSender>	wrapCommandSender(org.bukkit.command.CommandSender sender)

Methods inherited from class dev.jorel.commandapi.CommandAPIBukkit

checkDependencies, createDispatcherFile, get, getBrigadierDispatcher, getBrigadierSourceFromCommandSender, getCommandRegistrationStrategy, getCommandSenderFromCommandSource, getLogger, getMessenger, getNMS, getPlugin, getSenderForCommand, getSuggestionProvider, initializeNBTAPI, newConcreteCommandAPICommand, newConcreteLiteralArgument, newConcreteMultiLiteralArgument, onDisable, onLoad, postCommandRegistration, preCommandRegistration, registerBukkitRecipesSafely, registerCommandNode, registerPermission, reloadDataPacks, setupMessenger, stopCommandRegistrations, unregister, unregister, updateRequirements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.jorel.commandapi.BukkitPlatform

createCommandRegistrationStrategy

Methods inherited from interface dev.jorel.commandapi.nms.SpigotNMS

bukkitNMS, getChat, getChatColor, getChatComponent, getProfile

Constructor Details

CommandAPISpigot

protected CommandAPISpigot(InternalSpigotConfig config)

Method Details

getSpigot

public static <Source> CommandAPISpigot<Source> getSpigot()

getConfiguration

public static InternalSpigotConfig getConfiguration()

onEnable

public void onEnable()

Enables the CommandAPI. This should be placed at the start of your onEnable() method.

Specified by:

onEnable in interface CommandAPIPlatform<Argument<?>,org.bukkit.command.CommandSender,Source>

getCommandMap

public org.bukkit.command.CommandMap getCommandMap()

Specified by:

getCommandMap in interface BukkitPlatform<Source>

activePlatform

public Platform activePlatform()

Specified by:

activePlatform in interface BukkitPlatform<Source>

wrapCommandSender

public BukkitCommandSender<? extends org.bukkit.command.CommandSender> wrapCommandSender(org.bukkit.command.CommandSender sender)

Specified by:

wrapCommandSender in interface BukkitPlatform<Source>

Specified by:

wrapCommandSender in interface CommandAPIPlatform<Argument<?>,org.bukkit.command.CommandSender,Source>

Specified by:

wrapCommandSender in class CommandAPIBukkit<Source>

failWithBaseComponents

public static WrapperCommandSyntaxException failWithBaseComponents(net.md_5.bungee.api.chat.BaseComponent... message)

Forces a command to return a success value of 0

Parameters:

message - Description of the error message, formatted as an array of base components

Returns:

a WrapperCommandSyntaxException that wraps Brigadier's CommandSyntaxException