com.comphenix.protocol.injector.packet

Interface PacketInjector

public interface PacketInjector

Represents a incoming packet injector.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addPacketHandler(int packetID) Start intercepting packets with the given packet ID.
void	cleanupAll() Perform any necessary cleanup before unloading ProtocolLib.
java.util.Set<java.lang.Integer>	getPacketHandlers() Retrieve every intercepted packet ID.
boolean	hasPacketHandler(int packetID) Determine if packets with the given packet ID is being intercepted.
PacketEvent	packetRecieved(PacketContainer packet, Player client) Let the packet listeners process the given packet.
boolean	removePacketHandler(int packetID) Stop intercepting packets with the given packet ID.
void	undoCancel(java.lang.Integer id, java.lang.Object packet) Undo a packet cancel.

Method Detail

undoCancel

void undoCancel(java.lang.Integer id,
              java.lang.Object packet)

Undo a packet cancel.

Parameters:

id - - the id of the packet.

packet - - packet to uncancel.

addPacketHandler

boolean addPacketHandler(int packetID)

Start intercepting packets with the given packet ID.

Parameters:

packetID - - the ID of the packets to start intercepting.

Returns:

TRUE if we didn't already intercept these packets, FALSE otherwise.

removePacketHandler

boolean removePacketHandler(int packetID)

Stop intercepting packets with the given packet ID.

Parameters:

packetID - - the ID of the packets to stop intercepting.

Returns:

TRUE if we successfuly stopped intercepting a given packet ID, FALSE otherwise.

hasPacketHandler

boolean hasPacketHandler(int packetID)

Determine if packets with the given packet ID is being intercepted.

Parameters:

packetID - - the packet ID to lookup.

Returns:

TRUE if we do, FALSE otherwise.

getPacketHandlers

java.util.Set<java.lang.Integer> getPacketHandlers()

Retrieve every intercepted packet ID.

Returns:

Every intercepted packet ID.

packetRecieved

PacketEvent packetRecieved(PacketContainer packet,
                         Player client)

Let the packet listeners process the given packet.

Parameters:

packet - - a packet to process.

client - - the client that sent the packet.

Returns:

The resulting packet event.

cleanupAll

void cleanupAll()

Perform any necessary cleanup before unloading ProtocolLib.