com.comphenix.protocol.injector.packet

Class PacketRegistry

java.lang.Object

com.comphenix.protocol.injector.packet.PacketRegistry

public class PacketRegistry
extends Object

Static packet registry in Minecraft.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_CORRECT_TROVE_MAP
static ReportType	REPORT_INSUFFICIENT_CLIENT_PACKETS
static ReportType	REPORT_INSUFFICIENT_SERVER_PACKETS

Constructor Summary

Constructors

Constructor and Description
PacketRegistry()

Method Summary

Modifier and Type	Method and Description
static Set<Integer>	getClientPackets() Deprecated.
static Set<PacketType>	getClientPacketTypes() Retrieve every known and supported server packet type.
static Map<Integer,Class>	getOverwrittenPackets() Deprecated.
static Class	getPacketClassFromID(int packetID) Deprecated.
static Class	getPacketClassFromID(int packetID, boolean forceVanilla) Deprecated.
static Class	getPacketClassFromType(PacketType type) Retrieves the correct packet class from a given type.
static Class	getPacketClassFromType(PacketType type, boolean forceVanilla) Retrieves the correct packet class from a given type.
static int	getPacketID(Class<?> packet) Deprecated.
static Map<Class,Integer>	getPacketToID() Deprecated.
static Map<Class,PacketType>	getPacketToType() Retrieve a map of every packet class to the respective packet type.
static PacketType	getPacketType(Class<?> packet) Retrieve the packet type of a given packet.
static PacketType	getPacketType(Class<?> packet, PacketType.Sender sender) Retrieve the packet type of a given packet.
static Map<Integer,Class>	getPreviousPackets() Deprecated.
static Set<Integer>	getServerPackets() Deprecated.
static Set<PacketType>	getServerPacketTypes() Retrieve every known and supported server packet type.
static boolean	isSupported(PacketType type) Determine if the given packet type is supported on the current server.
static Set<Integer>	toLegacy(Set<PacketType> types) Convert a set of packet types to a set of integers based on the legacy packet ID.
static Set<PacketType>	toPacketTypes(Set<Integer> ids) Convert a set of legacy packet IDs to packet types.
static Set<PacketType>	toPacketTypes(Set<Integer> ids, PacketType.Sender preference) Convert a set of legacy packet IDs to packet types.

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_CANNOT_CORRECT_TROVE_MAP

public static final ReportType REPORT_CANNOT_CORRECT_TROVE_MAP

REPORT_INSUFFICIENT_SERVER_PACKETS

public static final ReportType REPORT_INSUFFICIENT_SERVER_PACKETS

REPORT_INSUFFICIENT_CLIENT_PACKETS

public static final ReportType REPORT_INSUFFICIENT_CLIENT_PACKETS

Constructor Detail

PacketRegistry

public PacketRegistry()

Method Detail

isSupported

public static boolean isSupported(PacketType type)

Determine if the given packet type is supported on the current server.

Parameters:

type - - the type to check.

Returns:

TRUE if it is, FALSE otherwise.

getPacketToID

@Deprecated
public static Map<Class,Integer> getPacketToID()

Deprecated.

Retrieve a map of every packet class to every ID.

Deprecated: Use getPacketToType() instead.

Returns:

A map of packet classes and their corresponding ID.

getPacketToType

public static Map<Class,PacketType> getPacketToType()

Retrieve a map of every packet class to the respective packet type.

Returns:

A map of packet classes and their corresponding packet type.

getOverwrittenPackets

@Deprecated
public static Map<Integer,Class> getOverwrittenPackets()

Deprecated.

Retrieve the injected proxy classes handlig each packet ID.

This is not supported in 1.7.2 and later.

Returns:

Injected classes.

getPreviousPackets

@Deprecated
public static Map<Integer,Class> getPreviousPackets()

Deprecated.

Retrieve the vanilla classes handling each packet ID.

Returns:

Vanilla classes.

getServerPackets

@Deprecated
public static Set<Integer> getServerPackets()
                                                  throws FieldAccessException

Deprecated.

Retrieve every known and supported server packet.

Deprecated: Use getServerPacketTypes() instead.

Returns:

An immutable set of every known server packet.

Throws:

FieldAccessException - If we're unable to retrieve the server packet data from Minecraft.

getServerPacketTypes

public static Set<PacketType> getServerPacketTypes()

Retrieve every known and supported server packet type.

Returns:

Every server packet type.

getClientPackets

@Deprecated
public static Set<Integer> getClientPackets()
                                                  throws FieldAccessException

Deprecated.

Retrieve every known and supported client packet.

Deprecated: Use getClientPacketTypes() instead.

Returns:

An immutable set of every known client packet.

Throws:

FieldAccessException - If we're unable to retrieve the client packet data from Minecraft.

getClientPacketTypes

public static Set<PacketType> getClientPacketTypes()

Retrieve every known and supported server packet type.

Returns:

Every server packet type.

toLegacy

public static Set<Integer> toLegacy(Set<PacketType> types)

Convert a set of packet types to a set of integers based on the legacy packet ID.

Parameters:

types - - packet type.

Returns:

Set of integers.

toPacketTypes

public static Set<PacketType> toPacketTypes(Set<Integer> ids)

Convert a set of legacy packet IDs to packet types.

Parameters:

ids - - legacy packet IDs.

Returns:

Set of packet types.

toPacketTypes

public static Set<PacketType> toPacketTypes(Set<Integer> ids,
                                            PacketType.Sender preference)

Convert a set of legacy packet IDs to packet types.

Parameters:

ids - - legacy packet IDs.

preference - - the sender preference, if any.

Returns:

Set of packet types.

getPacketClassFromID

@Deprecated
public static Class getPacketClassFromID(int packetID)

Deprecated.

Retrieves the correct packet class from a given packet ID.

Deprecated: Use getPacketClassFromType(PacketType) instead.

Parameters:

packetID - - the packet ID.

Returns:

The associated class.

getPacketClassFromType

public static Class getPacketClassFromType(PacketType type)

Retrieves the correct packet class from a given type.

Parameters:

type - - the packet type.

Returns:

The associated class.

getPacketClassFromType

public static Class getPacketClassFromType(PacketType type,
                                           boolean forceVanilla)

Retrieves the correct packet class from a given type.

Note that forceVanillla will be ignored on MC 1.7.2 and later.

Parameters:

type - - the packet type.

forceVanilla - - whether or not to look for vanilla classes, not injected classes.

Returns:

The associated class.

getPacketClassFromID

@Deprecated
public static Class getPacketClassFromID(int packetID,
                                                      boolean forceVanilla)

Deprecated.

Retrieves the correct packet class from a given packet ID.

This method has been deprecated.

Parameters:

packetID - - the packet ID.

forceVanilla - - whether or not to look for vanilla classes, not injected classes.

Returns:

The associated class.

getPacketID

@Deprecated
public static int getPacketID(Class<?> packet)

Deprecated.

Retrieve the packet ID of a given packet.

Deprecated: Use getPacketType(Class).

Parameters:

packet - - the type of packet to check.

Returns:

The legacy ID of the given packet.

Throws:

IllegalArgumentException - If this is not a valid packet.

getPacketType

public static PacketType getPacketType(Class<?> packet)

Retrieve the packet type of a given packet.

Parameters:

packet - - the class of the packet.

Returns:

The packet type, or NULL if not found.

getPacketType

public static PacketType getPacketType(Class<?> packet,
                                       PacketType.Sender sender)

Retrieve the packet type of a given packet.

Parameters:

packet - - the class of the packet.

sender - - the sender of the packet, or NULL.

Returns:

The packet type, or NULL if not found.