us.myles.ViaVersion

Class VelocityPlugin

java.lang.Object

us.myles.ViaVersion.VelocityPlugin

All Implemented Interfaces:

ViaPlatform<com.velocitypowered.api.proxy.Player>

public class VelocityPlugin
extends Object
implements ViaPlatform<com.velocitypowered.api.proxy.Player>

Field Summary

Fields

Modifier and Type	Field and Description
static com.velocitypowered.api.proxy.ProxyServer	PROXY

Constructor Summary

Constructors

Constructor and Description
VelocityPlugin()

Method Summary

Modifier and Type	Method and Description
void	cancelTask(TaskId taskId) Cancel a task
VelocityViaAPI	getApi() Get the API for this platform
VelocityViaConfig	getConf() Get the config API for this platform
ConfigurationProvider	getConfigurationProvider() Get the backend configuration provider for this platform.
ViaConnectionManager	getConnectionManager()
File	getDataFolder() Get ViaVersions's data folder.
com.google.gson.JsonObject	getDump() Get the JSON data required for /viaversion dump
Logger	getLogger() Get the logger for this platform
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	isOldClientsAllowed() Get if older clients are allowed to be used using ViaVersion.
boolean	isPluginEnabled() Check if the plugin is enabled.
boolean	isProxy() Returns true if the server Via is running on is a proxy server.
boolean	kickPlayer(UUID uuid, String message) Kick a player for a reason
void	onProxyInit(com.velocitypowered.api.event.proxy.ProxyInitializeEvent e)
void	onProxyLateInit(com.velocitypowered.api.event.proxy.ProxyInitializeEvent e)
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 java.lang.Object

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

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

disconnect

Field Detail

PROXY

public static com.velocitypowered.api.proxy.ProxyServer PROXY

Constructor Detail

VelocityPlugin

public VelocityPlugin()

Method Detail

onProxyInit

public void onProxyInit(com.velocitypowered.api.event.proxy.ProxyInitializeEvent e)

onProxyLateInit

public void onProxyLateInit(com.velocitypowered.api.event.proxy.ProxyInitializeEvent e)

getPlatformName

public String getPlatformName()

Description copied from interface: ViaPlatform

Get the platform name

Specified by:

getPlatformName in interface ViaPlatform<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.Player>

Returns:

Platform version

isProxy

public boolean isProxy()

Description copied from interface: ViaPlatform

Returns true if the server Via is running on is a proxy server.

Specified by:

isProxy in interface ViaPlatform<com.velocitypowered.api.proxy.Player>

Returns:

true if the platform is a proxy

getPluginVersion

public String getPluginVersion()

Description copied from interface: ViaPlatform

Get the plugin version

Specified by:

getPluginVersion in interface ViaPlatform<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.Player>

Returns:

The configuration provider

getDataFolder

public File getDataFolder()

Description copied from interface: ViaPlatform

Get ViaVersions's data folder.

Specified by:

getDataFolder in interface ViaPlatform<com.velocitypowered.api.proxy.Player>

Returns:

data folder

getApi

public VelocityViaAPI getApi()

Description copied from interface: ViaPlatform

Get the API for this platform

Specified by:

getApi in interface ViaPlatform<com.velocitypowered.api.proxy.Player>

Returns:

The API for the platform

getConf

public VelocityViaConfig getConf()

Description copied from interface: ViaPlatform

Get the config API for this platform

Specified by:

getConf in interface ViaPlatform<com.velocitypowered.api.proxy.Player>

Returns:

The config API

onReload

public void onReload()

Description copied from interface: ViaPlatform

Called when a reload happens

Specified by:

onReload in interface ViaPlatform<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.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<com.velocitypowered.api.proxy.Player>

Returns:

True if allowed

getLogger

public Logger getLogger()

Description copied from interface: ViaPlatform

Get the logger for this platform

Specified by:

getLogger in interface ViaPlatform<com.velocitypowered.api.proxy.Player>

Returns:

Java Logger (may be a wrapper)

getConnectionManager

public ViaConnectionManager getConnectionManager()

Specified by:

getConnectionManager in interface ViaPlatform<com.velocitypowered.api.proxy.Player>