Package dev.jorel.commandapi

Class CommandAPIBukkit<Source>

java.lang.Object

dev.jorel.commandapi.CommandAPIBukkit<Source>

All Implemented Interfaces:

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

public abstract class CommandAPIBukkit<Source>
extends Object
implements CommandAPIPlatform<Argument<?>,org.bukkit.command.CommandSender,Source>, NMS<Source>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandAPIBukkit()

Method Summary

Modifier and Type	Method	Description
abstract void	createDispatcherFile(File file, com.mojang.brigadier.CommandDispatcher<Source> brigadierDispatcher)
static WrapperCommandSyntaxException	failWithAdventureComponent(net.kyori.adventure.text.Component message)	Forces a command to return a success value of 0
static WrapperCommandSyntaxException	failWithBaseComponents(net.md_5.bungee.api.chat.BaseComponent... message)	Forces a command to return a success value of 0
static <Source> CommandAPIBukkit<Source>	get()
abstract com.mojang.brigadier.CommandDispatcher<Source>	getBrigadierDispatcher()	Returns the Brigadier CommandDispatcher from the NMS CommandDispatcher
abstract Source	getBrigadierSourceFromCommandSender(AbstractCommandSender<? extends org.bukkit.command.CommandSender> sender)
abstract BukkitCommandSender<? extends org.bukkit.command.CommandSender>	getCommandSenderFromCommandSource(Source cs)
static InternalBukkitConfig	getConfiguration()
CommandAPILogger	getLogger()
abstract <T> T	getMinecraftServer()
PaperImplementations	getPaper()
abstract BukkitCommandSender<? extends org.bukkit.command.CommandSender>	getSenderForCommand(com.mojang.brigadier.context.CommandContext<Source> cmdCtx, boolean forceNative)
abstract com.mojang.brigadier.suggestion.SuggestionProvider<Source>	getSuggestionProvider(SuggestionProviders suggestionProvider)	Retrieve a specific NMS implemented SuggestionProvider
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	onEnable()
void	onLoad(CommandAPIConfig<?> config)
void	postCommandRegistration(com.mojang.brigadier.tree.LiteralCommandNode<Source> resultantNode, List<com.mojang.brigadier.tree.LiteralCommandNode<Source>> aliasNodes)
void	preCommandRegistration(String commandName)
protected void	registerBukkitRecipesSafely(Iterator<org.bukkit.inventory.Recipe> recipes)
com.mojang.brigadier.tree.LiteralCommandNode<Source>	registerCommandNode(com.mojang.brigadier.builder.LiteralArgumentBuilder<Source> node)
void	registerPermission(String string)
abstract void	reloadDataPacks()	Reloads the datapacks by using the updated the commandDispatcher tree
void	unregister(String commandName, boolean force)
void	updateRequirements(AbstractPlayer<?> player)
BukkitCommandSender<? extends org.bukkit.command.CommandSender>	wrapCommandSender(org.bukkit.command.CommandSender sender)

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.nms.NMS

_ArgumentAngle, _ArgumentAxis, _ArgumentBlockPredicate, _ArgumentBlockState, _ArgumentChat, _ArgumentChatComponent, _ArgumentChatFormat, _ArgumentDimension, _ArgumentEnchantment, _ArgumentEntity, _ArgumentEntitySummon, _ArgumentFloatRange, _ArgumentIntRange, _ArgumentItemPredicate, _ArgumentItemStack, _ArgumentMathOperation, _ArgumentMinecraftKeyRegistered, _ArgumentMobEffect, _ArgumentNBTCompound, _ArgumentParticle, _ArgumentPosition, _ArgumentPosition2D, _ArgumentProfile, _ArgumentRotation, _ArgumentScoreboardCriteria, _ArgumentScoreboardObjective, _ArgumentScoreboardSlot, _ArgumentScoreboardTeam, _ArgumentScoreholder, _ArgumentSyntheticBiome, _ArgumentTag, _ArgumentTime, _ArgumentUUID, _ArgumentVec2, _ArgumentVec3, addToHelpMap, compatibleVersions, convert, convert, convert, convert, generateHelpTopic, generateMessageFromJson, getAdvancement, getAdventureChat, getAdventureChatComponent, getAngle, getAxis, getBiome, getBlockPredicate, getBlockState, getChat, getChatColor, getChatComponent, getDimension, getEnchantment, getEntitySelector, getEntityType, getFloatRange, getFunction, getFunction, getFunctions, getIntRange, getItemStack, getItemStackPredicate, getLocation2DBlock, getLocation2DPrecise, getLocationBlock, getLocationPrecise, getLootTable, getMathOperation, getMinecraftKey, getNBTCompound, getObjective, getObjectiveCriteria, getOfflinePlayer, getParticle, getPlayer, getPotionEffect, getRecipe, getRotation, getScoreboardSlot, getScoreHolderMultiple, getScoreHolderSingle, getSimpleCommandMap, getSound, getTag, getTags, getTeam, getTime, getUUID, getWorldForCSS, isVanillaCommandWrapper, resendPackets

Constructor Details

CommandAPIBukkit

protected CommandAPIBukkit()

Method Details

get

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

getPaper

public PaperImplementations getPaper()

getConfiguration

public static InternalBukkitConfig getConfiguration()

onLoad

public void onLoad(CommandAPIConfig<?> config)

Specified by:

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

onEnable

public void onEnable()

Specified by:

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

onDisable

public void onDisable()

Specified by:

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

getSenderForCommand

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

getCommandSenderFromCommandSource

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

Specified by:

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

getBrigadierSourceFromCommandSender

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

Specified by:

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

wrapCommandSender

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

Specified by:

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

registerPermission

public void registerPermission(String string)

Specified by:

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

getSuggestionProvider

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

Description copied from interface: NMS

Retrieve a specific NMS implemented SuggestionProvider

Specified by:

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

Specified by:

getSuggestionProvider in interface NMS<Source>

Parameters:

suggestionProvider - The SuggestionProvider type to retrieve

Returns:

A SuggestionProvider that matches the SuggestionProviders input

preCommandRegistration

public void preCommandRegistration(String commandName)

Specified by:

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

postCommandRegistration

public void postCommandRegistration(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)

Specified by:

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

unregister

public void unregister(String commandName,
 boolean force)

Specified by:

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

getBrigadierDispatcher

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

Description copied from interface: NMS

Returns the Brigadier CommandDispatcher from the NMS CommandDispatcher

Specified by:

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

Specified by:

getBrigadierDispatcher in interface NMS<Source>

Returns:

A Brigadier CommandDispatcher

createDispatcherFile

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

Specified by:

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

Throws:

IOException

getMinecraftServer

public abstract <T> T getMinecraftServer()

getLogger

public CommandAPILogger getLogger()

Specified by:

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

reloadDataPacks

public abstract void reloadDataPacks()

Description copied from interface: NMS

Reloads the datapacks by using the updated the commandDispatcher tree

Specified by:

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

Specified by:

reloadDataPacks in interface NMS<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>

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

failWithAdventureComponent

public static WrapperCommandSyntaxException failWithAdventureComponent(net.kyori.adventure.text.Component message)

Forces a command to return a success value of 0

Parameters:

message - Description of the error message, formatted as an adventure chat component

Returns:

a WrapperCommandSyntaxException that wraps Brigadier's CommandSyntaxException

registerBukkitRecipesSafely

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