vital-cloudnet4-bridge/dev.vitalframework.cloudnet4.bridge/VitalCloudNet4Bridge

VitalCloudNet4Bridge

If you are running a CloudNET server, this will be the class to use when you want to communicate with it. This class is a wrapper for the CloudNET-Bridge module and provides easier-to-use APIs for it.

Inheritors

Spigot

Bungee

Types

Bungee

object Bungee : VitalCloudNet4Bridge<BungeePlayer>

Companion

object Companion

Spigot

object Spigot : VitalCloudNet4Bridge<SpigotPlayer>

Functions

connect

open fun P.connect(serverName: String)

Gets the PlayerExecutor for the given player and tries to connect the player to the given serverName. Note that the serverName is the fully qualified service name, e.g. Lobby-1, Lobby-2, etc.

getCloudServer

open fun P.getCloudServer(): ServiceInfoSnapshot?

Scans all currently active servers for the first server which the given player is currently connected to. If the player is not online, this function returns null.

getNonProxyCloudServer

open fun P.getNonProxyCloudServer(): ServiceInfoSnapshot?

Scans all currently active game servers (non-proxy) for the first server which the given player is currently connected to. If the player is not online, this function returns null.

getPlayerExecutor

open fun P.getPlayerExecutor(): PlayerExecutor

Gets the PlayerExecutor instance for the given player.

getPlayerUniqueId

abstract fun getPlayerUniqueId(player: P): UUID

Internal function to get the UUID of the given player.

getTotalPlayerCount

open fun getTotalPlayerCount(taskName: String): Int

Gets the total player count for all services of the given taskName. This function should only be used to get a total sum of ALL SERVERS OF THE GIVEN taskName.

isProxy

open fun ServiceInfoSnapshot.isProxy(): Boolean

Checks it the given ServiceInfoSnapshot is a known Minecraft proxy server, like BungeeCord, Velocity, etc.

runCommand

open fun P.runCommand(command: String)

Gets the PlayerExecutor for the given player and executes the given command as the player.