com.comphenix.protocol.injector.spigot

Class SpigotPacketInjector

java.lang.Object

com.comphenix.protocol.injector.spigot.SpigotPacketInjector

public class SpigotPacketInjector
extends java.lang.Object

Offload all the work to Spigot, if possible.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
SpigotPacketInjector(java.lang.ClassLoader classLoader, ErrorReporter reporter, ListenerInvoker invoker, Server server) Create a new spigot injector.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canUseSpigotListener() Determine if there is a Spigot packet listener.
PacketInjector	getPacketInjector() Retrieve the dummy packet injection handler.
PlayerInjectionHandler	getPlayerHandler() Retrieve the dummy player injection handler.
boolean	hasRegistered() Determine if the Spigot packet listener has been registered.
java.lang.Object	packetQueued(java.lang.Object networkManager, java.lang.Object connection, java.lang.Object packet) Called when a packet is queued to be sent.
java.lang.Object	packetReceived(java.lang.Object networkManager, java.lang.Object connection, java.lang.Object packet) Called when a packet has been received and is about to be handled by the current Connection.
boolean	register(Plugin plugin) Register the Spigot packet injector.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpigotPacketInjector

public SpigotPacketInjector(java.lang.ClassLoader classLoader,
                    ErrorReporter reporter,
                    ListenerInvoker invoker,
                    Server server)

Create a new spigot injector.

Method Detail

canUseSpigotListener

public static boolean canUseSpigotListener()

Determine if there is a Spigot packet listener.

Returns:

Spigot packet listener.

register

public boolean register(Plugin plugin)

Register the Spigot packet injector.

Parameters:

plugin - - the parent plugin.

Returns:

TRUE if we registered the plugin, FALSE otherwise.

hasRegistered

public boolean hasRegistered()

Determine if the Spigot packet listener has been registered.

Returns:

TRUE if it has, FALSE otherwise.

getPlayerHandler

public PlayerInjectionHandler getPlayerHandler()

Retrieve the dummy player injection handler.

Returns:

Dummy player injection handler.

getPacketInjector

public PacketInjector getPacketInjector()

Retrieve the dummy packet injection handler.

Returns:

Dummy packet injection handler.

packetReceived

public java.lang.Object packetReceived(java.lang.Object networkManager,
                              java.lang.Object connection,
                              java.lang.Object packet)

Called when a packet has been received and is about to be handled by the current Connection.

The returned packet will be the packet passed on for handling, or in the case of null being returned, not handled at all.

Parameters:

networkManager - - the NetworkManager receiving the packet

connection - - the connection which will handle the packet

packet - - the received packet

Returns:

the packet to be handled, or null to cancel

packetQueued

public java.lang.Object packetQueued(java.lang.Object networkManager,
                            java.lang.Object connection,
                            java.lang.Object packet)

Called when a packet is queued to be sent.

The returned packet will be the packet sent. In the case of null being returned, the packet will not be sent.

Parameters:

networkManager - - the NetworkManager which will send the packet

connection - - the connection which queued the packet

packet - - the queue packet

Returns:

the packet to be sent, or null if the packet will not be sent.