com.comphenix.protocol.injector

Class PacketConstructor

java.lang.Object

com.comphenix.protocol.injector.PacketConstructor

public class PacketConstructor
extends java.lang.Object

A packet constructor that uses an internal Minecraft.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PacketConstructor.Unwrapper Represents a unwrapper for a constructor parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static PacketConstructor	DEFAULT A packet constructor that automatically converts Bukkit types to their NMS conterpart.

Method Summary

Methods

Modifier and Type	Method and Description
PacketContainer	createPacket(java.lang.Object... values) Construct a packet using the special builtin Minecraft constructors.
static java.lang.Class<?>	getClass(java.lang.Object obj) Retrieve the class of an object, or just the class if it already is a class object.
int	getPacketID() Deprecated.
PacketType	getType() Retrieve the type of the packets this constructor creates.
com.google.common.collect.ImmutableList<PacketConstructor.Unwrapper>	getUnwrappers()
PacketConstructor	withPacket(int id, java.lang.Object[] values) Deprecated.
PacketConstructor	withPacket(PacketType type, java.lang.Object[] values) Create a packet constructor that creates packets using the given types.
PacketConstructor	withUnwrappers(java.util.List<PacketConstructor.Unwrapper> unwrappers) Return a copy of the current constructor with a different list of unwrappers.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static PacketConstructor DEFAULT

A packet constructor that automatically converts Bukkit types to their NMS conterpart.

Remember to call withPacket().

Method Detail

getUnwrappers

public com.google.common.collect.ImmutableList<PacketConstructor.Unwrapper> getUnwrappers()

getPacketID

@Deprecated
public int getPacketID()

Deprecated.

Retrieve the id of the packets this constructor creates.

Deprecated: Use getType() instead.

Returns:

The ID of the packets this constructor will create.

getType

public PacketType getType()

Retrieve the type of the packets this constructor creates.

Returns:

The type of the created packets.

withUnwrappers

public PacketConstructor withUnwrappers(java.util.List<PacketConstructor.Unwrapper> unwrappers)

Return a copy of the current constructor with a different list of unwrappers.

Parameters:

unwrappers - - list of unwrappers that convert Bukkit wrappers into the equivalent NMS classes.

Returns:

A constructor with a different set of unwrappers.

withPacket

@Deprecated
public PacketConstructor withPacket(int id,
                                      java.lang.Object[] values)

Deprecated.

Create a packet constructor that creates packets using the given ID.

Note that if you pass a Class as a value, it will use its type directly.

Deprecated: Use withPacket(PacketType, Object[]) instead.

Parameters:

id - - legacy (1.6.4) packet ID.

values - - the values that will match each parameter in the desired constructor.

Returns:

A packet constructor with these types.

Throws:

java.lang.IllegalArgumentException - If no packet constructor could be created with these types.

withPacket

public PacketConstructor withPacket(PacketType type,
                           java.lang.Object[] values)

Create a packet constructor that creates packets using the given types.

Note that if you pass a Class as a value, it will use its type directly.

Parameters:

type - - the type of the packet to create.

values - - the values that will match each parameter in the desired constructor.

Returns:

A packet constructor with these types.

Throws:

java.lang.IllegalArgumentException - If no packet constructor could be created with these types.

createPacket

public PacketContainer createPacket(java.lang.Object... values)
                             throws FieldAccessException

Construct a packet using the special builtin Minecraft constructors.

Parameters:

values - - values containing Bukkit wrapped items to pass to Minecraft.

Returns:

The created packet.

Throws:

FieldAccessException - Failure due to a security limitation.

java.lang.IllegalArgumentException - Arguments doesn't match the constructor.

java.lang.RuntimeException - Minecraft threw an exception.

getClass

public static java.lang.Class<?> getClass(java.lang.Object obj)

Retrieve the class of an object, or just the class if it already is a class object.

Parameters:

obj - - the object.

Returns:

The class of an object.