Class CommandAPIPaper<Source>

java.lang.Object

dev.jorel.commandapi.CommandAPIBukkit<Source>

dev.jorel.commandapi.CommandAPIPaper<Source>

All Implemented Interfaces:

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

public class CommandAPIPaper<Source>
extends CommandAPIBukkit<Source>

Field Summary

Fields inherited from class CommandAPIBukkit

config, nms, plugin

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandAPIPaper(InternalPaperConfig config, BundledNMS<Source> nms)

Method Summary

Modifier and Type	Method	Description
Platform	activePlatform()
<Impl extends AbstractCommandAPICommand<Impl, Argument<?>, org.bukkit.command.CommandSender>> boolean	checkRegistrationStatus(AbstractCommandAPICommand<Impl, Argument<?>, org.bukkit.command.CommandSender> command)
CommandRegistrationStrategy<Source>	createCommandRegistrationStrategy()
static WrapperCommandSyntaxException	failWithAdventureComponent(net.kyori.adventure.text.ComponentLike message)	Forces a command to return a success value of 0
org.bukkit.command.CommandMap	getCommandMap()
static InternalPaperConfig	getConfiguration()
io.papermc.paper.plugin.lifecycle.event.LifecycleEventOwner	getLifecycleEventOwner()
CommandAPILogger	getLogger()
BundledNMS<Source>	getNMS()
static <Source> CommandAPIPaper<Source>	getPaper()
boolean	isFoliaPresent()
void	onEnable()	Enables the CommandAPI.
void	onLoad()
void	registerPermission(String string)
BukkitCommandSender<? extends org.bukkit.command.CommandSender>	wrapCommandSender(org.bukkit.command.CommandSender sender)

Methods inherited from class CommandAPIBukkit

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

Methods inherited from class Object

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

Constructor Details

CommandAPIPaper

protected CommandAPIPaper(InternalPaperConfig config,
 BundledNMS<Source> nms)

Method Details

getPaper

public static <Source> CommandAPIPaper<Source> getPaper()

getConfiguration

public static InternalPaperConfig getConfiguration()

getLifecycleEventOwner

public io.papermc.paper.plugin.lifecycle.event.LifecycleEventOwner getLifecycleEventOwner()

getNMS

public BundledNMS<Source> getNMS()

Overrides:

getNMS in class CommandAPIBukkit<Source>

isFoliaPresent

public boolean isFoliaPresent()

onLoad

public void onLoad()

Specified by:

onLoad in interface BukkitPlatform<Source>

Specified by:

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

Overrides:

onLoad in class CommandAPIBukkit<Source>

onEnable

public void onEnable()

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

getCommandMap

public org.bukkit.command.CommandMap getCommandMap()

activePlatform

public Platform activePlatform()

createCommandRegistrationStrategy

public CommandRegistrationStrategy<Source> createCommandRegistrationStrategy()

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>

registerPermission

public void registerPermission(String string)

Specified by:

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

Specified by:

registerPermission in class CommandAPIBukkit<Source>

checkRegistrationStatus

@Internal
public <Impl extends AbstractCommandAPICommand<Impl, Argument<?>, org.bukkit.command.CommandSender>>
boolean checkRegistrationStatus(AbstractCommandAPICommand<Impl, Argument<?>, org.bukkit.command.CommandSender> command)

failWithAdventureComponent

public static WrapperCommandSyntaxException failWithAdventureComponent(net.kyori.adventure.text.ComponentLike 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

getLogger

public CommandAPILogger getLogger()

Specified by:

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

Overrides:

getLogger in class CommandAPIBukkit<Source>