BungeePlugin (viaversion-parent 3.2.2-SNAPSHOT API)

java.lang.Object
- net.md_5.bungee.api.plugin.Plugin
- - us.myles.ViaVersion.BungeePlugin

All Implemented Interfaces:: net.md_5.bungee.api.plugin.Listener, ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>

public class BungeePlugin
extends net.md_5.bungee.api.plugin.Plugin
implements ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>, net.md_5.bungee.api.plugin.Listener

Constructor Summary

Constructors
Constructor and Description

BungeePlugin()

Constructors
Constructor and Description
`BungeePlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelTask(TaskId taskId)` Cancel a task
`ViaAPI<net.md_5.bungee.api.connection.ProxiedPlayer>`	`getApi()` Get the API for this platform
`BungeeViaConfig`	`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
`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`	`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 net.md_5.bungee.api.plugin.Plugin
getDataFolder, getDescription, getExecutorService, getFile, getLogger, getProxy, getResourceAsStream, onDisable

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, getDataFolder, getLogger

- Constructor Detail
  - BungeePlugin
```
public BungeePlugin()
```
- Method Detail
  - onLoad
```
public void onLoad()
```
    Overrides:
    
    onLoad in class net.md_5.bungee.api.plugin.Plugin
  - onEnable
```
public void onEnable()
```
    Overrides:
    
    onEnable in class net.md_5.bungee.api.plugin.Plugin
  - getPlatformName
```
public String getPlatformName()
```
    Description copied from interface: ViaPlatform
    
    Get the platform name
    
    Specified by:
    
    getPlatformName in interface ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    Returns:
    
    True if it is enabled
  - getApi
```
public ViaAPI<net.md_5.bungee.api.connection.ProxiedPlayer> getApi()
```
    Description copied from interface: ViaPlatform
    
    Get the API for this platform
    
    Specified by:
    
    getApi in interface ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    Returns:
    
    The API for the platform
  - getConf
```
public BungeeViaConfig getConf()
```
    Description copied from interface: ViaPlatform
    
    Get the config API for this platform
    
    Specified by:
    
    getConf in interface ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    Returns:
    
    The config API
  - 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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    Returns:
    
    The configuration provider
  - onReload
```
public void onReload()
```
    Description copied from interface: ViaPlatform
    
    Called when a reload happens
    
    Specified by:
    
    onReload in interface ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>
  - 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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    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<net.md_5.bungee.api.connection.ProxiedPlayer>
    
    Returns:
    
    True if allowed
  - getConnectionManager
```
public ViaConnectionManager getConnectionManager()
```
    Specified by:
    
    getConnectionManager in interface ViaPlatform<net.md_5.bungee.api.connection.ProxiedPlayer>

Class BungeePlugin

Constructor Summary

Method Summary

Methods inherited from class net.md_5.bungee.api.plugin.Plugin

Methods inherited from class java.lang.Object

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

Constructor Detail

BungeePlugin

Method Detail

onLoad

onEnable

getPlatformName

getPlatformVersion

isProxy

getPluginVersion

runAsync

runSync

runSync

runRepeatingSync

cancelTask

getOnlinePlayers

sendMessage

kickPlayer

isPluginEnabled

getApi

getConf

getConfigurationProvider

onReload

getDump

isOldClientsAllowed

getConnectionManager