Server (Cloudburst 0.0.1-SNAPSHOT API)

java.lang.Object
- org.cloudburstmc.server.Server

```
public class Server
extends Object
```
Author:

MagicDroidX, Box

Field Summary

Fields
Modifier and Type Field and Description

static String BROADCAST_CHANNEL_ADMINISTRATIVE

static String BROADCAST_CHANNEL_USERS

int networkCompressionLevel

Fields
Modifier and Type	Field and Description
`static String`	`BROADCAST_CHANNEL_ADMINISTRATIVE`
`static String`	`BROADCAST_CHANNEL_USERS`
`int`	`networkCompressionLevel`

Constructor Summary

Constructors
Constructor and Description

Server(Path dataPath, Path pluginPath, Path levelPath, String predefinedLanguage)

Constructors
Constructor and Description
`Server(Path dataPath, Path pluginPath, Path levelPath, String predefinedLanguage)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addOnlinePlayer(Player player)`
`void`	`addOp(String name)`
`void`	`addPlayer(InetSocketAddress socketAddress, Player player)`
`void`	`addRecipe(Recipe recipe)`
`void`	`addWhitelist(String name)`
`void`	`batchPackets(Player[] players, com.nukkitx.protocol.bedrock.BedrockPacket[] packets)`
`void`	`batchPackets(Player[] players, com.nukkitx.protocol.bedrock.BedrockPacket[] packets, boolean forceSync)`
`void`	`boot()`
`int`	`broadcast(String message, String permissions)`
`int`	`broadcast(TextContainer message, String permissions)`
`int`	`broadcastMessage(String message)`
`int`	`broadcastMessage(String message, Collection<? extends CommandSender> recipients)`
`int`	`broadcastMessage(String message, CommandSender[] recipients)`
`int`	`broadcastMessage(TextContainer message)`
`int`	`broadcastMessage(TextContainer message, Collection<? extends CommandSender> recipients)`
`static void`	`broadcastPacket(Collection<Player> players, com.nukkitx.protocol.bedrock.BedrockPacket packet)`
`static void`	`broadcastPacket(Player[] players, com.nukkitx.protocol.bedrock.BedrockPacket packet)`
`static void`	`broadcastPackets(Player[] players, com.nukkitx.protocol.bedrock.BedrockPacket[] packets)`
`boolean`	`dispatchCommand(CommandSender sender, String commandLine)`
`void`	`doAutoSave()`
`void`	`forceShutdown()`
`boolean`	`getAllowFlight()`
`String`	`getApiVersion()`
`boolean`	`getAutoSave()`
`int`	`getAutoTickRateLimit()`
`int`	`getBaseTickRate()`
`BlockRegistry`	`getBlockRegistry()`
`Map<String,List<String>>`	`getCommandAliases()`
`CommandRegistry`	`getCommandRegistry()`
`ServerConfig`	`getConfig()`
`ConsoleCommandSender`	`getConsoleSender()`
`CraftingManager`	`getCraftingManager()`
`Path`	`getDataPath()`
`GameMode`	`getDefaultGamemode()`
`Level`	`getDefaultLevel()`
`LevelData`	`getDefaultLevelData()`
`Identifier`	`getDefaultStorageId()`
`Difficulty`	`getDifficulty()`
`EntityMetadataStore`	`getEntityMetadata()`
`CloudEventManager`	`getEventManager()`
`Path`	`getFilePath()`
`boolean`	`getForceGamemode()`
`boolean`	`getForceResources()`
`GameMode`	`getGamemode()`
`GameRuleRegistry`	`getGameRuleRegistry()`
`boolean`	`getGenerateStructures()`
`GeneratorRegistry`	`getGeneratorRegistry()`
`static Server`	`getInstance()`
`String`	`getIp()`
`BanList`	`getIPBans()`
`ItemRegistry`	`getItemRegistry()`
`LocaleManager`	`getLanguage()`
`Level`	`getLevel(String id)`
`Level`	`getLevelByName(String name)`
`LevelManager`	`getLevelManager()`
`LevelMetadataStore`	`getLevelMetadata()`
`Set<Level>`	`getLevels()`
`int`	`getMaxPlayers()`
`String`	`getMotd()`
`String`	`getName()`
`BanList`	`getNameBans()`
`Network`	`getNetwork()`
`long`	`getNextTick()`
`String`	`getNukkitVersion()`
`IPlayer`	`getOfflinePlayer(String name)` Deprecated.
`IPlayer`	`getOfflinePlayer(UUID uuid)`
`com.nukkitx.nbt.NbtMap`	`getOfflinePlayerData(String name)` Deprecated.
`com.nukkitx.nbt.NbtMap`	`getOfflinePlayerData(String name, boolean create)` Deprecated.
`com.nukkitx.nbt.NbtMap`	`getOfflinePlayerData(UUID uuid)`
`com.nukkitx.nbt.NbtMap`	`getOfflinePlayerData(UUID uuid, boolean create)`
`Map<UUID,Player>`	`getOnlinePlayers()`
`Config`	`getOps()`
`PackManager`	`getPackManager()`
`CloudPermissionManager`	`getPermissionManager()`
`Player`	`getPlayer(String name)`
`Optional<Player>`	`getPlayer(UUID uuid)`
`PlayerDataSerializer`	`getPlayerDataSerializer()`
`Player`	`getPlayerExact(String name)`
`PlayerMetadataStore`	`getPlayerMetadata()`
`int`	`getPlayerSkinChangeCooldown()`
`PluginManager`	`getPluginManager()`
`Path`	`getPluginPath()`
`int`	`getPort()`
`Thread`	`getPrimaryThread()`
`QueryRegenerateEvent`	`getQueryInformation()`
`ServerScheduler`	`getScheduler()`
`UUID`	`getServerUniqueId()`
`int`	`getSpawnRadius()`
`StorageRegistry`	`getStorageRegistry()`
`String`	`getSubMotd()`
`int`	`getTick()`
`float`	`getTicksPerSecond()`
`float`	`getTicksPerSecondAverage()`
`float`	`getTickUsage()`
`float`	`getTickUsageAverage()`
`String`	`getVersion()`
`int`	`getViewDistance()`
`Config`	`getWhitelist()`
`void`	`handlePacket(InetSocketAddress address, io.netty.buffer.ByteBuf payload)`
`boolean`	`hasWhitelist()`
`boolean`	`isAutoTickRate()`
`boolean`	`isHardcore()`
`boolean`	`isIgnoredPacket(Class<? extends com.nukkitx.protocol.bedrock.BedrockPacket> clazz)`
`boolean`	`isLanguageForced()`
`boolean`	`isLevelLoaded(String name)`
`boolean`	`isNetherAllowed()`
`boolean`	`isOp(String name)`
`boolean`	`isPrimaryThread()` Checks the current thread against the expected primary thread for the server.
`boolean`	`isRunning()`
`boolean`	`isWhitelisted(String name)`
`LevelBuilder`	`loadLevel()`
`Optional<UUID>`	`lookupName(String name)`
`Player[]`	`matchPlayer(String partialName)`
`void`	`onPlayerCompleteLoginSequence(Player player)`
`void`	`onPlayerLogin(Player player)`
`void`	`reloadWhitelist()`
`void`	`removeOnlinePlayer(Player player)`
`void`	`removeOp(String name)`
`void`	`removePlayer(Player player)`
`void`	`removePlayerListData(UUID uuid)`
`void`	`removePlayerListData(UUID uuid, Collection<Player> players)`
`void`	`removePlayerListData(UUID uuid, Player[] players)`
`void`	`removeWhitelist(String name)`
`void`	`saveOfflinePlayerData(String name, com.nukkitx.nbt.NbtMap tag)`
`void`	`saveOfflinePlayerData(String name, com.nukkitx.nbt.NbtMap tag, boolean async)`
`void`	`saveOfflinePlayerData(UUID uuid, com.nukkitx.nbt.NbtMap tag)`
`void`	`saveOfflinePlayerData(UUID uuid, com.nukkitx.nbt.NbtMap tag, boolean async)`
`void`	`sendFullPlayerListData(Player player)`
`void`	`sendRecipeList(Player player)`
`void`	`setAutoSave(boolean autoSave)`
`void`	`setDefaultLevel(Level level)`
`void`	`setMaxPlayers(int maxPlayers)`
`void`	`setPlayerDataSerializer(PlayerDataSerializer playerDataSerializer)`
`boolean`	`shouldSavePlayerData()`
`void`	`shutdown()`
`void`	`start()`
`void`	`tickProcessor()`
`void`	`titleTick()`
`boolean`	`unloadLevel(Level level)`
`boolean`	`unloadLevel(Level level, boolean forceUnload)`
`void`	`updateName(UUID uuid, String name)`
`void`	`updatePlayerListData(UUID uuid, long entityId, String name, com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin)`
`void`	`updatePlayerListData(UUID uuid, long entityId, String name, com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin, Player[] players)`
`void`	`updatePlayerListData(UUID uuid, long entityId, String name, com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin, String xboxUserId)`
`void`	`updatePlayerListData(UUID uuid, long entityId, String name, com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin, String xboxUserId, Collection<Player> players)`
`void`	`updatePlayerListData(UUID uuid, long entityId, String name, com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin, String xboxUserId, Player[] players)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BROADCAST_CHANNEL_ADMINISTRATIVE

public static final String BROADCAST_CHANNEL_ADMINISTRATIVE

See Also:: Constant Field Values

BROADCAST_CHANNEL_USERS

public static final String BROADCAST_CHANNEL_USERS

See Also:: Constant Field Values

networkCompressionLevel
```
public int networkCompressionLevel
```

Constructor Detail

Server

public Server(Path dataPath,
              Path pluginPath,
              Path levelPath,
              String predefinedLanguage)

Method Detail

broadcastPackets

public static void broadcastPackets(Player[] players,
                                    com.nukkitx.protocol.bedrock.BedrockPacket[] packets)

broadcastPacket

public static void broadcastPacket(Player[] players,
                                   com.nukkitx.protocol.bedrock.BedrockPacket packet)

broadcastMessage

public int broadcastMessage(String message)

broadcastMessage

public int broadcastMessage(TextContainer message)

broadcastMessage

public int broadcastMessage(String message,
                            CommandSender[] recipients)

broadcastMessage

public int broadcastMessage(String message,
                            Collection<? extends CommandSender> recipients)

broadcastMessage

public int broadcastMessage(TextContainer message,
                            Collection<? extends CommandSender> recipients)

broadcast

public int broadcast(String message,
                     String permissions)

broadcast

public int broadcast(TextContainer message,
                     String permissions)

broadcastPacket

public static void broadcastPacket(Collection<Player> players,
                                   com.nukkitx.protocol.bedrock.BedrockPacket packet)

boot

public void boot()
          throws IOException

Throws:: IOException

batchPackets

public void batchPackets(Player[] players,
                         com.nukkitx.protocol.bedrock.BedrockPacket[] packets)

batchPackets

public void batchPackets(Player[] players,
                         com.nukkitx.protocol.bedrock.BedrockPacket[] packets,
                         boolean forceSync)

dispatchCommand

public boolean dispatchCommand(CommandSender sender,
                               String commandLine)
                        throws ServerException

Throws:: ServerException

getConsoleSender

public ConsoleCommandSender getConsoleSender()

shutdown
```
public void shutdown()
```

forceShutdown
```
public void forceShutdown()
```

start
```
public void start()
```

handlePacket

public void handlePacket(InetSocketAddress address,
                         io.netty.buffer.ByteBuf payload)

tickProcessor
```
public void tickProcessor()
```

onPlayerCompleteLoginSequence

public void onPlayerCompleteLoginSequence(Player player)

onPlayerLogin

public void onPlayerLogin(Player player)

addPlayer

public void addPlayer(InetSocketAddress socketAddress,
                      Player player)

addOnlinePlayer

public void addOnlinePlayer(Player player)

removeOnlinePlayer

public void removeOnlinePlayer(Player player)

updatePlayerListData

public void updatePlayerListData(UUID uuid,
                                 long entityId,
                                 String name,
                                 com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin)

updatePlayerListData

public void updatePlayerListData(UUID uuid,
                                 long entityId,
                                 String name,
                                 com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin,
                                 String xboxUserId)

updatePlayerListData

public void updatePlayerListData(UUID uuid,
                                 long entityId,
                                 String name,
                                 com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin,
                                 Player[] players)

updatePlayerListData

public void updatePlayerListData(UUID uuid,
                                 long entityId,
                                 String name,
                                 com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin,
                                 String xboxUserId,
                                 Player[] players)

updatePlayerListData

public void updatePlayerListData(UUID uuid,
                                 long entityId,
                                 String name,
                                 com.nukkitx.protocol.bedrock.data.skin.SerializedSkin skin,
                                 String xboxUserId,
                                 Collection<Player> players)

removePlayerListData

public void removePlayerListData(UUID uuid)

removePlayerListData

public void removePlayerListData(UUID uuid,
                                 Player[] players)

removePlayerListData

public void removePlayerListData(UUID uuid,
                                 Collection<Player> players)

sendFullPlayerListData

public void sendFullPlayerListData(Player player)

sendRecipeList

public void sendRecipeList(Player player)

doAutoSave
```
public void doAutoSave()
```

getNextTick
```
public long getNextTick()
```

titleTick
```
public void titleTick()
```

getQueryInformation

public QueryRegenerateEvent getQueryInformation()

getName
```
public String getName()
```

isRunning
```
public boolean isRunning()
```

getNukkitVersion
```
public String getNukkitVersion()
```

getVersion
```
public String getVersion()
```

getApiVersion
```
public String getApiVersion()
```

getFilePath
```
public Path getFilePath()
```

getDataPath
```
public Path getDataPath()
```

getPluginPath
```
public Path getPluginPath()
```

getMaxPlayers
```
public int getMaxPlayers()
```

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

getPort
```
public int getPort()
```

getViewDistance
```
public int getViewDistance()
```

getIp
```
public String getIp()
```

getServerUniqueId
```
public UUID getServerUniqueId()
```

getAutoSave
```
public boolean getAutoSave()
```

setAutoSave

public void setAutoSave(boolean autoSave)

getGenerateStructures

public boolean getGenerateStructures()

getGamemode
```
public GameMode getGamemode()
```

getForceGamemode
```
public boolean getForceGamemode()
```

getDifficulty
```
public Difficulty getDifficulty()
```

hasWhitelist
```
public boolean hasWhitelist()
```

getSpawnRadius
```
public int getSpawnRadius()
```

getAllowFlight
```
public boolean getAllowFlight()
```

isHardcore
```
public boolean isHardcore()
```

getDefaultGamemode
```
public GameMode getDefaultGamemode()
```

getMotd
```
public String getMotd()
```

getSubMotd
```
public String getSubMotd()
```

getForceResources
```
public boolean getForceResources()
```

getEntityMetadata

public EntityMetadataStore getEntityMetadata()

getPlayerMetadata

public PlayerMetadataStore getPlayerMetadata()

getLevelMetadata

public LevelMetadataStore getLevelMetadata()

getEventManager

public CloudEventManager getEventManager()

getPluginManager

public PluginManager getPluginManager()

getPermissionManager

public CloudPermissionManager getPermissionManager()

getCraftingManager

public CraftingManager getCraftingManager()

getPackManager
```
public PackManager getPackManager()
```

getScheduler
```
public ServerScheduler getScheduler()
```

getTick
```
public int getTick()
```

getTicksPerSecond
```
public float getTicksPerSecond()
```

getTicksPerSecondAverage

public float getTicksPerSecondAverage()

getTickUsage
```
public float getTickUsage()
```

getTickUsageAverage
```
public float getTickUsageAverage()
```

getCommandRegistry

public CommandRegistry getCommandRegistry()

getOnlinePlayers

public Map<UUID,Player> getOnlinePlayers()

addRecipe
```
public void addRecipe(Recipe recipe)
```

getPlayer

public Optional<Player> getPlayer(UUID uuid)

lookupName

public Optional<UUID> lookupName(String name)

updateName

public void updateName(UUID uuid,
                       String name)

getOfflinePlayer

@Deprecated
public IPlayer getOfflinePlayer(String name)

Deprecated.

getOfflinePlayer

public IPlayer getOfflinePlayer(UUID uuid)

getOfflinePlayerData

public com.nukkitx.nbt.NbtMap getOfflinePlayerData(UUID uuid)

getOfflinePlayerData

public com.nukkitx.nbt.NbtMap getOfflinePlayerData(UUID uuid,
                                                   boolean create)

getOfflinePlayerData

@Deprecated
public com.nukkitx.nbt.NbtMap getOfflinePlayerData(String name)

Deprecated.

getOfflinePlayerData

@Deprecated
public com.nukkitx.nbt.NbtMap getOfflinePlayerData(String name,
                                                               boolean create)

Deprecated.

saveOfflinePlayerData

public void saveOfflinePlayerData(UUID uuid,
                                  com.nukkitx.nbt.NbtMap tag)

saveOfflinePlayerData

public void saveOfflinePlayerData(String name,
                                  com.nukkitx.nbt.NbtMap tag)

saveOfflinePlayerData

public void saveOfflinePlayerData(UUID uuid,
                                  com.nukkitx.nbt.NbtMap tag,
                                  boolean async)

saveOfflinePlayerData

public void saveOfflinePlayerData(String name,
                                  com.nukkitx.nbt.NbtMap tag,
                                  boolean async)

getPlayer
```
public Player getPlayer(String name)
```

getPlayerExact

public Player getPlayerExact(String name)

matchPlayer

public Player[] matchPlayer(String partialName)

removePlayer

public void removePlayer(Player player)

getLevels
```
public Set<Level> getLevels()
```

getDefaultLevel
```
public Level getDefaultLevel()
```

setDefaultLevel

public void setDefaultLevel(Level level)

isLevelLoaded

public boolean isLevelLoaded(String name)

getLevel
```
public Level getLevel(String id)
```

getLevelByName

public Level getLevelByName(String name)

unloadLevel

public boolean unloadLevel(Level level)

unloadLevel

public boolean unloadLevel(Level level,
                           boolean forceUnload)

loadLevel
```
public LevelBuilder loadLevel()
```

getLanguage
```
public LocaleManager getLanguage()
```

isLanguageForced
```
public boolean isLanguageForced()
```

getNetwork
```
public Network getNetwork()
```

getConfig
```
public ServerConfig getConfig()
```

getNameBans
```
public BanList getNameBans()
```

getIPBans
```
public BanList getIPBans()
```

addOp
```
public void addOp(String name)
```

removeOp
```
public void removeOp(String name)
```

addWhitelist

public void addWhitelist(String name)

removeWhitelist

public void removeWhitelist(String name)

isWhitelisted

public boolean isWhitelisted(String name)

isOp
```
public boolean isOp(String name)
```

getWhitelist
```
public Config getWhitelist()
```

getOps
```
public Config getOps()
```

reloadWhitelist
```
public void reloadWhitelist()
```

getCommandAliases

public Map<String,List<String>> getCommandAliases()

shouldSavePlayerData
```
public boolean shouldSavePlayerData()
```

getPlayerSkinChangeCooldown

public int getPlayerSkinChangeCooldown()

isPrimaryThread
```
public final boolean isPrimaryThread()
```
Checks the current thread against the expected primary thread for the server.
Note: this method should not be used to indicate the current synchronized state of the runtime. A current thread matching the main thread indicates that it is synchronized, but a mismatch does not preclude the same assumption.

Returns:

true if the current thread matches the expected primary thread, false otherwise

getPrimaryThread
```
public Thread getPrimaryThread()
```

isNetherAllowed
```
public boolean isNetherAllowed()
```

getPlayerDataSerializer

public PlayerDataSerializer getPlayerDataSerializer()

setPlayerDataSerializer

public void setPlayerDataSerializer(PlayerDataSerializer playerDataSerializer)

getLevelManager
```
public LevelManager getLevelManager()
```

getDefaultLevelData

public LevelData getDefaultLevelData()

getDefaultStorageId

public Identifier getDefaultStorageId()

getStorageRegistry

public StorageRegistry getStorageRegistry()

getGameRuleRegistry

public GameRuleRegistry getGameRuleRegistry()

getBlockRegistry

public BlockRegistry getBlockRegistry()

getItemRegistry
```
public ItemRegistry getItemRegistry()
```

getGeneratorRegistry

public GeneratorRegistry getGeneratorRegistry()

getBaseTickRate
```
public int getBaseTickRate()
```

getAutoTickRateLimit
```
public int getAutoTickRateLimit()
```

isAutoTickRate
```
public boolean isAutoTickRate()
```

getInstance
```
public static Server getInstance()
```

isIgnoredPacket

public boolean isIgnoredPacket(Class<? extends com.nukkitx.protocol.bedrock.BedrockPacket> clazz)

Class Server

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BROADCAST_CHANNEL_ADMINISTRATIVE

BROADCAST_CHANNEL_USERS

networkCompressionLevel

Constructor Detail

Server

Method Detail

broadcastPackets

broadcastPacket

broadcastMessage

broadcastMessage

broadcastMessage

broadcastMessage

broadcastMessage

broadcast

broadcast

broadcastPacket

boot

batchPackets

batchPackets

dispatchCommand

getConsoleSender

shutdown

forceShutdown

start

handlePacket

tickProcessor

onPlayerCompleteLoginSequence

onPlayerLogin

addPlayer

addOnlinePlayer

removeOnlinePlayer

updatePlayerListData

updatePlayerListData

updatePlayerListData

updatePlayerListData

updatePlayerListData

removePlayerListData

removePlayerListData

removePlayerListData

sendFullPlayerListData

sendRecipeList

doAutoSave

getNextTick

titleTick

getQueryInformation

getName

isRunning

getNukkitVersion

getVersion

getApiVersion

getFilePath

getDataPath

getPluginPath

getMaxPlayers

setMaxPlayers

getPort

getViewDistance

getIp

getServerUniqueId

getAutoSave

setAutoSave

getGenerateStructures

getGamemode

getForceGamemode

getDifficulty

hasWhitelist

getSpawnRadius

getAllowFlight

isHardcore

getDefaultGamemode

getMotd

getSubMotd

getForceResources

getEntityMetadata