us.myles.ViaVersion

Class ViaVersionPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

us.myles.ViaVersion.ViaVersionPlugin

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin, ViaPlatform<org.bukkit.entity.Player>

public class ViaVersionPlugin
extends org.bukkit.plugin.java.JavaPlugin
implements ViaPlatform<org.bukkit.entity.Player>

Constructor Summary

Constructors

Constructor and Description
ViaVersionPlugin()

Method Summary

Modifier and Type	Method and Description
void	cancelTask(TaskId taskId) Cancel a task
ViaAPI<org.bukkit.entity.Player>	getApi() Get the API for this platform
BukkitViaConfig	getConf() Get the config API for this platform
ConfigurationProvider	getConfigurationProvider() Get the backend configuration provider for this platform.
ViaConnectionManager	getConnectionManager()
com.google.gson.JsonObject	getDump() Get the JSON data required for /viaversion dump
static ViaVersionPlugin	getInstance()
ViaCommandSender[]	getOnlinePlayers() Get the online players
String	getPlatformName() Get the platform name
String	getPlatformVersion() Get the platform version
String	getPluginVersion() Get the plugin version
boolean	isCompatSpigotBuild()
boolean	isOldClientsAllowed() Get if older clients are allowed to be used using ViaVersion.
boolean	isPluginEnabled() Check if the plugin is enabled.
boolean	isProtocolSupport()
boolean	isSpigot()
boolean	kickPlayer(UUID uuid, String message) Kick a player for a reason
void	onDisable()
void	onEnable()
void	onLoad()
void	onReload() Called when a reload happens
TaskId	runAsync(Runnable runnable) Run a task Async
TaskId	runRepeatingSync(Runnable runnable, Long ticks) Run a task at a repeating interval.
TaskId	runSync(Runnable runnable) Run a task Sync
TaskId	runSync(Runnable runnable, Long ticks) Run a task Sync after a interval This must be only used after plugin enable.
void	sendMessage(UUID uuid, String message) Send a message to a player

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, onTabComplete, reloadConfig, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface us.myles.ViaVersion.api.platform.ViaPlatform

disconnect, getDataFolder, getLogger, isProxy

Constructor Detail

ViaVersionPlugin

public ViaVersionPlugin()

Method Detail

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

Overrides:

onLoad in class org.bukkit.plugin.java.JavaPlugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

getPlatformName

public String getPlatformName()

Description copied from interface: ViaPlatform

Get the platform name

Specified by:

getPlatformName in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

Platform Name (simply its name)

getPlatformVersion

public String getPlatformVersion()

Description copied from interface: ViaPlatform

Get the platform version

Specified by:

getPlatformVersion in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

Platform version

getPluginVersion

public String getPluginVersion()

Description copied from interface: ViaPlatform

Get the plugin version

Specified by:

getPluginVersion in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

Plugin version as a semver string

runAsync

public TaskId runAsync(Runnable runnable)

Description copied from interface: ViaPlatform

Run a task Async

Specified by:

runAsync in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

runnable - The task to run

Returns:

The Task ID

runSync

public TaskId runSync(Runnable runnable)

Description copied from interface: ViaPlatform

Run a task Sync

Specified by:

runSync in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

runnable - The task to run

Returns:

The Task ID

runSync

public TaskId runSync(Runnable runnable,
                      Long ticks)

Description copied from interface: ViaPlatform

Run a task Sync after a interval This must be only used after plugin enable.

Specified by:

runSync in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

runnable - The task to run

ticks - The interval to run it after

Returns:

The Task ID

runRepeatingSync

public TaskId runRepeatingSync(Runnable runnable,
                               Long ticks)

Description copied from interface: ViaPlatform

Run a task at a repeating interval. Initial interval is the same as repeat.

Specified by:

runRepeatingSync in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

runnable - The task to run

ticks - The interval to run it at

Returns:

The Task ID

cancelTask

public void cancelTask(TaskId taskId)

Description copied from interface: ViaPlatform

Cancel a task

Specified by:

cancelTask in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

taskId - The task ID to cancel

getOnlinePlayers

public ViaCommandSender[] getOnlinePlayers()

Description copied from interface: ViaPlatform

Get the online players

Specified by:

getOnlinePlayers in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

Array of ViaCommandSender

sendMessage

public void sendMessage(UUID uuid,
                        String message)

Description copied from interface: ViaPlatform

Send a message to a player

Specified by:

sendMessage in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

uuid - The player's UUID

message - The message to send

kickPlayer

public boolean kickPlayer(UUID uuid,
                          String message)

Description copied from interface: ViaPlatform

Kick a player for a reason

Specified by:

kickPlayer in interface ViaPlatform<org.bukkit.entity.Player>

Parameters:

uuid - The player's UUID

message - The message to kick them with

Returns:

True if it was successful

isPluginEnabled

public boolean isPluginEnabled()

Description copied from interface: ViaPlatform

Check if the plugin is enabled.

Specified by:

isPluginEnabled in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

True if it is enabled

getConfigurationProvider

public ConfigurationProvider getConfigurationProvider()

Description copied from interface: ViaPlatform

Get the backend configuration provider for this platform. (On some platforms this returns the same as getConf())

Specified by:

getConfigurationProvider in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

The configuration provider

onReload

public void onReload()

Description copied from interface: ViaPlatform

Called when a reload happens

Specified by:

onReload in interface ViaPlatform<org.bukkit.entity.Player>

getDump

public com.google.gson.JsonObject getDump()

Description copied from interface: ViaPlatform

Get the JSON data required for /viaversion dump

Specified by:

getDump in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

The json data

isOldClientsAllowed

public boolean isOldClientsAllowed()

Description copied from interface: ViaPlatform

Get if older clients are allowed to be used using ViaVersion. (Only 1.9 on 1.9.2 server is supported by ViaVersion alone)

Specified by:

isOldClientsAllowed in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

True if allowed

getConf

public BukkitViaConfig getConf()

Description copied from interface: ViaPlatform

Get the config API for this platform

Specified by:

getConf in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

The config API

getApi

public ViaAPI<org.bukkit.entity.Player> getApi()

Description copied from interface: ViaPlatform

Get the API for this platform

Specified by:

getApi in interface ViaPlatform<org.bukkit.entity.Player>

Returns:

The API for the platform

isCompatSpigotBuild

public boolean isCompatSpigotBuild()

isSpigot

public boolean isSpigot()

isProtocolSupport

public boolean isProtocolSupport()

getInstance

public static ViaVersionPlugin getInstance()

getConnectionManager

public ViaConnectionManager getConnectionManager()

Specified by:

getConnectionManager in interface ViaPlatform<org.bukkit.entity.Player>