io.github.leonardosnt.bungeechannelapi

Class BungeeChannelApi

java.lang.Object

io.github.leonardosnt.bungeechannelapi.BungeeChannelApi

public class BungeeChannelApi
extends Object

Documentation copied from https://www.spigotmc.org/wiki/bukkit-bungee-plugin-messaging-channel/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BungeeChannelApi.ForwardConsumer

Constructor Summary

Constructors

Constructor and Description
BungeeChannelApi(Plugin plugin)

Method Summary

Modifier and Type	Method and Description
void	connect(Player player, String serverName) Connects a player to said subserver.
void	connectOther(String playerName, String server) Connect a named player to said subserver.
void	forward(String server, String channelName, byte[] data) Send a custom plugin message to said server.
void	forwardToPlayer(String playerName, String channelName, byte[] data) Send a custom plugin message to specific player.
CompletableFuture<InetSocketAddress>	getIp(Player player) Get the (real) IP of a player.
CompletableFuture<Integer>	getPlayerCount(String serverName) Get the amount of players on a certain server, or on ALL the servers.
CompletableFuture<List<String>>	getPlayerList(String serverName) Get a list of players connected on a certain server, or on ALL the servers.
CompletableFuture<String>	getServer() Get this server's name, as defined in BungeeCord's config.yml
CompletableFuture<InetSocketAddress>	getServerIp(String serverName) Request the IP of any server on this proxy
CompletableFuture<List<String>>	getServers() Get a list of server name strings, as defined in BungeeCord's config.yml
CompletableFuture<String>	getUUID(Player player) Request the UUID of this player
void	kickPlayer(String playerName, String kickMessage) Kick any player on this proxy
static BungeeChannelApi	of(Plugin plugin)
void	registerForwardListener(BungeeChannelApi.ForwardConsumer globalListener)
void	registerForwardListener(String targetChannel, BungeeChannelApi.ForwardConsumer listener)
void	sendMessage(String playerName, String message) Send a message (as in, a chat message) to the specified player.
void	unregister() Unregister message channels.

Methods inherited from class java.lang.Object

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

Constructor Detail

BungeeChannelApi

public BungeeChannelApi(Plugin plugin)

Method Detail

of

public static BungeeChannelApi of(Plugin plugin)

registerForwardListener

public void registerForwardListener(BungeeChannelApi.ForwardConsumer globalListener)

registerForwardListener

public void registerForwardListener(String targetChannel,
                                    BungeeChannelApi.ForwardConsumer listener)

getPlayerCount

public CompletableFuture<Integer> getPlayerCount(String serverName)

Get the amount of players on a certain server, or on ALL the servers.

Parameters:

serverName - the server name of the server to get the player count of, or ALL to get the global player count

Returns:

A CompletableFuture that, when completed, will return the amount of players on a certain server, or on ALL the servers.

getPlayerList

public CompletableFuture<List<String>> getPlayerList(String serverName)

Get a list of players connected on a certain server, or on ALL the servers.

Parameters:

serverName - the name of the server to get the list of connected players, or ALL for global online player list

Returns:

A CompletableFuture that, when completed, will return a list of players connected on a certain server, or on ALL the servers.

getServers

public CompletableFuture<List<String>> getServers()

Get a list of server name strings, as defined in BungeeCord's config.yml

Returns:

A CompletableFuture that, when completed, will return a list of server name strings, as defined in BungeeCord's config.yml

connect

public void connect(Player player,
                    String serverName)

Connects a player to said subserver.

Parameters:

player - the player you want to teleport

serverName - the name of server to connect to, as defined in BungeeCord config.yml

connectOther

public void connectOther(String playerName,
                         String server)

Connect a named player to said subserver.

Parameters:

playerName - name of the player to teleport

server - name of server to connect to, as defined in BungeeCord config.yml

getIp

public CompletableFuture<InetSocketAddress> getIp(Player player)

Get the (real) IP of a player.

Parameters:

player - The player you wish to get the IP of.

Returns:

A CompletableFuture that, when completed, will return the (real) IP of player.

sendMessage

public void sendMessage(String playerName,
                        String message)

Send a message (as in, a chat message) to the specified player.

Parameters:

playerName - the name of the player to send the chat message

message - the message to send to the player

getServer

public CompletableFuture<String> getServer()

Get this server's name, as defined in BungeeCord's config.yml

Returns:

A CompletableFuture that, when completed, will return the server's name, as defined in BungeeCord's config.yml

getUUID

public CompletableFuture<String> getUUID(Player player)

Request the UUID of this player

Parameters:

player - The player whose UUID you requested

Returns:

A CompletableFuture that, when completed, will return the UUID of player

getServerIp

public CompletableFuture<InetSocketAddress> getServerIp(String serverName)

Request the IP of any server on this proxy

Parameters:

serverName - the name of the server

Returns:

A CompletableFuture that, when completed, will return the requested ip

kickPlayer

public void kickPlayer(String playerName,
                       String kickMessage)

Kick any player on this proxy

Parameters:

playerName - the name of the player

kickMessage - the reason the player is kicked with

forward

public void forward(String server,
                    String channelName,
                    byte[] data)

Send a custom plugin message to said server. This is one of the most useful channels ever. Remember, the sending and receiving server(s) need to have a player online.

Parameters:

server - the name of the server to send to, ALL to send to every server (except the one sending the plugin message), or ONLINE to send to every server that's online (except the one sending the plugin message).

channelName - Subchannel for plugin usage.

data - data to send.

forwardToPlayer

public void forwardToPlayer(String playerName,
                            String channelName,
                            byte[] data)

Send a custom plugin message to specific player.

Parameters:

playerName - the name of the player to send to.

channelName - Subchannel for plugin usage.

data - data to send.

unregister

public void unregister()

Unregister message channels.