com.comphenix.protocol.events

Class 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 net.minecraft.server.Packet	handle
protected int	id
protected StructureModifier<java.lang.Object>	structureModifier

Constructor Summary

Constructors

Constructor and Description
PacketContainer(int id) Creates a packet container for a new packet.
PacketContainer(int id, net.minecraft.server.Packet handle) Creates a packet container for an existing packet.
PacketContainer(int id, net.minecraft.server.Packet handle, StructureModifier<java.lang.Object> structure) Creates a packet container for an existing packet.

Method Summary

Methods

Modifier and Type	Method and Description
StructureModifier<org.bukkit.entity.Entity>	getEntityModifier(org.bukkit.World world) Retrieves a read/write structure for entity objects.
net.minecraft.server.Packet	getHandle() Retrieves the underlying Minecraft packet.
int	getID() Retrieves the ID of this packet.
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.Object>	getModifier() Retrieves the generic structure modifier for this packet.
<T> StructureModifier<T>	getSpecificModifier(java.lang.Class<T> primitiveType) Retrieves a read/write structure for every field with the given type.
StructureModifier<org.bukkit.WorldType>	getWorldTypeModifier() Retrieves a read/write structure for the world type enum.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

handle

protected transient net.minecraft.server.Packet handle

structureModifier

protected transient StructureModifier<java.lang.Object> structureModifier

Constructor Detail

PacketContainer

public PacketContainer(int id)

Creates a packet container for a new packet.

Parameters:

id - - ID of the packet to create.

PacketContainer

public PacketContainer(int id,
               net.minecraft.server.Packet handle)

Creates a packet container for an existing packet.

Parameters:

id - - ID of the given packet.

handle - - contained packet.

PacketContainer

public PacketContainer(int id,
               net.minecraft.server.Packet 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.

Method Detail

getHandle

public net.minecraft.server.Packet 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.

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.

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.

getEntityModifier

public StructureModifier<org.bukkit.entity.Entity> getEntityModifier(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.

Returns:

A modifier entity types.

getID

public int getID()

Retrieves the ID of this packet.

Returns:

Packet ID.