com.comphenix.protocol.events

Class PacketAdapter.AdapterParameteters

java.lang.Object

com.comphenix.protocol.events.PacketAdapter.AdapterParameteters

Enclosing class:

PacketAdapter

public static class PacketAdapter.AdapterParameteters
extends java.lang.Object

Represents a builder for passing parameters to the packet adapter constructor.

Note: Never make spelling mistakes in a public API!

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
PacketAdapter.AdapterParameteters()

Method Summary

Methods

Modifier and Type	Method and Description
PacketAdapter.AdapterParameteters	clientSide() Set this adapter to also look for client-side packets.
PacketAdapter.AdapterParameteters	connectionSide(ConnectionSide connectionSide) Set the packet types this listener is looking for.
PacketAdapter.AdapterParameteters	gamePhase(GamePhase gamePhase) Set which game phase this listener is active under.
PacketAdapter.AdapterParameteters	listenerPriority(ListenerPriority listenerPriority) Set the the event priority, where the execution is in ascending order from lowest to highest.
PacketAdapter.AdapterParameteters	loginPhase() Set the game phase to GamePhase.LOGIN, allowing ProtocolLib to intercept login packets.
PacketAdapter.AdapterParameteters	optionAsync() Set the listener option to ListenerOptions.ASYNC, indicating that our listener is thread safe.
PacketAdapter.AdapterParameteters	optionIntercept() Set the listener option to ListenerOptions.INTERCEPT_INPUT_BUFFER, causing ProtocolLib to read the raw packet data from the network stream.
PacketAdapter.AdapterParameteters	optionManualGamePhase() Set the listener option to ListenerOptions.DISABLE_GAMEPHASE_DETECTION, causing ProtocolLib to ignore automatic game phase detection.
PacketAdapter.AdapterParameteters	options(ListenerOptions... options) Set listener options that decide whether or not to intercept the raw packet data as read from the network stream.
PacketAdapter.AdapterParameteters	options(java.util.Set<? extends ListenerOptions> options) Set listener options that decide whether or not to intercept the raw packet data as read from the network stream.
PacketAdapter.AdapterParameteters	packets(java.lang.Integer... packets) Deprecated.
PacketAdapter.AdapterParameteters	packets(java.util.Set<java.lang.Integer> packets) Deprecated.
PacketAdapter.AdapterParameteters	plugin(org.bukkit.plugin.Plugin plugin) Set the plugin that spawned this listener.
PacketAdapter.AdapterParameteters	serverSide() Set this adapter to also look for server-side packets.
PacketAdapter.AdapterParameteters	types(PacketType... packets) Set the packet types the listener is looking for.
PacketAdapter.AdapterParameteters	types(java.util.Set<PacketType> packets) Set the packet types the listener is looking for.

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketAdapter.AdapterParameteters

public PacketAdapter.AdapterParameteters()

Method Detail

plugin

public PacketAdapter.AdapterParameteters plugin(@Nonnull
                                       org.bukkit.plugin.Plugin plugin)

Set the plugin that spawned this listener. This parameter is required.

Parameters:

plugin - - the plugin.

Returns:

This builder, for chaining.

connectionSide

public PacketAdapter.AdapterParameteters connectionSide(@Nonnull
                                               ConnectionSide connectionSide)

Set the packet types this listener is looking for. This parameter is required.

Parameters:

connectionSide - - the new packet type.

Returns:

This builder, for chaining.

clientSide

public PacketAdapter.AdapterParameteters clientSide()

Set this adapter to also look for client-side packets.

Returns:

This builder, for chaining.

serverSide

public PacketAdapter.AdapterParameteters serverSide()

Set this adapter to also look for server-side packets.

Returns:

This builder, for chaining.

listenerPriority

public PacketAdapter.AdapterParameteters listenerPriority(@Nonnull
                                                 ListenerPriority listenerPriority)

Set the the event priority, where the execution is in ascending order from lowest to highest.

Default is ListenerPriority.NORMAL.

Parameters:

listenerPriority - - the new event priority.

Returns:

This builder, for chaining.

gamePhase

public PacketAdapter.AdapterParameteters gamePhase(@Nonnull
                                          GamePhase gamePhase)

Set which game phase this listener is active under. This is a hint for ProtocolLib to start intercepting login packets.

Default is GamePhase.PLAYING, which will not intercept login packets.

Parameters:

gamePhase - - the new game phase.

Returns:

This builder, for chaining.

loginPhase

public PacketAdapter.AdapterParameteters loginPhase()

Set the game phase to GamePhase.LOGIN, allowing ProtocolLib to intercept login packets.

Returns:

This builder, for chaining.

options

public PacketAdapter.AdapterParameteters options(@Nonnull
                                        ListenerOptions... options)

Set listener options that decide whether or not to intercept the raw packet data as read from the network stream.

The default is to disable this raw packet interception.

Parameters:

options - - every option to use.

Returns:

This builder, for chaining.

options

public PacketAdapter.AdapterParameteters options(@Nonnull
                                        java.util.Set<? extends ListenerOptions> options)

Set listener options that decide whether or not to intercept the raw packet data as read from the network stream.

The default is to disable this raw packet interception.

Parameters:

options - - every option to use.

Returns:

This builder, for chaining.

optionIntercept

public PacketAdapter.AdapterParameteters optionIntercept()

Set the listener option to ListenerOptions.INTERCEPT_INPUT_BUFFER, causing ProtocolLib to read the raw packet data from the network stream.

Returns:

This builder, for chaining.

optionManualGamePhase

public PacketAdapter.AdapterParameteters optionManualGamePhase()

Set the listener option to ListenerOptions.DISABLE_GAMEPHASE_DETECTION, causing ProtocolLib to ignore automatic game phase detection.

This is no longer relevant in 1.7.2.

Returns:

This builder, for chaining.

optionAsync

public PacketAdapter.AdapterParameteters optionAsync()

Set the listener option to ListenerOptions.ASYNC, indicating that our listener is thread safe.

This allows ProtocolLib to perform certain optimizations.

Returns:

This builder, for chaining.

packets

@Deprecated
public PacketAdapter.AdapterParameteters packets(@Nonnull
                                                   java.lang.Integer... packets)

Deprecated.

Set the packet IDs of the packets the listener is looking for.

This parameter is required.

Deprecated: Use types(PacketType...) instead.

Parameters:

packets - - the packet IDs to look for.

Returns:

This builder, for chaining.

packets

@Deprecated
public PacketAdapter.AdapterParameteters packets(@Nonnull
                                                   java.util.Set<java.lang.Integer> packets)

Deprecated.

Set the packet IDs of the packets the listener is looking for.

This parameter is required.

Parameters:

packets - - a set of the packet IDs to look for.

Returns:

This builder, for chaining.

types

public PacketAdapter.AdapterParameteters types(@Nonnull
                                      PacketType... packets)

Set the packet types the listener is looking for.

This parameter is required.

Parameters:

packets - - the packet types to look for.

Returns:

This builder, for chaining.

types

public PacketAdapter.AdapterParameteters types(@Nonnull
                                      java.util.Set<PacketType> packets)

Set the packet types the listener is looking for.

This parameter is required.

Parameters:

packets - - a set of packet types to look for.

Returns:

This builder, for chaining.