Class CommandAPIBukkit<Source>

java.lang.Object

dev.jorel.commandapi.CommandAPIBukkit<Source>

All Implemented Interfaces:

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

public abstract class CommandAPIBukkit<Source>
extends Object
implements BukkitPlatform<Source>

Field Summary

Fields

Modifier and Type	Field	Description
protected static InternalBukkitConfig	config
protected NMS<Source>	nms
protected org.bukkit.plugin.java.JavaPlugin	plugin

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandAPIBukkit()

Method Summary

Modifier and Type	Method	Description
protected void	checkDependencies()
void	createDispatcherFile(File file, com.mojang.brigadier.CommandDispatcher<Source> dispatcher)
static <Source> CommandAPIBukkit<Source>	get()
final com.mojang.brigadier.CommandDispatcher<Source>	getBrigadierDispatcher()
Source	getBrigadierSourceFromCommandSender(AbstractCommandSender<? extends org.bukkit.command.CommandSender> sender)
CommandRegistrationStrategy<Source>	getCommandRegistrationStrategy()
BukkitCommandSender<? extends org.bukkit.command.CommandSender>	getCommandSenderFromCommandSource(Source css)
static InternalBukkitConfig	getConfiguration()
CommandAPILogger	getLogger()
BukkitCommandAPIMessenger	getMessenger()
NMS<Source>	getNMS()
org.bukkit.plugin.java.JavaPlugin	getPlugin()
BukkitCommandSender<? extends org.bukkit.command.CommandSender>	getSenderForCommand(com.mojang.brigadier.context.CommandContext<Source> cmdCtx, boolean forceNative)
com.mojang.brigadier.suggestion.SuggestionProvider<Source>	getSuggestionProvider(SuggestionProviders suggestionProvider)
static <T> void	initializeNBTAPI(Class<T> nbtContainerClass, Function<Object,T> nbtContainerConstructor)	Initializes the CommandAPI's implementation of an NBT API.
CommandAPICommand	newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> meta)
Argument<String>	newConcreteLiteralArgument(String nodeName, String literal)
Argument<String>	newConcreteMultiLiteralArgument(String nodeName, String[] literals)
void	onDisable()
void	onLoad()
void	postCommandRegistration(RegisteredCommand registeredCommand, com.mojang.brigadier.tree.LiteralCommandNode<Source> resultantNode, List<com.mojang.brigadier.tree.LiteralCommandNode<Source>> aliasNodes)
void	preCommandRegistration(String commandName)
void	registerBukkitRecipesSafely(Iterator<org.bukkit.inventory.Recipe> recipes)
com.mojang.brigadier.tree.LiteralCommandNode<Source>	registerCommandNode(com.mojang.brigadier.builder.LiteralArgumentBuilder<Source> node, String namespace)
abstract void	registerPermission(String string)
void	reloadDataPacks()
BukkitCommandAPIMessenger	setupMessenger()
protected void	stopCommandRegistrations()
void	unregister(String commandName, boolean unregisterNamespaces)
static void	unregister(String commandName, boolean unregisterNamespaces, boolean unregisterBukkit)	Unregisters a command from the CommandGraph, so it can't be run anymore.
void	updateRequirements(AbstractPlayer<?> player)
abstract BukkitCommandSender<? extends org.bukkit.command.CommandSender>	wrapCommandSender(org.bukkit.command.CommandSender sender)

Methods inherited from class Object

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

Methods inherited from interface BukkitPlatform

activePlatform, createCommandRegistrationStrategy, getCommandMap

Modifier and Type	Method	Description
Platform	activePlatform()
CommandRegistrationStrategy<Source>	createCommandRegistrationStrategy()
org.bukkit.command.CommandMap	getCommandMap()

Methods inherited from interface CommandAPIPlatform

checkRegistrationStatus, onEnable

Field Details

config

protected static InternalBukkitConfig config

plugin

protected org.bukkit.plugin.java.JavaPlugin plugin

nms

protected NMS<Source> nms

Constructor Details

CommandAPIBukkit

protected CommandAPIBukkit()

Method Details

get

public static <Source> CommandAPIBukkit<Source> get()

getPlugin

public org.bukkit.plugin.java.JavaPlugin getPlugin()

getNMS

public NMS<Source> getNMS()

getConfiguration

public static InternalBukkitConfig getConfiguration()

getCommandRegistrationStrategy

public CommandRegistrationStrategy<Source> getCommandRegistrationStrategy()

onLoad

public void onLoad()

Specified by:

onLoad in interface BukkitPlatform<Source>

Specified by:

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

stopCommandRegistrations

protected void stopCommandRegistrations()

checkDependencies

protected void checkDependencies()

onDisable

public void onDisable()

Specified by:

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

wrapCommandSender

public abstract 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>

registerPermission

public abstract void registerPermission(String string)

Specified by:

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

preCommandRegistration

public void preCommandRegistration(String commandName)

Specified by:

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

postCommandRegistration

public void postCommandRegistration(RegisteredCommand registeredCommand,
 com.mojang.brigadier.tree.LiteralCommandNode<Source> resultantNode,
 List<com.mojang.brigadier.tree.LiteralCommandNode<Source>> aliasNodes)

Specified by:

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

registerCommandNode

public com.mojang.brigadier.tree.LiteralCommandNode<Source> registerCommandNode(com.mojang.brigadier.builder.LiteralArgumentBuilder<Source> node,
 String namespace)

Specified by:

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

unregister

public void unregister(String commandName,
 boolean unregisterNamespaces)

Specified by:

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

unregister

public static void unregister(String commandName,
 boolean unregisterNamespaces,
 boolean unregisterBukkit)

Unregisters a command from the CommandGraph, so it can't be run anymore. This Bukkit-specific unregister has an additional parameter, unregisterBukkit, compared to CommandAPI.unregister(String, boolean).

Parameters:

commandName - the name of the command to unregister

unregisterNamespaces - whether the unregistration system should attempt to remove versions of the command that start with a namespace. E.g. `minecraft:command`, `bukkit:command`, or `plugin:command`. If true, these namespaced versions of a command are also unregistered.

unregisterBukkit - whether the unregistration system should unregister Vanilla or Bukkit commands. If true, only Bukkit commands are unregistered, otherwise only Vanilla commands are unregistered. For the purposes of this parameter, commands registered using the CommandAPI are Vanilla commands, and commands registered by other plugin using Bukkit API are Bukkit commands.

setupMessenger

public BukkitCommandAPIMessenger setupMessenger()

Specified by:

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

getMessenger

public BukkitCommandAPIMessenger getMessenger()

Specified by:

getMessenger in interface BukkitPlatform<Source>

getBrigadierDispatcher

public final com.mojang.brigadier.CommandDispatcher<Source> getBrigadierDispatcher()

Specified by:

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

getLogger

public CommandAPILogger getLogger()

Specified by:

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

updateRequirements

public void updateRequirements(AbstractPlayer<?> player)

Specified by:

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

newConcreteMultiLiteralArgument

public Argument<String> newConcreteMultiLiteralArgument(String nodeName,
 String[] literals)

Specified by:

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

newConcreteLiteralArgument

public Argument<String> newConcreteLiteralArgument(String nodeName,
 String literal)

Specified by:

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

newConcreteCommandAPICommand

public CommandAPICommand newConcreteCommandAPICommand(dev.jorel.commandapi.CommandMetaData<org.bukkit.command.CommandSender> meta)

Specified by:

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

initializeNBTAPI

public static <T> void initializeNBTAPI(Class<T> nbtContainerClass,
 Function<Object,T> nbtContainerConstructor)

Initializes the CommandAPI's implementation of an NBT API. If you are shading the CommandAPI, you should be using CommandAPIBukkitConfig.initializeNBTAPI(Class, Function) in your onLoad method instead of calling this method.

Type Parameters:

T - the type that the NBT compound container class is

Parameters:

nbtContainerClass - the NBT compound container class. For example, NBTContainer.class

nbtContainerConstructor - a function that takes an Object (NMS NBTTagCompound) and returns an instance of the provided NBT compound container. For example, NBTContainer::new.

registerBukkitRecipesSafely

public void registerBukkitRecipesSafely(Iterator<org.bukkit.inventory.Recipe> recipes)

getSenderForCommand

public BukkitCommandSender<? extends org.bukkit.command.CommandSender> getSenderForCommand(com.mojang.brigadier.context.CommandContext<Source> cmdCtx,
 boolean forceNative)

Specified by:

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

getBrigadierSourceFromCommandSender

public Source getBrigadierSourceFromCommandSender(AbstractCommandSender<? extends org.bukkit.command.CommandSender> sender)

Specified by:

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

getSuggestionProvider

public com.mojang.brigadier.suggestion.SuggestionProvider<Source> getSuggestionProvider(SuggestionProviders suggestionProvider)

Specified by:

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

getCommandSenderFromCommandSource

public BukkitCommandSender<? extends org.bukkit.command.CommandSender> getCommandSenderFromCommandSource(Source css)

Specified by:

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

createDispatcherFile

public void createDispatcherFile(File file,
 com.mojang.brigadier.CommandDispatcher<Source> dispatcher)
                          throws IOException

Specified by:

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

Throws:

IOException

reloadDataPacks

public void reloadDataPacks()

Specified by:

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