com.comphenix.protocol

Class ProtocolLibrary

java.lang.Object

com.comphenix.protocol.ProtocolLibrary

public class ProtocolLibrary
extends Object

The main entry point for ProtocolLib.

Author:

dmulloy2

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	INCOMPATIBLE Plugins that are currently incompatible with ProtocolLib.
static String	MAXIMUM_MINECRAFT_VERSION The maximum version ProtocolLib has been tested with.
static String	MINECRAFT_LAST_RELEASE_DATE The date (with ISO 8601 or YYYY-MM-DD) when the most recent version (1.11) was released.
static String	MINIMUM_MINECRAFT_VERSION The minimum version ProtocolLib has been tested with.

Constructor Summary

Constructors

Constructor and Description
ProtocolLibrary()

Method Summary

Modifier and Type	Method and Description
static void	disableUpdates() Disables the ProtocolLib update checker.
static ProtocolConfig	getConfig() Gets ProtocolLib's configuration
static ErrorReporter	getErrorReporter() Retrieve the current error reporter.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	getExecutorAsync() Retrieve an executor service for performing asynchronous tasks on the behalf of ProtocolLib.
static com.google.common.util.concurrent.ListeningScheduledExecutorService	getExecutorSync() Retrieve an executor service for performing synchronous tasks (main thread) on the behalf of ProtocolLib.
static org.bukkit.plugin.Plugin	getPlugin() Gets the ProtocolLib plugin instance.
static ProtocolManager	getProtocolManager() Retrieves the packet protocol manager.
protected static void	init(org.bukkit.plugin.Plugin plugin, ProtocolConfig config, ProtocolManager manager, ErrorReporter reporter, com.google.common.util.concurrent.ListeningScheduledExecutorService executorAsync, com.google.common.util.concurrent.ListeningScheduledExecutorService executorSync)
static boolean	updatesDisabled() Whether or not updates are currently disabled.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_MINECRAFT_VERSION

public static final String MINIMUM_MINECRAFT_VERSION

The minimum version ProtocolLib has been tested with.

See Also:

Constant Field Values

MAXIMUM_MINECRAFT_VERSION

public static final String MAXIMUM_MINECRAFT_VERSION

The maximum version ProtocolLib has been tested with.

See Also:

Constant Field Values

MINECRAFT_LAST_RELEASE_DATE

public static final String MINECRAFT_LAST_RELEASE_DATE

The date (with ISO 8601 or YYYY-MM-DD) when the most recent version (1.11) was released.

See Also:

Constant Field Values

INCOMPATIBLE

public static final List<String> INCOMPATIBLE

Plugins that are currently incompatible with ProtocolLib.

Constructor Detail

ProtocolLibrary

public ProtocolLibrary()

Method Detail

init

protected static void init(org.bukkit.plugin.Plugin plugin,
                           ProtocolConfig config,
                           ProtocolManager manager,
                           ErrorReporter reporter,
                           com.google.common.util.concurrent.ListeningScheduledExecutorService executorAsync,
                           com.google.common.util.concurrent.ListeningScheduledExecutorService executorSync)

getPlugin

public static org.bukkit.plugin.Plugin getPlugin()

Gets the ProtocolLib plugin instance.

Returns:

The plugin instance

getConfig

public static ProtocolConfig getConfig()

Gets ProtocolLib's configuration

Returns:

The config

getProtocolManager

public static ProtocolManager getProtocolManager()

Retrieves the packet protocol manager.

Returns:

Packet protocol manager

getErrorReporter

public static ErrorReporter getErrorReporter()

Retrieve the current error reporter.

Returns:

Current error reporter.

getExecutorAsync

public static com.google.common.util.concurrent.ListeningScheduledExecutorService getExecutorAsync()

Retrieve an executor service for performing asynchronous tasks on the behalf of ProtocolLib.

Note that this service is NULL if ProtocolLib has not been initialized yet.

Returns:

The executor service, or NULL.

getExecutorSync

public static com.google.common.util.concurrent.ListeningScheduledExecutorService getExecutorSync()

Retrieve an executor service for performing synchronous tasks (main thread) on the behalf of ProtocolLib.

Note that this service is NULL if ProtocolLib has not been initialized yet.

Returns:

The executor service, or NULL.

disableUpdates

public static void disableUpdates()

Disables the ProtocolLib update checker.

updatesDisabled

public static boolean updatesDisabled()

Whether or not updates are currently disabled.

Returns:

True if it is, false if not