Package com.comphenix.protocol.events

Class PacketContainer

java.lang.Object

com.comphenix.protocol.events.AbstractStructure

com.comphenix.protocol.events.PacketContainer

All Implemented Interfaces:

Serializable

public class PacketContainer
extends AbstractStructure
implements Serializable

Represents a Minecraft packet indirectly.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.comphenix.protocol.events.AbstractStructure

handle, structureModifier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PacketContainer()	For serialization.
	PacketContainer(PacketType type)	Creates a packet container for a new packet.
	PacketContainer(PacketType type, Object handle)	Creates a packet container for an existing packet.
	PacketContainer(PacketType type, Object handle, StructureModifier<Object> structure)	Creates a packet container for an existing packet.

Method Summary

Modifier and Type	Method	Description
static io.netty.buffer.ByteBuf	createPacketBuffer()	Deprecated. use MinecraftReflection.createPacketDataSerializer(int) instead
PacketContainer	deepClone()	Create a deep copy of the current packet.
static Object	deserializeFromBuffer(PacketType packetType, Object buffer)
static PacketContainer	fromPacket(Object packet)	Construct a new packet container from a given handle.
Object	getHandle()	Retrieves the underlying Minecraft packet.
int	getId()	Deprecated. Packet IDs are unreliable
<T> Optional<T>	getMeta(String key)	Gets the metadata value for a given key if it exists.
StructureModifier<Object>	getModifier()	Retrieves the generic structure modifier for this packet.
StructureModifier<Optional<InternalStructure>>	getOptionalStructures()
StructureModifier<InternalStructure>	getStructures()
PacketType	getType()	Retrieve the packet type of this packet.
void	removeMeta(String key)	Removes the metadata for a given key if it exists.
Object	serializeToBuffer()
<T> void	setMeta(String key, T value)	Sets the metadata value at a given key.
PacketContainer	shallowClone()	Create a shallow copy of the current packet.
String	toString()

Methods inherited from class com.comphenix.protocol.events.AbstractStructure

getAttributeCollectionModifier, getBlockData, getBlockDataArrays, getBlockEntityTypeModifier, getBlockPositionCollectionModifier, getBlockPositionModifier, getBlocks, getBooleans, getByteArrays, getByteArraySerializer, getBytes, getChatComponentArrays, getChatComponents, getChatFormattings, getChatTypes, getChatVisibilities, getChunkCoordIntPairs, getClientCommands, getClientIntents, getCombatEvents, getCustomPacketPayloads, getDataValueCollectionModifier, getDataWatcherModifier, getDifficulties, getDimensions, getDimensionTypes, getDirections, getDisplaySlots, getDoubles, getEffectTypes, getEithers, getEntityModifier, getEntityModifier, getEntityTypeModifier, getEntityUseActions, getEnumEntityUseActions, getEnumModifier, getEnumModifier, getFloat, getGameModes, getGameProfiles, getGameStateIDs, getHands, getHolders, getInstants, getIntegerArrays, getIntegers, getIntLists, getItemArrayModifier, getItemListModifier, getItemModifier, getItemSlots, getLevelChunkData, getLightUpdateData, getListNbtModifier, getLists, getLoginSignatures, getLongs, getMaps, getMerchantRecipeLists, getMessageSignatures, getMinecraftKeys, getMovingBlockPositions, getMultiBlockChangeInfoArrays, getNbtModifier, getNewParticles, getNumberFormats, getOptionals, getOptionalTeamParameters, getPacketBundles, getParticles, getPlayerActions, getPlayerDigTypes, getPlayerInfoAction, getPlayerInfoActions, getPlayerInfoDataLists, getProfilePublicKeyData, getProfilePublicKeys, getProtocols, getRegistrableModifier, getRemoteChatSessionData, getRenderTypes, getResourcePackStatus, getScoreboardActions, getSectionPositions, getServerPings, getSets, getShortArrays, getShorts, getSignatures, getSlotStackPairLists, getSoundCategories, getSoundEffects, getSpecificModifier, getStatisticMaps, getStringArrays, getStrings, getTitleActions, getUUIDLists, getUUIDs, getVectors, getWatchableCollectionModifier, getWorldBorderActions, getWorldKeys, getWorldTypeModifier

Methods inherited from class java.lang.Object

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

Constructor Details

PacketContainer

public PacketContainer(PacketType type)

Creates a packet container for a new packet.

Parameters:

type - - the type of the packet to create.

PacketContainer

public PacketContainer(PacketType type,
 Object handle)

Creates a packet container for an existing packet.

Parameters:

type - - Type of the given packet.

handle - - contained packet.

PacketContainer

public PacketContainer(PacketType type,
 Object handle,
 StructureModifier<Object> structure)

Creates a packet container for an existing packet.

Parameters:

type - - Type of the given packet.

handle - - contained packet.

structure - - structure modifier.

PacketContainer

protected PacketContainer()

For serialization.

Method Details

fromPacket

public static PacketContainer fromPacket(Object packet)

Construct a new packet container from a given handle.

Parameters:

packet - - the NMS packet.

Returns:

The packet container.

getHandle

public Object getHandle()

Retrieves the underlying Minecraft packet.

Overrides:

getHandle in class AbstractStructure

Returns:

Underlying Minecraft packet.

getModifier

public StructureModifier<Object> getModifier()

Retrieves the generic structure modifier for this packet.

Overrides:

getModifier in class AbstractStructure

Returns:

Structure modifier.

getStructures

public StructureModifier<InternalStructure> getStructures()

getOptionalStructures

public StructureModifier<Optional<InternalStructure>> getOptionalStructures()

getId

@Deprecated
public int getId()

Deprecated.

Packet IDs are unreliable

getType

public PacketType getType()

Retrieve the packet type of this packet.

Returns:

The packet type.

shallowClone

public PacketContainer shallowClone()

Create a shallow copy of the current packet.

This merely writes the content of each field to the new class directly, without performing any expensive copies.

Returns:

A shallow copy of the current packet.

deepClone

public PacketContainer deepClone()

Create a deep copy of the current packet.

This will perform a full copy of the entire object tree, only skipping known immutable objects and primitive types.

Note that the inflated buffers in packet 51 and 56 will be copied directly to save memory.

Returns:

A deep copy of the current packet.

createPacketBuffer

@Deprecated
public static io.netty.buffer.ByteBuf createPacketBuffer()

Deprecated.

use MinecraftReflection.createPacketDataSerializer(int) instead

Construct a new packet data serializer.

Returns:

The packet data serializer.

deserializeFromBuffer

public static Object deserializeFromBuffer(PacketType packetType,
 Object buffer)

serializeToBuffer

public Object serializeToBuffer()

getMeta

public <T> Optional<T> getMeta(String key)

Gets the metadata value for a given key if it exists. Packet metadata expires after a minute, which is far longer than a packet will ever be held in processing.

Type Parameters:

T - Metadata type

Parameters:

key - Metadata key

Returns:

The metadata value, or an empty optional

setMeta

public <T> void setMeta(String key,
 T value)

Sets the metadata value at a given key. Packet metadata expires after a minute, which is far longer than a packet will ever be held in processing.

Type Parameters:

T - Metadata type

Parameters:

key - Metadata key

value - Metadata value

removeMeta

public void removeMeta(String key)

Removes the metadata for a given key if it exists.

Parameters:

key - Key to remove meta for

toString

public String toString()

Overrides:

toString in class Object