Serialized Form

Package de.rexlcloud.core.api

Class de.rexlcloud.core.api.Player

class Player extends Object implements Serializable

Serialized Fields

data

ArrayList<PlayerDatabaseData> data

The stored data entries of the player; read them with Player.getData(String).

login

long login

When the player joined the network, in milliseconds since the epoch.

name

@NonNull String name

The player's name.

proxyServer

@NonNull Server proxyServer

The proxy the player is connected through.

server

@NonNull Server server

The server the player is on.

uuid

@NotNull UUID uuid

The player's UUID.

Class de.rexlcloud.core.api.PlayerDatabaseData

class PlayerDatabaseData extends Object implements Serializable

Serialized Fields

id

int id

key

String key

Name of the value.

uuid

UUID uuid

The player.

value

byte[] value

The serialized value; read it with Player.getData(String).

Class de.rexlcloud.core.api.Server

class Server extends Object implements Serializable

Serialized Fields

key

@NonNull UUID key

Identifies this run of the server; a new run (after a restart) gets a new key.

name

@NonNull String name

Name of the server, e.g. Lobby-1.

online

boolean online

Whether the server is online: started and its cloud plugin is connected.

port

int port

The port players (or the proxy) connect to.

serverGroup

@NonNull ServerGroup serverGroup

The group the server belongs to.

state

@NonNull String state

A free-form state the server set with Server.setState(String), e.g. "ingame"; empty by default. Servers in the state ingame are never stopped for being idle.

wrapper

@NonNull Wrapper wrapper

The wrapper the server runs on.

Class de.rexlcloud.core.api.ServerLocation

class ServerLocation extends Object implements Serializable

Serialized Fields

pitch

float pitch

worldName

@Nullable String worldName

Name of the world (Minestom: the UUID of the instance), null for the player's current one.

x

double x

X coordinate.

y

double y

Y coordinate.

yaw

float yaw

Viewing direction in degrees.

z

double z

Z coordinate.

Class de.rexlcloud.core.api.Wrapper

class Wrapper extends Object implements Serializable

Serialized Fields

cpuUsage

double cpuUsage

CPU load of the wrapper's machine from 0 to 1; negative if unknown.

freeMemory

long freeMemory

name

@NonNull String name

Name of the wrapper, e.g. Wrapper-1.

online

boolean online

Whether the wrapper is connected to the master.

totalMemory

long totalMemory

usedMemory

long usedMemory

Memory of the machine in bytes: in use, available to new servers (including the page cache the system gives back) and in total.

Package de.rexlcloud.core.api.exceptions

Exception Class de.rexlcloud.core.api.exceptions.CloudException

class CloudException extends RuntimeException implements Serializable

Serialized Fields

receivedMessage

String receivedMessage

Message of an exception received from another component, which its constructor might have changed.

Exception Class de.rexlcloud.core.api.exceptions.MessageChannelAlreadyRegisteredException

class MessageChannelAlreadyRegisteredException extends CloudException implements Serializable

Exception Class de.rexlcloud.core.api.exceptions.MessageChannelNotRegisteredException

class MessageChannelNotRegisteredException extends CloudException implements Serializable

Exception Class de.rexlcloud.core.api.exceptions.NoConnectionException

class NoConnectionException extends CloudException implements Serializable

Exception Class de.rexlcloud.core.api.exceptions.PlayerNotFoundException

class PlayerNotFoundException extends CloudException implements Serializable

Serialized Fields

playerName

@Nullable String playerName

playerUUID

@Nullable UUID playerUUID

Exception Class de.rexlcloud.core.api.exceptions.ServerGroupNotFoundException

class ServerGroupNotFoundException extends CloudException implements Serializable

Serialized Fields

serverGroupName

String serverGroupName

Exception Class de.rexlcloud.core.api.exceptions.ServerNotFoundException

class ServerNotFoundException extends CloudException implements Serializable

Serialized Fields

serverName

String serverName

Exception Class de.rexlcloud.core.api.exceptions.TimeOutException

class TimeOutException extends CloudException implements Serializable

Exception Class de.rexlcloud.core.api.exceptions.ToManyRequestsException

class ToManyRequestsException extends CloudException implements Serializable

Exception Class de.rexlcloud.core.api.exceptions.WrapperNotFoundException

class WrapperNotFoundException extends CloudException implements Serializable

Serialized Fields

wrapperName

String wrapperName

Package de.rexlcloud.core.server

Record Class de.rexlcloud.core.server.ProxyForwarding

class ProxyForwarding extends Record implements Serializable

serialVersionUID:

1L

Serialized Fields

mode

@NonNull de.rexlcloud.core.server.ProxyForwarding.Mode mode

secret

@NonNull String secret

Class de.rexlcloud.core.server.ServerGroup

class ServerGroup extends Object implements Serializable

Serialized Fields

customJar

boolean customJar

The group's servers run the server.jar the user put into the template (e.g. a Minestom server with the MinestomBridge) instead of a downloaded Paper/Spigot jar. Such servers get no cloud plugin, no Paper/Spigot configuration and no start arguments; they read everything from their cloud.json.

fallback

boolean fallback

Whether players are sent to this group's servers when they join or are kicked from another server.

javaArguments

@NonNull String javaArguments

Extra JVM arguments of the servers, e.g. -XX:+UseG1GC.

javaCommand

String javaCommand

The Java the servers run with: java from the wrapper's PATH or the path of an installed runtime.

maxPlayers

int maxPlayers

Player slots shown in the server list.

memory

int memory

Memory of each server in MB.

minServers

int minServers

How many servers the cloud keeps running.

name

@NonNull String name

Name of the group; its servers are called <name>-1, <name>-2, ...

removeOldLogs

boolean removeOldLogs

Whether the logs of a static server are deleted when it starts.

staticServer

boolean staticServer

Whether the group has one server that keeps its files on a fixed wrapper instead of starting fresh from the template.

type

@NonNull ServerType type

Servers or proxies.

wrapper

@Nullable String wrapper

The wrapper of a static group, null otherwise.