me.lucko.helper.messaging.bungee

Interface BungeeCord

All Known Implementing Classes:

BungeeCordImpl

public interface BungeeCord

API interface to encapsulate the BungeeCord Plugin Messaging API.

The returned futures should never be joined or waited for on the Server thread.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SERVERS Server name to represent all servers on the proxy
static String	ONLINE_SERVERS Server name to represent only the online servers on the proxy

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 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
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

Field Detail

ALL_SERVERS

static final String ALL_SERVERS

Server name to represent all servers on the proxy

See Also:

Constant Field Values

ONLINE_SERVERS

static final String ONLINE_SERVERS

Server name to represent only the online servers on the proxy

See Also:

Constant Field Values

Method Detail

connect

void connect(@Nonnull
             Player player,
             @Nonnull
             String serverName)

Connects a player to said subserver

Parameters:

player - the player to connect

serverName - the name of the server to connect to

connectOther

void connectOther(@Nonnull
                  String playerName,
                  @Nonnull
                  String serverName)

Connects a named player to said subserver

Parameters:

playerName - the username of the player to connect

serverName - the name of the server to connect to

ip

@Nonnull
Promise<Map.Entry<String,Integer>> ip(@Nonnull
                                               Player player)

Get the real IP of a player

Parameters:

player - the player to get the IP of

Returns:

a future

playerCount

@Nonnull
Promise<Integer> playerCount(@Nonnull
                                      String serverName)

Gets the amount of players on a certain server, or all servers

Parameters:

serverName - the name of the server to get the player count for. Use ALL_SERVERS to get the global count

Returns:

a future

playerList

@Nonnull
Promise<List<String>> playerList(@Nonnull
                                          String serverName)

Gets a list of players connected on a certain server, or all servers.

Parameters:

serverName - the name of the server to get the player list for. Use ALL_SERVERS to get the global list

Returns:

a future

getServers

@Nonnull
Promise<List<String>> getServers()

Get a list of server name strings, as defined in the BungeeCord config

Returns:

a future

message

void message(@Nonnull
             String playerName,
             @Nonnull
             String message)

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

Parameters:

playerName - the username of the player to send the message to

message - the message to send

getServer

@Nonnull
Promise<String> getServer()

Gets this servers name, as defined in the BungeeCord config

Returns:

a future

uuid

@Nonnull
Promise<UUID> uuid(@Nonnull
                            Player player)

Get the UUID of a player

Parameters:

player - the player to get the uuid of

Returns:

a future

uuidOther

@Nonnull
Promise<UUID> uuidOther(@Nonnull
                                 String playerName)

Get the UUID of any player connected to the proxy

Parameters:

playerName - the username of the player to get the uuid of

Returns:

a future

serverIp

@Nonnull
Promise<Map.Entry<String,Integer>> serverIp(@Nonnull
                                                     String serverName)

Get the IP of any server connected to the proxy

Parameters:

serverName - the name of the server to get the ip of

Returns:

a future

kickPlayer

void kickPlayer(@Nonnull
                String playerName,
                @Nonnull
                String reason)

Kick a player from the proxy

Parameters:

playerName - the username of the player to kick

reason - the reason to display to the player when they are kicked

forward

void forward(@Nonnull
             String serverName,
             @Nonnull
             String channelName,
             @Nonnull
             byte[] data)

Sends a custom plugin message to a given server.

You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.

Parameters:

serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.

channelName - the name of the subchannel

data - the data to send

forward

void forward(@Nonnull
             String serverName,
             @Nonnull
             String channelName,
             @Nonnull
             ByteArrayDataOutput data)

Sends a custom plugin message to a given server.

You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.

Parameters:

serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.

channelName - the name of the subchannel

data - the data to send

forwardToPlayer

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

Sends a custom plugin message to a given server.

You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.

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

void forwardToPlayer(@Nonnull
                     String playerName,
                     @Nonnull
                     String channelName,
                     @Nonnull
                     ByteArrayDataOutput data)

Sends a custom plugin message to a given server.

You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.

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

void registerForwardCallbackRaw(@Nonnull
                                String channelName,
                                @Nonnull
                                Predicate<byte[]> callback)

Registers a callback to listen for messages sent on forwarded subchannels.

Use forward(String, String, byte[]) to dispatch messages.

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

void registerForwardCallback(@Nonnull
                             String channelName,
                             @Nonnull
                             Predicate<ByteArrayDataInput> callback)

Registers a callback to listen for messages sent on forwarded subchannels.

Use forward(String, String, ByteArrayDataOutput) to dispatch messages.

Parameters:

channelName - the name of the channel to listen on

callback - the callback. the predicate should return true when the callback should be unregistered.