Package dev.jorel.commandapi.nms

Class NMS_Common<T>

java.lang.Object
dev.jorel.commandapi.nms.NMS_Common<T>
All Implemented Interfaces:
NMS<T>
public abstract class NMS_Common<T> extends Object implements NMS<T>
Common NMS code To ensure that this code actually works across all versions of Minecraft that this is supposed to support (1.17+), you should be compiling this code against all of the declared Maven profiles specified in this submodule's pom.xml file, by running the following commands:
  • mvn clean package -pl :commandapi-nms-common -P Spigot_1_19_R1
  • mvn clean package -pl :commandapi-nms-common -P Spigot_1_18_2_R2
  • mvn clean package -pl :commandapi-nms-common -P Spigot_1_18_R1
  • mvn clean package -pl :commandapi-nms-common -P Spigot_1_17_R1
Any of these that do not work should be removed or implemented otherwise (introducing another NMS_Common module perhaps?

  • Constructor Details

    • NMS_Common

      public NMS_Common()

  • Method Details

    • _ArgumentAngle

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentAngle()
      Specified by:
      _ArgumentAngle in interface NMS<T>

    • _ArgumentAxis

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentAxis()
      Specified by:
      _ArgumentAxis in interface NMS<T>

    • _ArgumentBlockPredicate

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentBlockPredicate()
      Specified by:
      _ArgumentBlockPredicate in interface NMS<T>

    • _ArgumentBlockState

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentBlockState()
      Specified by:
      _ArgumentBlockState in interface NMS<T>

    • _ArgumentChat

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentChat()
      Specified by:
      _ArgumentChat in interface NMS<T>

    • _ArgumentChatComponent

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentChatComponent()
      Specified by:
      _ArgumentChatComponent in interface NMS<T>

    • _ArgumentChatFormat

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentChatFormat()
      Specified by:
      _ArgumentChatFormat in interface NMS<T>

    • _ArgumentDimension

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentDimension()
      Specified by:
      _ArgumentDimension in interface NMS<T>

    • _ArgumentEnchantment

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentEnchantment()
      Specified by:
      _ArgumentEnchantment in interface NMS<T>

    • _ArgumentEntity

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentEntity(EntitySelector selector)
      Specified by:
      _ArgumentEntity in interface NMS<T>

    • _ArgumentEntitySummon

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentEntitySummon()
      Specified by:
      _ArgumentEntitySummon in interface NMS<T>

    • _ArgumentFloatRange

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentFloatRange()
      Specified by:
      _ArgumentFloatRange in interface NMS<T>

    • _ArgumentIntRange

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentIntRange()
      Specified by:
      _ArgumentIntRange in interface NMS<T>

    • _ArgumentItemPredicate

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentItemPredicate()
      Specified by:
      _ArgumentItemPredicate in interface NMS<T>

    • _ArgumentItemStack

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentItemStack()
      Specified by:
      _ArgumentItemStack in interface NMS<T>

    • _ArgumentMathOperation

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentMathOperation()
      Specified by:
      _ArgumentMathOperation in interface NMS<T>

    • _ArgumentMinecraftKeyRegistered

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentMinecraftKeyRegistered()
      Specified by:
      _ArgumentMinecraftKeyRegistered in interface NMS<T>

    • _ArgumentMobEffect

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentMobEffect()
      Specified by:
      _ArgumentMobEffect in interface NMS<T>

    • _ArgumentNBTCompound

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentNBTCompound()
      Specified by:
      _ArgumentNBTCompound in interface NMS<T>

    • _ArgumentParticle

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentParticle()
      Specified by:
      _ArgumentParticle in interface NMS<T>

    • _ArgumentPosition

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentPosition()
      Specified by:
      _ArgumentPosition in interface NMS<T>

    • _ArgumentPosition2D

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentPosition2D()
      Specified by:
      _ArgumentPosition2D in interface NMS<T>

    • _ArgumentProfile

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentProfile()
      Specified by:
      _ArgumentProfile in interface NMS<T>

    • _ArgumentRotation

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentRotation()
      Specified by:
      _ArgumentRotation in interface NMS<T>

    • _ArgumentScoreboardCriteria

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentScoreboardCriteria()
      Specified by:
      _ArgumentScoreboardCriteria in interface NMS<T>

    • _ArgumentScoreboardObjective

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentScoreboardObjective()
      Specified by:
      _ArgumentScoreboardObjective in interface NMS<T>

    • _ArgumentScoreboardSlot

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentScoreboardSlot()
      Specified by:
      _ArgumentScoreboardSlot in interface NMS<T>

    • _ArgumentScoreboardTeam

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentScoreboardTeam()
      Specified by:
      _ArgumentScoreboardTeam in interface NMS<T>

    • _ArgumentScoreholder

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentScoreholder(boolean single)
      Specified by:
      _ArgumentScoreholder in interface NMS<T>

    • _ArgumentSyntheticBiome

      public abstract com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentSyntheticBiome()
      Specified by:
      _ArgumentSyntheticBiome in interface NMS<T>

    • _ArgumentTag

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentTag()
      Specified by:
      _ArgumentTag in interface NMS<T>

    • _ArgumentTime

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentTime()
      Specified by:
      _ArgumentTime in interface NMS<T>

    • _ArgumentUUID

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentUUID()
      Specified by:
      _ArgumentUUID in interface NMS<T>

    • _ArgumentVec2

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentVec2()
      Specified by:
      _ArgumentVec2 in interface NMS<T>

    • _ArgumentVec3

      public final com.mojang.brigadier.arguments.ArgumentType<?> _ArgumentVec3()
      Specified by:
      _ArgumentVec3 in interface NMS<T>

    • getChat

      public final net.md_5.bungee.api.chat.BaseComponent[] getChat(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getChat in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getChatComponent

      public final net.md_5.bungee.api.chat.BaseComponent[] getChatComponent(com.mojang.brigadier.context.CommandContext cmdCtx, String str)
      Specified by:
      getChatComponent in interface NMS<T>

    • addToHelpMap

      public abstract void addToHelpMap(Map<String,org.bukkit.help.HelpTopic> helpTopicsToAdd)
      Specified by:
      addToHelpMap in interface NMS<T>

    • compatibleVersions

      public abstract String[] compatibleVersions()
      Specified by:
      compatibleVersions in interface NMS<T>

    • convert

      public abstract String convert(org.bukkit.inventory.ItemStack is)
      Specified by:
      convert in interface NMS<T>

    • convert

      public abstract String convert(ParticleData<?> particle)
      Specified by:
      convert in interface NMS<T>

    • convert

      public final String convert(org.bukkit.potion.PotionEffectType potion)
      Specified by:
      convert in interface NMS<T>

    • convert

      public final String convert(org.bukkit.Sound sound)
      Specified by:
      convert in interface NMS<T>

    • createDispatcherFile

      public abstract void createDispatcherFile(File file, com.mojang.brigadier.CommandDispatcher<T> dispatcher) throws IOException
      Specified by:
      createDispatcherFile in interface NMS<T>
      Throws:
      IOException

    • generateHelpTopic

      public abstract org.bukkit.help.HelpTopic generateHelpTopic(String commandName, String shortDescription, String fullDescription, String permission)
      Specified by:
      generateHelpTopic in interface NMS<T>

    • getAdvancement

      public final org.bukkit.advancement.Advancement getAdvancement(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getAdvancement in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getAngle

      public final float getAngle(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getAngle in interface NMS<T>

    • getAxis

      public final EnumSet<org.bukkit.Axis> getAxis(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getAxis in interface NMS<T>

    • getCLWFromCommandSender

      public abstract T getCLWFromCommandSender(org.bukkit.command.CommandSender sender)
      Specified by:
      getCLWFromCommandSender in interface NMS<T>

    • getDimension

      public final org.bukkit.World.Environment getDimension(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getDimension in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getFloatRange

      public final FloatRange getFloatRange(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getFloatRange in interface NMS<T>

    • getIntRange

      public final IntegerRange getIntRange(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getIntRange in interface NMS<T>

    • getItemStack

      public abstract org.bukkit.inventory.ItemStack getItemStack(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getItemStack in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getMathOperation

      public final MathOperation getMathOperation(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getMathOperation in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getMinecraftKey

      public org.bukkit.NamespacedKey getMinecraftKey(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getMinecraftKey in interface NMS<T>

    • getNBTCompound

      public <NBTContainer> Object getNBTCompound(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key, Function<Object,NBTContainer> nbtContainerConstructor)
      Specified by:
      getNBTCompound in interface NMS<T>

    • getRotation

      public final Rotation getRotation(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getRotation in interface NMS<T>

    • getScoreboardSlot

      public final ScoreboardSlot getScoreboardSlot(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getScoreboardSlot in interface NMS<T>

    • getScoreHolderMultiple

      public final Collection<String> getScoreHolderMultiple(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getScoreHolderMultiple in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getScoreHolderSingle

      public final String getScoreHolderSingle(com.mojang.brigadier.context.CommandContext cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getScoreHolderSingle in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getTime

      public final int getTime(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getTime in interface NMS<T>

    • getUUID

      public final UUID getUUID(com.mojang.brigadier.context.CommandContext cmdCtx, String key)
      Specified by:
      getUUID in interface NMS<T>

    • getAdventureChat

      public abstract net.kyori.adventure.text.Component getAdventureChat(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getAdventureChat in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getAdventureChatComponent

      public abstract net.kyori.adventure.text.Component getAdventureChatComponent(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getAdventureChatComponent in interface NMS<T>

    • getBiome

      public abstract org.bukkit.block.Biome getBiome(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getBiome in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getBlockPredicate

      public abstract Predicate<org.bukkit.block.Block> getBlockPredicate(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getBlockPredicate in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getBlockState

      public abstract org.bukkit.block.data.BlockData getBlockState(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getBlockState in interface NMS<T>

    • getBrigadierDispatcher

      public abstract com.mojang.brigadier.CommandDispatcher<T> getBrigadierDispatcher()
      Specified by:
      getBrigadierDispatcher in interface NMS<T>

    • getChatColor

      public abstract org.bukkit.ChatColor getChatColor(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getChatColor in interface NMS<T>

    • getCommandSenderFromCSS

      public abstract org.bukkit.command.CommandSender getCommandSenderFromCSS(T clw)
      Specified by:
      getCommandSenderFromCSS in interface NMS<T>

    • getEnchantment

      public abstract org.bukkit.enchantments.Enchantment getEnchantment(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getEnchantment in interface NMS<T>

    • getEntitySelector

      public abstract Object getEntitySelector(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key, EntitySelector selector) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getEntitySelector in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getEntityType

      public abstract org.bukkit.entity.EntityType getEntityType(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getEntityType in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getFunction

      public abstract FunctionWrapper[] getFunction(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getFunction in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getFunction

      public abstract SimpleFunctionWrapper getFunction(org.bukkit.NamespacedKey key)
      Specified by:
      getFunction in interface NMS<T>

    • getFunctions

      public abstract Set<org.bukkit.NamespacedKey> getFunctions()
      Specified by:
      getFunctions in interface NMS<T>

    • getItemStackPredicate

      public abstract Predicate<org.bukkit.inventory.ItemStack> getItemStackPredicate(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getItemStackPredicate in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getLocation2DBlock

      public abstract Location2D getLocation2DBlock(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getLocation2DBlock in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getLocation2DPrecise

      public abstract Location2D getLocation2DPrecise(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getLocation2DPrecise in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getLocationBlock

      public abstract org.bukkit.Location getLocationBlock(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String str) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getLocationBlock in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getLocationPrecise

      public abstract org.bukkit.Location getLocationPrecise(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String str) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getLocationPrecise in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getLootTable

      public abstract org.bukkit.loot.LootTable getLootTable(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getLootTable in interface NMS<T>

    • getObjective

      public abstract String getObjective(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws IllegalArgumentException, com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getObjective in interface NMS<T>
      Throws:
      IllegalArgumentException
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getObjectiveCriteria

      public abstract String getObjectiveCriteria(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getObjectiveCriteria in interface NMS<T>

    • getOfflinePlayer

      public final org.bukkit.OfflinePlayer getOfflinePlayer(com.mojang.brigadier.context.CommandContext cmdCtx, String str) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getOfflinePlayer in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getParticle

      public abstract ParticleData<?> getParticle(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getParticle in interface NMS<T>

    • getPlayer

      public final org.bukkit.entity.Player getPlayer(com.mojang.brigadier.context.CommandContext cmdCtx, String str) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getPlayer in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getPotionEffect

      public abstract org.bukkit.potion.PotionEffectType getPotionEffect(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getPotionEffect in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getRecipe

      public abstract org.bukkit.inventory.Recipe getRecipe(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getRecipe in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getSenderForCommand

      public abstract org.bukkit.command.CommandSender getSenderForCommand(com.mojang.brigadier.context.CommandContext<T> cmdCtx, boolean forceNative)
      Specified by:
      getSenderForCommand in interface NMS<T>

    • getSimpleCommandMap

      public abstract org.bukkit.command.SimpleCommandMap getSimpleCommandMap()
      Specified by:
      getSimpleCommandMap in interface NMS<T>

    • getSound

      public abstract org.bukkit.Sound getSound(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key)
      Specified by:
      getSound in interface NMS<T>

    • getSuggestionProvider

      public abstract com.mojang.brigadier.suggestion.SuggestionProvider<T> getSuggestionProvider(SuggestionProviders provider)
      Specified by:
      getSuggestionProvider in interface NMS<T>

    • getTag

      public abstract SimpleFunctionWrapper[] getTag(org.bukkit.NamespacedKey key)
      Specified by:
      getTag in interface NMS<T>

    • getTags

      public abstract Set<org.bukkit.NamespacedKey> getTags()
      Specified by:
      getTags in interface NMS<T>

    • getTeam

      public abstract String getTeam(com.mojang.brigadier.context.CommandContext<T> cmdCtx, String key) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      getTeam in interface NMS<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • getWorldForCSS

      public abstract org.bukkit.World getWorldForCSS(T clw)
      Specified by:
      getWorldForCSS in interface NMS<T>

    • isVanillaCommandWrapper

      public abstract boolean isVanillaCommandWrapper(org.bukkit.command.Command command)
      Specified by:
      isVanillaCommandWrapper in interface NMS<T>

    • reloadDataPacks

      public abstract void reloadDataPacks()
      Specified by:
      reloadDataPacks in interface NMS<T>

    • resendPackets

      public abstract void resendPackets(org.bukkit.entity.Player player)
      Specified by:
      resendPackets in interface NMS<T>