PacketContainer

java.lang.Object
- com.comphenix.protocol.events.PacketContainer

All Implemented Interfaces:

java.io.Serializable
```
public class PacketContainer
extends java.lang.Object
implements java.io.Serializable
```
Represents a Minecraft packet indirectly.

Author:

Kristian

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Object handle

protected StructureModifier<java.lang.Object> structureModifier

protected PacketType type

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`handle`
`protected StructureModifier<java.lang.Object>`	`structureModifier`
`protected PacketType`	`type`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PacketContainer()` For serialization.
	`PacketContainer(int id)` Deprecated.
	`PacketContainer(int id, java.lang.Object handle)` Deprecated.
	`PacketContainer(int id, java.lang.Object handle, StructureModifier<java.lang.Object> structure)` Deprecated.
	`PacketContainer(PacketType type)` Creates a packet container for a new packet.
	`PacketContainer(PacketType type, java.lang.Object handle)` Creates a packet container for an existing packet.
	`PacketContainer(PacketType type, java.lang.Object handle, StructureModifier<java.lang.Object> structure)` Creates a packet container for an existing packet.

Method Summary

Methods
Modifier and Type	Method and Description
`PacketContainer`	`deepClone()` Create a deep copy of the current packet.
`StructureModifier<java.util.List<WrappedAttribute>>`	`getAttributeCollectionModifier()` Retrieves a read/write structure for collections of attribute snapshots.
`StructureModifier<org.bukkit.Material>`	`getBlocks()` Retrieves a read/write structure for block fields.
`StructureModifier<java.lang.Boolean>`	`getBooleans()` Retrieves a read/write structure for every boolean field.
`StructureModifier<byte[]>`	`getByteArrays()` Retrieves a read/write structure for every byte array field.
`StreamSerializer`	`getByteArraySerializer()` Retrieve a serializer for reading and writing ItemStacks stored in a byte array.
`StructureModifier<java.lang.Byte>`	`getBytes()` Retrieves a read/write structure for every byte field.
`StructureModifier<WrappedChatComponent>`	`getChatComponents()` Retrieves a read/write structure for chat components in Minecraft 1.7.2.
`StructureModifier<EnumWrappers.ChatVisibility>`	`getChatVisibilities()` Retrieve a read/write structure for the ChatVisibility enum in 1.7.2.
`StructureModifier<ChunkCoordIntPair>`	`getChunkCoordIntPairs()` Retrieves a read/write structure for wrapped ChunkCoordIntPairs.
`StructureModifier<EnumWrappers.ClientCommand>`	`getClientCommands()` Retrieve a read/write structure for the ClientCommand enum in 1.7.2.
`StructureModifier<WrappedDataWatcher>`	`getDataWatcherModifier()` Retrieves a read/write structure for data watchers.
`StructureModifier<EnumWrappers.Difficulty>`	`getDifficulties()` Retrieve a read/write structure for the Difficulty enum in 1.7.2.
`StructureModifier<java.lang.Double>`	`getDoubles()` Retrieves a read/write structure for every double field.
`StructureModifier<org.bukkit.entity.Entity>`	`getEntityModifier(PacketEvent event)` Retrieves a read/write structure for entity objects.
`StructureModifier<org.bukkit.entity.Entity>`	`getEntityModifier(org.bukkit.World world)` Retrieves a read/write structure for entity objects.
`StructureModifier<EnumWrappers.EntityUseAction>`	`getEntityUseActions()` Retrieve a read/write structure for the EntityUse enum in 1.7.2.
`StructureModifier<java.lang.Float>`	`getFloat()` Retrieves a read/write structure for every float field.
`StructureModifier<EnumWrappers.NativeGameMode>`	`getGameModes()` Retrieve a read/write structure for the NativeGameMode enum in 1.7.2.
`StructureModifier<WrappedGameProfile>`	`getGameProfiles()` Retrieves a read/write structure for game profiles in Minecraft 1.7.2.
`java.lang.Object`	`getHandle()` Retrieves the underlying Minecraft packet.
`int`	`getID()` Deprecated.
`StructureModifier<int[]>`	`getIntegerArrays()` Retrieves a read/write structure for every int array field.
`StructureModifier<java.lang.Integer>`	`getIntegers()` Retrieves a read/write structure for every integer field.
`StructureModifier<org.bukkit.inventory.ItemStack[]>`	`getItemArrayModifier()` Retrieves a read/write structure for arrays of ItemStacks.
`StructureModifier<org.bukkit.inventory.ItemStack>`	`getItemModifier()` Retrieves a read/write structure for ItemStack.
`StructureModifier<java.lang.Long>`	`getLongs()` Retrieves a read/write structure for every long field.
`StructureModifier<java.lang.Object>`	`getModifier()` Retrieves the generic structure modifier for this packet.
`StructureModifier<NbtBase<?>>`	`getNbtModifier()` Retrieves a read/write structure for NBT classes.
`StructureModifier<java.util.List<ChunkPosition>>`	`getPositionCollectionModifier()` Retrieves a read/write structure for collections of chunk positions.
`StructureModifier<ChunkPosition>`	`getPositionModifier()` Retrieves a read/write structure for chunk positions.
`StructureModifier<PacketType.Protocol>`	`getProtocols()` Retrieve a read/write structure for the Protocol enum in 1.7.2.
`StructureModifier<WrappedServerPing>`	`getServerPings()` Retrieve a read/write structure for the ServerPing fields in the following packet: `PacketType.Status.Server#OUT_SERVER_INFO`
`StructureModifier<java.lang.Short>`	`getShorts()` Retrieves a read/write structure for every short field.
`<T> StructureModifier<T>`	`getSpecificModifier(java.lang.Class<T> primitiveType)` Retrieves a read/write structure for every field with the given type.
`StructureModifier<java.util.Map<WrappedStatistic,java.lang.Integer>>`	`getStatisticMaps()` Retrieve a read/write structure for maps of statistics.
`StructureModifier<java.lang.String[]>`	`getStringArrays()` Retrieves a read/write structure for every String array field.
`StructureModifier<java.lang.String>`	`getStrings()` Retrieves a read/write structure for every String field.
`PacketType`	`getType()` Retrieve the packet type of this packet.
`StructureModifier<java.util.List<WrappedWatchableObject>>`	`getWatchableCollectionModifier()` Retrieves a read/write structure for collections of watchable objects.
`StructureModifier<org.bukkit.WorldType>`	`getWorldTypeModifier()` Retrieves a read/write structure for the world type enum.
`PacketContainer`	`shallowClone()` Create a shallow copy of the current packet.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
protected PacketType type
```
  - handle
```
protected transient java.lang.Object handle
```
  - structureModifier
```
protected transient StructureModifier<java.lang.Object> structureModifier
```
- Constructor Detail
  - PacketContainer
```
@Deprecated
public PacketContainer(int id)
```
    Deprecated.
    
    Creates a packet container for a new packet.
    Deprecated: Use PacketContainer(PacketType) instead.
    
    Parameters:
    id - - ID of the packet to create.
  - PacketContainer
```
@Deprecated
public PacketContainer(int id,
                          java.lang.Object handle)
```
    Deprecated.
    
    Creates a packet container for an existing packet.
    Deprecated: Use #PacketContainer(PacketType, Object)) instead.
    
    Parameters:
    id - - ID of the given packet.
    handle - - contained packet.
  - PacketContainer
```
@Deprecated
public PacketContainer(int id,
                          java.lang.Object handle,
                          StructureModifier<java.lang.Object> structure)
```
    Deprecated.
    
    Creates a packet container for an existing packet.
    Deprecated: Use #PacketContainer(PacketType, Object, StructureModifier)) instead.
    
    Parameters:
    id - - ID of the given packet.
    handle - - contained packet.
    structure - - structure modifier.
  - 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,
               java.lang.Object handle)
```
    Creates a packet container for an existing packet.
    
    Parameters:
    id - - ID of the given packet.
    handle - - contained packet.
  - PacketContainer
```
public PacketContainer(PacketType type,
               java.lang.Object handle,
               StructureModifier<java.lang.Object> structure)
```
    Creates a packet container for an existing packet.
    
    Parameters:
    id - - ID of the given packet.
    handle - - contained packet.
    structure - - structure modifier.
  - PacketContainer
```
protected PacketContainer()
```
    For serialization.
- Method Detail
  - getHandle
```
public java.lang.Object getHandle()
```
    Retrieves the underlying Minecraft packet.
    
    Returns:
    Underlying Minecraft packet.
  - getModifier
```
public StructureModifier<java.lang.Object> getModifier()
```
    Retrieves the generic structure modifier for this packet.
    
    Returns:
    Structure modifier.
  - getSpecificModifier
```
public <T> StructureModifier<T> getSpecificModifier(java.lang.Class<T> primitiveType)
```
    Retrieves a read/write structure for every field with the given type.
    
    Parameters:
    primitiveType - - the type to find.
    
    Returns:
    A modifier for this specific type.
  - getBytes
```
public StructureModifier<java.lang.Byte> getBytes()
```
    Retrieves a read/write structure for every byte field.
    
    Returns:
    A modifier for every byte field.
  - getBooleans
```
public StructureModifier<java.lang.Boolean> getBooleans()
```
    Retrieves a read/write structure for every boolean field.
    
    Returns:
    A modifier for every boolean field.
  - getShorts
```
public StructureModifier<java.lang.Short> getShorts()
```
    Retrieves a read/write structure for every short field.
    
    Returns:
    A modifier for every short field.
  - getIntegers
```
public StructureModifier<java.lang.Integer> getIntegers()
```
    Retrieves a read/write structure for every integer field.
    
    Returns:
    A modifier for every integer field.
  - getLongs
```
public StructureModifier<java.lang.Long> getLongs()
```
    Retrieves a read/write structure for every long field.
    
    Returns:
    A modifier for every long field.
  - getFloat
```
public StructureModifier<java.lang.Float> getFloat()
```
    Retrieves a read/write structure for every float field.
    
    Returns:
    A modifier for every float field.
  - getDoubles
```
public StructureModifier<java.lang.Double> getDoubles()
```
    Retrieves a read/write structure for every double field.
    
    Returns:
    A modifier for every double field.
  - getStrings
```
public StructureModifier<java.lang.String> getStrings()
```
    Retrieves a read/write structure for every String field.
    
    Returns:
    A modifier for every String field.
  - getStringArrays
```
public StructureModifier<java.lang.String[]> getStringArrays()
```
    Retrieves a read/write structure for every String array field.
    
    Returns:
    A modifier for every String array field.
  - getByteArrays
```
public StructureModifier<byte[]> getByteArrays()
```
    Retrieves a read/write structure for every byte array field.
    
    Returns:
    A modifier for every byte array field.
  - getByteArraySerializer
```
public StreamSerializer getByteArraySerializer()
```
    Retrieve a serializer for reading and writing ItemStacks stored in a byte array.
    
    Returns:
    A instance of the serializer.
  - getIntegerArrays
```
public StructureModifier<int[]> getIntegerArrays()
```
    Retrieves a read/write structure for every int array field.
    
    Returns:
    A modifier for every int array field.
  - getItemModifier
```
public StructureModifier<org.bukkit.inventory.ItemStack> getItemModifier()
```
    Retrieves a read/write structure for ItemStack.
    This modifier will automatically marshall between the Bukkit ItemStack and the internal Minecraft ItemStack.
    
    Returns:
    A modifier for ItemStack fields.
  - getItemArrayModifier
```
public StructureModifier<org.bukkit.inventory.ItemStack[]> getItemArrayModifier()
```
    Retrieves a read/write structure for arrays of ItemStacks.
    This modifier will automatically marshall between the Bukkit ItemStack and the internal Minecraft ItemStack.
    
    Returns:
    A modifier for ItemStack array fields.
  - getStatisticMaps
```
public StructureModifier<java.util.Map<WrappedStatistic,java.lang.Integer>> getStatisticMaps()
```
    Retrieve a read/write structure for maps of statistics.
    Note that you must write back the changed map to persist it.
    
    Returns:
    A modifier for maps of statistics.
  - getWorldTypeModifier
```
public StructureModifier<org.bukkit.WorldType> getWorldTypeModifier()
```
    Retrieves a read/write structure for the world type enum.
    This modifier will automatically marshall between the Bukkit world type and the internal Minecraft world type.
    
    Returns:
    A modifier for world type fields.
  - getDataWatcherModifier
```
public StructureModifier<WrappedDataWatcher> getDataWatcherModifier()
```
    Retrieves a read/write structure for data watchers.
    
    Returns:
    A modifier for data watchers.
  - getEntityModifier
```
public StructureModifier<org.bukkit.entity.Entity> getEntityModifier(@Nonnull
                                                            org.bukkit.World world)
```
    Retrieves a read/write structure for entity objects.
    Note that entities are transmitted by integer ID, and the type may not be enough to distinguish between entities and other values. Thus, this structure modifier MAY return null or invalid entities for certain fields. Using the correct index is essential.
    
    Parameters:
    world - - the world each entity is currently occupying.
    
    Returns:
    A modifier entity types.
  - getEntityModifier
```
public StructureModifier<org.bukkit.entity.Entity> getEntityModifier(@Nonnull
                                                            PacketEvent event)
```
    Retrieves a read/write structure for entity objects.
    Note that entities are transmitted by integer ID, and the type may not be enough to distinguish between entities and other values. Thus, this structure modifier MAY return null or invalid entities for certain fields. Using the correct index is essential.
    
    Parameters:
    event - - the original packet event.
    
    Returns:
    A modifier entity types.
  - getPositionModifier
```
public StructureModifier<ChunkPosition> getPositionModifier()
```
    Retrieves a read/write structure for chunk positions.
    
    Returns:
    A modifier for a ChunkPosition.
  - getChunkCoordIntPairs
```
public StructureModifier<ChunkCoordIntPair> getChunkCoordIntPairs()
```
    Retrieves a read/write structure for wrapped ChunkCoordIntPairs.
    
    Returns:
    A modifier for ChunkCoordIntPair.
  - getNbtModifier
```
public StructureModifier<NbtBase<?>> getNbtModifier()
```
    Retrieves a read/write structure for NBT classes.
    
    Returns:
    A modifier for NBT classes.
  - getAttributeCollectionModifier
```
public StructureModifier<java.util.List<WrappedAttribute>> getAttributeCollectionModifier()
```
    Retrieves a read/write structure for collections of attribute snapshots.
    This modifier will automatically marshall between the visible ProtocolLib WrappedAttribute and the internal Minecraft AttributeSnapshot.
    
    Returns:
    A modifier for AttributeSnapshot collection fields.
  - getPositionCollectionModifier
```
public StructureModifier<java.util.List<ChunkPosition>> getPositionCollectionModifier()
```
    Retrieves a read/write structure for collections of chunk positions.
    This modifier will automatically marshall between the visible ProtocolLib ChunkPosition and the internal Minecraft ChunkPosition.
    
    Returns:
    A modifier for ChunkPosition list fields.
  - getWatchableCollectionModifier
```
public StructureModifier<java.util.List<WrappedWatchableObject>> getWatchableCollectionModifier()
```
    Retrieves a read/write structure for collections of watchable objects.
    This modifier will automatically marshall between the visible WrappedWatchableObject and the internal Minecraft WatchableObject.
    
    Returns:
    A modifier for watchable object list fields.
  - getBlocks
```
public StructureModifier<org.bukkit.Material> getBlocks()
```
    Retrieves a read/write structure for block fields.
    This modifier will automatically marshall between Material and the internal Minecraft Block.
    
    Returns:
    A modifier for GameProfile fields.
  - getGameProfiles
```
public StructureModifier<WrappedGameProfile> getGameProfiles()
```
    Retrieves a read/write structure for game profiles in Minecraft 1.7.2.
    This modifier will automatically marshall between WrappedGameProfile and the internal Minecraft GameProfile.
    
    Returns:
    A modifier for GameProfile fields.
  - getChatComponents
```
public StructureModifier<WrappedChatComponent> getChatComponents()
```
    Retrieves a read/write structure for chat components in Minecraft 1.7.2.
    This modifier will automatically marshall between WrappedChatComponent and the internal Minecraft GameProfile.
    
    Returns:
    A modifier for ChatComponent fields.
  - getServerPings
```
public StructureModifier<WrappedServerPing> getServerPings()
```
    Retrieve a read/write structure for the ServerPing fields in the following packet:
    - PacketType.Status.Server#OUT_SERVER_INFO
    Returns:
    A modifier for ServerPing fields.
  - getProtocols
```
public StructureModifier<PacketType.Protocol> getProtocols()
```
    Retrieve a read/write structure for the Protocol enum in 1.7.2.
    
    Returns:
    A modifier for Protocol enum fields.
  - getClientCommands
```
public StructureModifier<EnumWrappers.ClientCommand> getClientCommands()
```
    Retrieve a read/write structure for the ClientCommand enum in 1.7.2.
    
    Returns:
    A modifier for ClientCommand enum fields.
  - getChatVisibilities
```
public StructureModifier<EnumWrappers.ChatVisibility> getChatVisibilities()
```
    Retrieve a read/write structure for the ChatVisibility enum in 1.7.2.
    
    Returns:
    A modifier for ChatVisibility enum fields.
  - getDifficulties
```
public StructureModifier<EnumWrappers.Difficulty> getDifficulties()
```
    Retrieve a read/write structure for the Difficulty enum in 1.7.2.
    
    Returns:
    A modifier for Difficulty enum fields.
  - getEntityUseActions
```
public StructureModifier<EnumWrappers.EntityUseAction> getEntityUseActions()
```
    Retrieve a read/write structure for the EntityUse enum in 1.7.2.
    
    Returns:
    A modifier for EntityUse enum fields.
  - getGameModes
```
public StructureModifier<EnumWrappers.NativeGameMode> getGameModes()
```
    Retrieve a read/write structure for the NativeGameMode enum in 1.7.2.
    
    Returns:
    A modifier for NativeGameMode enum fields.
  - getID
```
@Deprecated
public int getID()
```
    Deprecated.
    
    Retrieves the ID of this packet.
    Deprecated: Use getType() instead.
    
    Returns:
    Packet ID.
  - 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.

Class PacketContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

handle

structureModifier

Constructor Detail

PacketContainer

PacketContainer

PacketContainer

PacketContainer

PacketContainer

PacketContainer

PacketContainer

Method Detail

getHandle

getModifier

getSpecificModifier

getBytes

getBooleans

getShorts

getIntegers

getLongs

getFloat

getDoubles

getStrings

getStringArrays

getByteArrays

getByteArraySerializer

getIntegerArrays

getItemModifier

getItemArrayModifier

getStatisticMaps

getWorldTypeModifier

getDataWatcherModifier

getEntityModifier

getEntityModifier

getPositionModifier

getChunkCoordIntPairs

getNbtModifier

getAttributeCollectionModifier

getPositionCollectionModifier

getWatchableCollectionModifier

getBlocks

getGameProfiles

getChatComponents

getServerPings

getProtocols

getClientCommands

getChatVisibilities

getDifficulties

getEntityUseActions

getGameModes

getID

getType

shallowClone

deepClone