vital-cloudnet4-driver/dev.vitalframework.cloudnet4.driver/VitalCloudNet4Driver

VitalCloudNet4Driver

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-Driver module and provides easier-to-use APIs for it.

Properties

cloudServiceFactory

@JvmStatic

val cloudServiceFactory: @UnknownNullability CloudServiceFactory

cloudServiceProvider

@JvmStatic

val cloudServiceProvider: @UnknownNullability CloudServiceProvider

serviceTaskProvider

@JvmStatic

val serviceTaskProvider: @UnknownNullability ServiceTaskProvider

Functions

getCloudServer

@JvmStatic

fun getCloudServer(serverName: String): @Nullable ServiceInfoSnapshot?

Gets a single server by its serverName, e.g. Lobby-1, Lobby-2, etc.

getCloudServers

@JvmStatic

@JvmOverloads

fun getCloudServers(predicate: Predicate<ServiceInfoSnapshot> = Predicate { true }): List<ServiceInfoSnapshot?>

Gets all currently running servers that match the given predicate.

@JvmStatic

fun getCloudServers(taskName: String): @UnmodifiableView Collection<ServiceInfoSnapshot?>

Gets all servers of the given taskName, e.g. Lobby, Bedwars.

getServerTask

@JvmStatic

fun getServerTask(taskName: String): @Nullable ServiceTask?

Gets the ServiceTask of the given taskName.

startCloudServer

@JvmStatic

fun startCloudServer(taskName: String): ServiceCreateResult?

Gets the ServiceTask by calling getServerTask with the given taskName and attempts to start a new server from it. If no task exists for the given taskName, this function does nothing.

stopCloudServer

@JvmStatic

fun stopCloudServer(serverName: String): Unit?

Stops the server with the given serverName. If no server was found with the given serverName, this function does nothing.