Package com.comphenix.protocol.utility

Class MinecraftReflection

java.lang.Object
com.comphenix.protocol.utility.MinecraftReflection
public class MinecraftReflection extends Object
Methods and constants specifically used in conjuction with reflecting Minecraft object.
Author:
Kristian

  • Field Details

    • REPORT_CANNOT_FIND_MCPC_REMAPPER

      public static final ReportType REPORT_CANNOT_FIND_MCPC_REMAPPER

    • REPORT_CANNOT_LOAD_CPC_REMAPPER

      public static final ReportType REPORT_CANNOT_LOAD_CPC_REMAPPER

    • REPORT_NON_CRAFTBUKKIT_LIBRARY_PACKAGE

      public static final ReportType REPORT_NON_CRAFTBUKKIT_LIBRARY_PACKAGE

    • MINECRAFT_OBJECT

      @Deprecated public static final String MINECRAFT_OBJECT
      Deprecated.
      Regular expression that matches a Minecraft object.

      Replaced by the method getMinecraftObjectRegex().

      See Also:
      Constant Field Values

  • Method Details

    • getMinecraftObjectRegex

      public static String getMinecraftObjectRegex()
      Retrieve a regular expression that can match Minecraft package objects.
      Returns:
      Minecraft package matcher.

    • getMinecraftObjectMatcher

      public static AbstractFuzzyMatcher<Class<?>> getMinecraftObjectMatcher()
      Retrieve a abstract fuzzy class matcher for Minecraft objects.
      Returns:
      A matcher for Minecraft objects.

    • getMinecraftPackage

      public static String getMinecraftPackage()
      Retrieve the name of the Minecraft server package.
      Returns:
      Full canonical name of the Minecraft server package.

    • getPackageVersion

      public static String getPackageVersion()
      Retrieve the package version of the underlying CraftBukkit server.
      Returns:
      The package version, or NULL if not applicable (before 1.4.6).

    • setMinecraftPackage

      public static void setMinecraftPackage​(String minecraftPackage, String craftBukkitPackage)
      Used during debugging and testing.
      Parameters:
      minecraftPackage - - the current Minecraft package.
      craftBukkitPackage - - the current CraftBukkit package.

    • getCraftBukkitPackage

      public static String getCraftBukkitPackage()
      Retrieve the name of the root CraftBukkit package.
      Returns:
      Full canonical name of the root CraftBukkit package.

    • getBukkitEntity

      public static Object getBukkitEntity​(Object nmsObject)
      Dynamically retrieve the Bukkit entity from a given entity.
      Parameters:
      nmsObject - - the NMS entity.
      Returns:
      A bukkit entity.
      Throws:
      RuntimeException - If we were unable to retrieve the Bukkit entity.

    • isMinecraftObject

      public static boolean isMinecraftObject​(@Nonnull Object obj)
      Determine if a given object can be found within the package net.minecraft.server.
      Parameters:
      obj - - the object to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isMinecraftClass

      public static boolean isMinecraftClass​(@Nonnull Class<?> clazz)
      Determine if the given class is found within the package net.minecraft.server, or any equivalent package.
      Parameters:
      clazz - - the class to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isMinecraftObject

      public static boolean isMinecraftObject​(@Nonnull Object obj, String className)
      Determine if a given object is found in net.minecraft.server, and has the given name.
      Parameters:
      obj - - the object to test.
      className - - the class name to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • is

      public static boolean is​(Class<?> clazz, Object object)
      Determine if a given Object is compatible with a given Class. That is, whether or not the Object is an instance of that Class or one of its subclasses. If either is null, false is returned.
      Parameters:
      clazz - Class to test for, may be null
      object - the Object to test, may be null
      Returns:
      True if it is, false if not
      See Also:
      Class.isAssignableFrom(Class)

    • is

      public static boolean is​(Class<?> clazz, Class<?> test)
      Equivalent to is(Class, Object) but we don't call getClass again

    • isChunkPosition

      public static boolean isChunkPosition​(Object obj)
      Determine if a given object is a ChunkPosition.
      Parameters:
      obj - - the object to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isBlockPosition

      public static boolean isBlockPosition​(Object obj)
      Determine if a given object is a BlockPosition.
      Parameters:
      obj - - the object to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isChunkCoordIntPair

      public static boolean isChunkCoordIntPair​(Object obj)
      Determine if the given object is an NMS ChunkCoordIntPar.
      Parameters:
      obj - - the object.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isChunkCoordinates

      public static boolean isChunkCoordinates​(Object obj)
      Determine if a given object is a ChunkCoordinate.
      Parameters:
      obj - - the object to test.
      Returns:
      TRUE if it can, FALSE otherwise.

    • isPacketClass

      public static boolean isPacketClass​(Object obj)
      Determine if the given object is actually a Minecraft packet.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isLoginHandler

      public static boolean isLoginHandler​(Object obj)
      Determine if the given object is a NetLoginHandler (PendingConnection)
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isServerHandler

      public static boolean isServerHandler​(Object obj)
      Determine if the given object is assignable to a NetServerHandler (PlayerConnection)
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isMinecraftEntity

      public static boolean isMinecraftEntity​(Object obj)
      Determine if the given object is actually a Minecraft packet.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isItemStack

      public static boolean isItemStack​(Object value)
      Determine if the given object is a NMS ItemStack.
      Parameters:
      value - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isCraftPlayer

      public static boolean isCraftPlayer​(Object value)
      Determine if the given object is a CraftPlayer class.
      Parameters:
      value - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isMinecraftPlayer

      public static boolean isMinecraftPlayer​(Object obj)
      Determine if the given object is a Minecraft player entity.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isWatchableObject

      public static boolean isWatchableObject​(Object obj)
      Determine if the given object is a watchable object.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isDataWatcher

      public static boolean isDataWatcher​(Object obj)
      Determine if the given object is a data watcher object.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isIntHashMap

      public static boolean isIntHashMap​(Object obj)
      Determine if the given object is an IntHashMap object.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • isCraftItemStack

      public static boolean isCraftItemStack​(Object obj)
      Determine if the given object is a CraftItemStack instancey.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • getEntityPlayerClass

      public static Class<?> getEntityPlayerClass()
      Retrieve the EntityPlayer (NMS) class.
      Returns:
      The entity class.

    • getEntityHumanClass

      public static Class<?> getEntityHumanClass()
      Retrieve the EntityHuman class.
      Returns:
      The entity human class.

    • getGameProfileClass

      public static Class<?> getGameProfileClass()
      Retrieve the GameProfile class in 1.7.2 and later.
      Returns:
      The game profile class.
      Throws:
      IllegalStateException - If we are running 1.6.4 or earlier.

    • getEntityClass

      public static Class<?> getEntityClass()
      Retrieve the entity (NMS) class.
      Returns:
      The entity class.

    • getCraftChatMessage

      public static Class<?> getCraftChatMessage()
      Retrieve the CraftChatMessage in Minecraft 1.7.2.
      Returns:
      The CraftChatMessage class.

    • getWorldServerClass

      public static Class<?> getWorldServerClass()
      Retrieve the WorldServer (NMS) class.
      Returns:
      The WorldServer class.

    • getNmsWorldClass

      public static Class<?> getNmsWorldClass()
      Retrieve the World (NMS) class.
      Returns:
      The world class.

    • getPacketClass

      public static Class<?> getPacketClass()
      Retrieve the packet class.
      Returns:
      The packet class.

    • getByteBufClass

      public static Class<?> getByteBufClass()

    • getEnumProtocolClass

      public static Class<?> getEnumProtocolClass()
      Retrieve the EnumProtocol class in 1.7.2.
      Returns:
      The Enum protocol class.

    • getIChatBaseComponentClass

      public static Class<?> getIChatBaseComponentClass()
      Retrieve the IChatBaseComponent class.
      Returns:
      The IChatBaseComponent.

    • getIChatBaseComponentArrayClass

      public static Class<?> getIChatBaseComponentArrayClass()

    • getChatComponentTextClass

      public static Class<?> getChatComponentTextClass()
      Retrieve the NMS chat component text class.
      Returns:
      The chat component class.

    • getChatSerializerClass

      public static Class<?> getChatSerializerClass()
      Attempt to find the ChatSerializer class.
      Returns:
      The serializer class.
      Throws:
      IllegalStateException - If the class could not be found or deduced.

    • getServerPingClass

      public static Class<?> getServerPingClass()
      Retrieve the ServerPing class in Minecraft 1.7.2.
      Returns:
      The ServerPing class.

    • getServerPingServerDataClass

      public static Class<?> getServerPingServerDataClass()
      Retrieve the ServerPingServerData class in Minecraft 1.7.2.
      Returns:
      The ServerPingServerData class.

    • getServerPingPlayerSampleClass

      public static Class<?> getServerPingPlayerSampleClass()
      Retrieve the ServerPingPlayerSample class in Minecraft 1.7.2.
      Returns:
      The ServerPingPlayerSample class.

    • isUsingNetty

      public static boolean isUsingNetty()
      Determine if this Minecraft version is using Netty.

      Spigot is ignored in this consideration.

      Returns:
      TRUE if it does, FALSE otherwise.

    • getMinecraftServerClass

      public static Class<?> getMinecraftServerClass()
      Retrieve the MinecraftServer class.
      Returns:
      MinecraftServer class.

    • getStatisticClass

      public static Class<?> getStatisticClass()
      Retrieve the NMS statistics class.
      Returns:
      The statistics class.

    • getStatisticListClass

      public static Class<?> getStatisticListClass()
      Retrieve the NMS statistic list class.
      Returns:
      The statistic list class.

    • getPlayerListClass

      public static Class<?> getPlayerListClass()
      Retrieve the player list class (or ServerConfigurationManager),
      Returns:
      The player list class.

    • getNetLoginHandlerClass

      public static Class<?> getNetLoginHandlerClass()
      Retrieve the NetLoginHandler class (or PendingConnection)
      Returns:
      The NetLoginHandler class.

    • getPlayerConnectionClass

      public static Class<?> getPlayerConnectionClass()
      Retrieve the PlayerConnection class (or NetServerHandler)
      Returns:
      The PlayerConnection class.

    • getNetworkManagerClass

      public static Class<?> getNetworkManagerClass()
      Retrieve the NetworkManager class or its interface.
      Returns:
      The NetworkManager class or its interface.

    • getNetHandlerClass

      public static Class<?> getNetHandlerClass()
      Retrieve the NetHandler class (or Connection)
      Returns:
      The NetHandler class.

    • getItemStackClass

      public static Class<?> getItemStackClass()
      Retrieve the NMS ItemStack class.
      Returns:
      The ItemStack class.

    • getBlockClass

      public static Class<?> getBlockClass()
      Retrieve the Block (NMS) class.
      Returns:
      Block (NMS) class.

    • getItemClass

      public static Class<?> getItemClass()

    • getFluidTypeClass

      public static Class<?> getFluidTypeClass()

    • getParticleTypeClass

      public static Class<?> getParticleTypeClass()

    • getWorldTypeClass

      public static Class<?> getWorldTypeClass()
      Retrieve the WorldType class.
      Returns:
      The WorldType class.

    • getDataWatcherClass

      public static Class<?> getDataWatcherClass()
      Retrieve the DataWatcher class.
      Returns:
      The DataWatcher class.

    • getChunkPositionClass

      public static Class<?> getChunkPositionClass()
      Retrieves the ChunkPosition class.
      Returns:
      The ChunkPosition class.

    • getBlockPositionClass

      public static Class<?> getBlockPositionClass()
      Retrieves the BlockPosition class.
      Returns:
      The BlockPosition class.

    • getVec3DClass

      public static Class<?> getVec3DClass()
      Retrieves the Vec3D class.
      Returns:
      The Vec3D class.

    • getChunkCoordinatesClass

      public static Class<?> getChunkCoordinatesClass()
      Retrieve the ChunkCoordinates class.
      Returns:
      The ChunkPosition class.

    • getChunkCoordIntPair

      public static Class<?> getChunkCoordIntPair()
      Retrieve the ChunkCoordIntPair class.
      Returns:
      The ChunkCoordIntPair class.

    • getWatchableObjectClass

      public static Class<?> getWatchableObjectClass()
      Retrieve the WatchableObject class. Replaced by getDataWatcherItemClass()
      Returns:
      The WatchableObject class.

    • getDataWatcherItemClass

      public static Class<?> getDataWatcherItemClass()
      Retrieve the DataWatcher Item class.
      Returns:
      The class

    • getDataWatcherObjectClass

      public static Class<?> getDataWatcherObjectClass()

    • watcherObjectExists

      public static boolean watcherObjectExists()

    • getDataWatcherSerializerClass

      public static Class<?> getDataWatcherSerializerClass()

    • getDataWatcherRegistryClass

      public static Class<?> getDataWatcherRegistryClass()

    • getMinecraftKeyClass

      public static Class<?> getMinecraftKeyClass()

    • getMobEffectListClass

      public static Class<?> getMobEffectListClass()

    • getSoundEffectClass

      public static Class<?> getSoundEffectClass()

    • getServerConnectionClass

      public static Class<?> getServerConnectionClass()
      Retrieve the ServerConnection abstract class.
      Returns:
      The ServerConnection class.

    • getNBTBaseClass

      public static Class<?> getNBTBaseClass()
      Retrieve the NBT base class.
      Returns:
      The NBT base class.

    • getNBTReadLimiterClass

      public static Class<?> getNBTReadLimiterClass()
      Retrieve the NBT read limiter class.

      This is only supported in 1.7.8 (released 2014) and higher.

      Returns:
      The NBT read limiter.

    • getNBTCompoundClass

      public static Class<?> getNBTCompoundClass()
      Retrieve the NBT Compound class.
      Returns:
      The NBT Compond class.

    • getEntityTrackerClass

      public static Class<?> getEntityTrackerClass()
      Retrieve the EntityTracker (NMS) class.
      Returns:
      EntityTracker class.

    • getAttributeSnapshotClass

      public static Class<?> getAttributeSnapshotClass()
      Retrieve the attribute snapshot class.

      This stores the final value of an attribute, along with all the associated computational steps.

      Returns:
      The attribute snapshot class.

    • getIntHashMapClass

      public static Class<?> getIntHashMapClass()
      Retrieve the IntHashMap class.
      Returns:
      IntHashMap class.

    • getAttributeModifierClass

      public static Class<?> getAttributeModifierClass()
      Retrieve the attribute modifier class.
      Returns:
      Attribute modifier class.

    • getMobEffectClass

      public static Class<?> getMobEffectClass()
      Retrieve the net.minecraft.server.MobEffect class.
      Returns:
      The mob effect class.

    • getPacketDataSerializerClass

      public static Class<?> getPacketDataSerializerClass()
      Retrieve the packet data serializer class that overrides ByteBuf.
      Returns:
      The data serializer class.

    • getNbtCompressedStreamToolsClass

      public static Class<?> getNbtCompressedStreamToolsClass()
      Retrieve the NBTCompressedStreamTools class.
      Returns:
      The NBTCompressedStreamTools class.

    • getTileEntityClass

      public static Class<?> getTileEntityClass()
      Retrieve the NMS tile entity class.
      Returns:
      The tile entity class.

    • getMinecraftGsonClass

      public static Class<?> getMinecraftGsonClass()
      Retrieve the Gson class used by Minecraft.
      Returns:
      The Gson class.

    • getItemStackArrayClass

      public static Class<?> getItemStackArrayClass()
      Retrieve the ItemStack[] class.
      Returns:
      The ItemStack[] class.

    • getArrayClass

      public static Class<?> getArrayClass​(Class<?> componentType)
      Retrieve the array class of a given component type.
      Parameters:
      componentType - - type of each element in the array.
      Returns:
      The class of the array.

    • getCraftItemStackClass

      public static Class<?> getCraftItemStackClass()
      Retrieve the CraftItemStack class.
      Returns:
      The CraftItemStack class.

    • getCraftPlayerClass

      public static Class<?> getCraftPlayerClass()
      Retrieve the CraftPlayer class.
      Returns:
      CraftPlayer class.

    • getCraftWorldClass

      public static Class<?> getCraftWorldClass()
      Retrieve the CraftWorld class.
      Returns:
      The CraftWorld class.

    • getCraftEntityClass

      public static Class<?> getCraftEntityClass()
      Retrieve the CraftEntity class.
      Returns:
      CraftEntity class.

    • getCraftMessageClass

      public static Class<?> getCraftMessageClass()
      Retrieve the CraftChatMessage introduced in 1.7.2
      Returns:
      The CraftChatMessage class.

    • getPlayerInfoDataClass

      public static Class<?> getPlayerInfoDataClass()
      Retrieve the PlayerInfoData class in 1.8.
      Returns:
      The PlayerInfoData class

    • getEnumEntityUseActionClass

      public static Class<?> getEnumEntityUseActionClass()
      Retrieves the entity use action class in 1.17.
      Returns:
      The EntityUseAction class

    • getEntityUseActionEnumMethodAccessor

      public static MethodAccessor getEntityUseActionEnumMethodAccessor()
      Get a method accessor to get the actual use action out of the wrapping EnumEntityUseAction in 1.17.
      Returns:
      a method accessor to get the actual use action

    • getHandEntityUseActionEnumFieldAccessor

      public static FieldAccessor getHandEntityUseActionEnumFieldAccessor​(Object enumEntityUseAction)
      Get a field accessor for the hand in the wrapping EnumEntityUseAction in 1.17.
      Parameters:
      enumEntityUseAction - the object instance of the action, the field is not present in attack.
      Returns:
      a field accessor for the hand in the wrapping EnumEntityUseAction

    • getVec3EntityUseActionEnumFieldAccessor

      public static FieldAccessor getVec3EntityUseActionEnumFieldAccessor​(Object enumEntityUseAction)
      Get a field accessor for the vec3d in the wrapping EnumEntityUseAction in 1.17.
      Parameters:
      enumEntityUseAction - the object instance of the action, the field is not present in attack.
      Returns:
      a field accessor for the hand in the wrapping EnumEntityUseAction

    • isPlayerInfoData

      public static boolean isPlayerInfoData​(Object obj)
      Determine if the given object is a PlayerInfoData.
      Parameters:
      obj - - the given object.
      Returns:
      TRUE if it is, FALSE otherwise.

    • getIBlockDataClass

      public static Class<?> getIBlockDataClass()
      Retrieve the IBlockData class in 1.8.
      Returns:
      The IBlockData class

    • getMultiBlockChangeInfoClass

      public static Class<?> getMultiBlockChangeInfoClass()
      Retrieve the MultiBlockChangeInfo class in 1.8.
      Returns:
      The MultiBlockChangeInfo class

    • getMultiBlockChangeInfoArrayClass

      public static Class<?> getMultiBlockChangeInfoArrayClass()
      Retrieve the MultiBlockChangeInfo array class in 1.8.
      Returns:
      The MultiBlockChangeInfo array class

    • getGameStateClass

      public static Class<?> getGameStateClass()
      Retrieve the PacketPlayOutGameStateChange.a class, aka GameState in 1.16
      Returns:
      The GameState class

    • signUpdateExists

      public static boolean signUpdateExists()

    • getNonNullListClass

      public static Class<?> getNonNullListClass()

    • getNonNullListCreateAccessor

      public static MethodAccessor getNonNullListCreateAccessor()

    • getCraftSoundClass

      public static Class<?> getCraftSoundClass()

    • getSectionPositionClass

      public static Class<?> getSectionPositionClass()

    • getBukkitItemStack

      public static org.bukkit.inventory.ItemStack getBukkitItemStack​(Object generic)
      Retrieves the Bukkit equivalent of a NMS ItemStack. This method should preserve NBT data and will never return null when supplied with a valid ItemStack. Empty ItemStacks are treated as AIR.
      Parameters:
      generic - NMS ItemStack
      Returns:
      The Bukkit equivalent

    • getMinecraftItemStack

      public static Object getMinecraftItemStack​(org.bukkit.inventory.ItemStack specific)
      Retrieves the NMS equivalent of a Bukkit ItemStack. This method will never return null and should preserve NBT data. Null inputs are treated as empty (AIR) ItemStacks.
      Parameters:
      specific - Bukkit ItemStack
      Returns:
      The NMS equivalent

    • getCraftBukkitClass

      public static Class<?> getCraftBukkitClass​(String className)
      Retrieve the class object of a specific CraftBukkit class.
      Parameters:
      className - - the specific CraftBukkit class.
      Returns:
      Class object.
      Throws:
      RuntimeException - If we are unable to find the given class.

    • getMinecraftClass

      public static Class<?> getMinecraftClass​(String className)
      Retrieve the class object of a specific Minecraft class.
      Parameters:
      className - - the specific Minecraft class.
      Returns:
      Class object.
      Throws:
      RuntimeException - If we are unable to find the given class.

    • getNullableNMS

      public static Class<?> getNullableNMS​(String className, String... aliases)

    • getMinecraftClass

      public static Class<?> getMinecraftClass​(String className, String... aliases)
      Retrieve the first class that matches a specified Minecraft name.
      Parameters:
      className - - the specific Minecraft class.
      aliases - - alternative names for this Minecraft class.
      Returns:
      Class object.
      Throws:
      RuntimeException - If we are unable to find any of the given classes.

    • getMinecraftLibraryClass

      public static Class<?> getMinecraftLibraryClass​(String className)
      Retrieve the class object of a specific Minecraft library class.
      Parameters:
      className - - the specific library Minecraft class.
      Returns:
      Class object.
      Throws:
      RuntimeException - If we are unable to find the given class.

    • getNetworkManagerName

      public static String getNetworkManagerName()
      Dynamically retrieve the NetworkManager name.
      Returns:
      Name of the NetworkManager class.

    • getNetLoginHandlerName

      public static String getNetLoginHandlerName()
      Dynamically retrieve the name of the current NetLoginHandler.
      Returns:
      Name of the NetLoginHandler class.

    • getPacketDataSerializer

      public static Object getPacketDataSerializer​(Object buffer)
      Retrieve an instance of the packet data serializer wrapper.
      Parameters:
      buffer - - the buffer.
      Returns:
      The instance.

    • getNbtTagTypes

      public static Class<?> getNbtTagTypes()

    • getChatDeserializer

      public static Class<?> getChatDeserializer()

    • getDimensionManager

      public static Class<?> getDimensionManager()

    • getMerchantRecipeList

      public static Class<?> getMerchantRecipeList()

    • getResourceKey

      public static Class<?> getResourceKey()

    • getEntityTypes

      public static Class<?> getEntityTypes()

    • getParticleParam

      public static Class<?> getParticleParam()

    • getSectionPosition

      public static Class<?> getSectionPosition()

    • getChunkProviderServer

      public static Class<?> getChunkProviderServer()

    • getPlayerChunkMap

      public static Class<?> getPlayerChunkMap()

    • getIRegistry

      public static Class<?> getIRegistry()

    • getAttributeBase

      public static Class<?> getAttributeBase()

    • getFastUtilClass

      public static Class<?> getFastUtilClass​(String className)

    • getInt2ObjectMapClass

      public static Class<?> getInt2ObjectMapClass()

    • getIntArrayListClass

      public static Class<?> getIntArrayListClass()