BungeeCordImpl (helper 5.6.2 API)

java.lang.Object
- me.lucko.helper.messaging.bungee.BungeeCordImpl

All Implemented Interfaces:: BungeeCord, PluginMessageListener

@NonnullByDefault
public final class BungeeCordImpl
extends Object
implements BungeeCord, PluginMessageListener

Field Summary
- Fields inherited from interface me.lucko.helper.messaging.bungee.BungeeCord
  ALL_SERVERS, ONLINE_SERVERS

Constructor Summary

Constructors
Constructor and Description

BungeeCordImpl(HelperPlugin plugin)

Constructors
Constructor and Description
`BungeeCordImpl(HelperPlugin plugin)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect(Player player, String serverName)` Connects a player to said subserver
`void`	`connectOther(String playerName, String serverName)` Connects a named player to said subserver
`void`	`forward(String serverName, String channelName, byte[] data)` Sends a custom plugin message to a given server.
`void`	`forward(String serverName, String channelName, ByteArrayDataOutput data)` Sends a custom plugin message to a given server.
`void`	`forwardToPlayer(String playerName, String channelName, byte[] data)` Sends a custom plugin message to a given server.
`void`	`forwardToPlayer(String playerName, String channelName, ByteArrayDataOutput data)` Sends a custom plugin message to a given server.
`Promise<String>`	`getServer()` Gets this servers name, as defined in the BungeeCord config
`Promise<List<String>>`	`getServers()` Get a list of server name strings, as defined in the BungeeCord config
`Promise<Map.Entry<String,Integer>>`	`ip(Player player)` Get the real IP of a player
`void`	`kickPlayer(String playerName, String reason)` Kick a player from the proxy
`void`	`message(String playerName, String message)` Send a message (as in chat message) to the specified player
`void`	`onPluginMessageReceived(String channel, Player player, byte[] data)`
`Promise<Integer>`	`playerCount(String serverName)` Gets the amount of players on a certain server, or all servers
`Promise<List<String>>`	`playerList(String serverName)` Gets a list of players connected on a certain server, or all servers.
`void`	`registerForwardCallback(String channelName, Predicate<ByteArrayDataInput> callback)` Registers a callback to listen for messages sent on forwarded subchannels.
`void`	`registerForwardCallbackRaw(String channelName, Predicate<byte[]> callback)` Registers a callback to listen for messages sent on forwarded subchannels.
`Promise<Map.Entry<String,Integer>>`	`serverIp(String serverName)` Get the IP of any server connected to the proxy
`Promise<UUID>`	`uuid(Player player)` Get the UUID of a player
`Promise<UUID>`	`uuidOther(String playerName)` Get the UUID of any player connected to the proxy

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BungeeCordImpl
```
public BungeeCordImpl(HelperPlugin plugin)
```
- Method Detail
  - onPluginMessageReceived
```
public void onPluginMessageReceived(String channel,
                                    Player player,
                                    byte[] data)
```
    Specified by:
    
    onPluginMessageReceived in interface PluginMessageListener
  - connect
```
public void connect(Player player,
                    String serverName)
```
    Description copied from interface: BungeeCord
    
    Connects a player to said subserver
    
    Specified by:
    
    connect in interface BungeeCord
    
    Parameters:
    
    player - the player to connect
    
    serverName - the name of the server to connect to
  - connectOther
```
public void connectOther(String playerName,
                         String serverName)
```
    Description copied from interface: BungeeCord
    
    Connects a named player to said subserver
    
    Specified by:
    
    connectOther in interface BungeeCord
    
    Parameters:
    
    playerName - the username of the player to connect
    
    serverName - the name of the server to connect to
  - ip
```
public Promise<Map.Entry<String,Integer>> ip(Player player)
```
    Description copied from interface: BungeeCord
    
    Get the real IP of a player
    
    Specified by:
    
    ip in interface BungeeCord
    
    Parameters:
    
    player - the player to get the IP of
    
    Returns:
    
    a future
  - playerCount
```
public Promise<Integer> playerCount(String serverName)
```
    Description copied from interface: BungeeCord
    
    Gets the amount of players on a certain server, or all servers
    
    Specified by:
    
    playerCount in interface BungeeCord
    
    Parameters:
    
    serverName - the name of the server to get the player count for. Use BungeeCord.ALL_SERVERS to get the global count
    
    Returns:
    
    a future
  - playerList
```
public Promise<List<String>> playerList(String serverName)
```
    Description copied from interface: BungeeCord
    
    Gets a list of players connected on a certain server, or all servers.
    
    Specified by:
    
    playerList in interface BungeeCord
    
    Parameters:
    
    serverName - the name of the server to get the player list for. Use BungeeCord.ALL_SERVERS to get the global list
    
    Returns:
    
    a future
  - getServers
```
public Promise<List<String>> getServers()
```
    Description copied from interface: BungeeCord
    
    Get a list of server name strings, as defined in the BungeeCord config
    
    Specified by:
    
    getServers in interface BungeeCord
    
    Returns:
    
    a future
  - message
```
public void message(String playerName,
                    String message)
```
    Description copied from interface: BungeeCord
    
    Send a message (as in chat message) to the specified player
    
    Specified by:
    
    message in interface BungeeCord
    
    Parameters:
    
    playerName - the username of the player to send the message to
    
    message - the message to send
  - getServer
```
public Promise<String> getServer()
```
    Description copied from interface: BungeeCord
    
    Gets this servers name, as defined in the BungeeCord config
    
    Specified by:
    
    getServer in interface BungeeCord
    
    Returns:
    
    a future
  - uuid
```
public Promise<UUID> uuid(Player player)
```
    Description copied from interface: BungeeCord
    
    Get the UUID of a player
    
    Specified by:
    
    uuid in interface BungeeCord
    
    Parameters:
    
    player - the player to get the uuid of
    
    Returns:
    
    a future
  - uuidOther
```
public Promise<UUID> uuidOther(String playerName)
```
    Description copied from interface: BungeeCord
    
    Get the UUID of any player connected to the proxy
    
    Specified by:
    
    uuidOther in interface BungeeCord
    
    Parameters:
    
    playerName - the username of the player to get the uuid of
    
    Returns:
    
    a future
  - serverIp
```
public Promise<Map.Entry<String,Integer>> serverIp(String serverName)
```
    Description copied from interface: BungeeCord
    
    Get the IP of any server connected to the proxy
    
    Specified by:
    
    serverIp in interface BungeeCord
    
    Parameters:
    
    serverName - the name of the server to get the ip of
    
    Returns:
    
    a future
  - kickPlayer
```
public void kickPlayer(String playerName,
                       String reason)
```
    Description copied from interface: BungeeCord
    
    Kick a player from the proxy
    
    Specified by:
    
    kickPlayer in interface BungeeCord
    
    Parameters:
    
    playerName - the username of the player to kick
    
    reason - the reason to display to the player when they are kicked
  - forward
```
public void forward(String serverName,
                    String channelName,
                    byte[] data)
```
    Description copied from interface: BungeeCord
    
    Sends a custom plugin message to a given server.
    You can use BungeeCord.registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.
    
    Specified by:
    
    forward in interface BungeeCord
    
    Parameters:
    
    serverName - the name of the server to send to. use BungeeCord.ALL_SERVERS to send to all servers, or BungeeCord.ONLINE_SERVERS to only send to servers which are online.
    
    channelName - the name of the subchannel
    
    data - the data to send
  - forward
```
public void forward(String serverName,
                    String channelName,
                    ByteArrayDataOutput data)
```
    Description copied from interface: BungeeCord
    
    Sends a custom plugin message to a given server.
    You can use BungeeCord.registerForwardCallback(String, Predicate) to register listeners on a given subchannel.
    
    Specified by:
    
    forward in interface BungeeCord
    
    Parameters:
    
    serverName - the name of the server to send to. use BungeeCord.ALL_SERVERS to send to all servers, or BungeeCord.ONLINE_SERVERS to only send to servers which are online.
    
    channelName - the name of the subchannel
    
    data - the data to send
  - forwardToPlayer
```
public void forwardToPlayer(String playerName,
                            String channelName,
                            byte[] data)
```
    Description copied from interface: BungeeCord
    
    Sends a custom plugin message to a given server.
    You can use BungeeCord.registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.
    
    Specified by:
    
    forwardToPlayer in interface BungeeCord
    
    Parameters:
    
    playerName - the username of a player. BungeeCord will send the forward message to their server.
    
    channelName - the name of the subchannel
    
    data - the data to send
  - forwardToPlayer
```
public void forwardToPlayer(String playerName,
                            String channelName,
                            ByteArrayDataOutput data)
```
    Description copied from interface: BungeeCord
    
    Sends a custom plugin message to a given server.
    You can use BungeeCord.registerForwardCallback(String, Predicate) to register listeners on a given subchannel.
    
    Specified by:
    
    forwardToPlayer in interface BungeeCord
    
    Parameters:
    
    playerName - the username of a player. BungeeCord will send the forward message to their server.
    
    channelName - the name of the subchannel
    
    data - the data to send
  - registerForwardCallbackRaw
```
public void registerForwardCallbackRaw(String channelName,
                                       Predicate<byte[]> callback)
```
    Description copied from interface: BungeeCord
    
    Registers a callback to listen for messages sent on forwarded subchannels.
    Use BungeeCord.forward(String, String, byte[]) to dispatch messages.
    
    Specified by:
    
    registerForwardCallbackRaw in interface BungeeCord
    
    Parameters:
    
    channelName - the name of the channel to listen on
    
    callback - the callback. the predicate should return true when the callback should be unregistered.
  - registerForwardCallback
```
public void registerForwardCallback(String channelName,
                                    Predicate<ByteArrayDataInput> callback)
```
    Description copied from interface: BungeeCord
    
    Registers a callback to listen for messages sent on forwarded subchannels.
    Use BungeeCord.forward(String, String, ByteArrayDataOutput) to dispatch messages.
    
    Specified by:
    
    registerForwardCallback in interface BungeeCord
    
    Parameters:
    
    channelName - the name of the channel to listen on
    
    callback - the callback. the predicate should return true when the callback should be unregistered.

Class BungeeCordImpl

Field Summary

Fields inherited from interface me.lucko.helper.messaging.bungee.BungeeCord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BungeeCordImpl

Method Detail

onPluginMessageReceived

connect

connectOther

ip

playerCount

playerList

getServers

message

getServer

uuid

uuidOther

serverIp

kickPlayer

forward

forward

forwardToPlayer

forwardToPlayer

registerForwardCallbackRaw

registerForwardCallback