Server (SpongeAPI 7.3.0 API)

```
public interface Server
```
Represents a typical Minecraft Server.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Optional<WorldProperties>>`	`copyWorld(WorldProperties worldProperties, String copyName)` Creates a world copy asynchronously using the new name given and returns the new world properties if the copy was possible.
`WorldProperties`	`createWorldProperties(String folderName, WorldArchetype archetype)` Creates a new `WorldProperties` from the given `WorldArchetype`.
`CompletableFuture<Boolean>`	`deleteWorld(WorldProperties worldProperties)` Deletes the provided world's files asynchronously from the disk.
`Collection<WorldProperties>`	`getAllWorldProperties()` Gets the properties of all worlds, loaded or otherwise.
`Optional<InetSocketAddress>`	`getBoundAddress()` Gets the bound `InetSocketAddress` from where this server is accepting connections.
`MessageChannel`	`getBroadcastChannel()` Gets the message channel that server-wide messages are sent through.
`ChunkLayout`	`getChunkLayout()` Returns information about the chunk layout used by this server implementation.
`ChunkTicketManager`	`getChunkTicketManager()` Gets the ChunkTicketManager used for requesting tickets to force load chunks.
`ConsoleSource`	`getConsole()` Gets the command source used for commands coming from this server's console.
`Optional<ResourcePack>`	`getDefaultResourcePack()` Gets the default resource pack.
`Optional<WorldProperties>`	`getDefaultWorld()` Gets the properties of default world.
`String`	`getDefaultWorldName()` Gets the default `World` name that the server creates and loads.
`GameProfileManager`	`getGameProfileManager()` Gets the `GameProfileManager` for resolving game profiles.
`int`	`getMaxPlayers()` Gets the max players allowed on this server.
`Text`	`getMotd()` Gets the default message that is displayed in the server list of the client.
`boolean`	`getOnlineMode()` Tests if this server is set to online mode.
`Collection<Player>`	`getOnlinePlayers()` Gets the `Player`s currently online.
`Optional<Player>`	`getPlayer(String name)` Gets a `Player` by their name.
`Optional<Player>`	`getPlayer(UUID uniqueId)` Gets a `Player` by their UUID.
`int`	`getPlayerIdleTimeout()` Gets the player idle timeout, in minutes.
`int`	`getRunningTimeTicks()` Gets the time, in ticks, since this server began running for the current session.
`Optional<Scoreboard>`	`getServerScoreboard()` Gets the 'server' scoreboard.
`double`	`getTicksPerSecond()` Gets the current ticks per second.
`Collection<WorldProperties>`	`getUnloadedWorlds()` Gets the properties of all unloaded worlds.
`Optional<World>`	`getWorld(String worldName)` Gets a loaded `World` by name, if it exists.
`Optional<World>`	`getWorld(UUID uniqueId)` Gets a loaded `World` by its unique id (`UUID`), if it exists.
`Optional<WorldProperties>`	`getWorldProperties(String worldName)` Gets the `WorldProperties` of a world.
`Optional<WorldProperties>`	`getWorldProperties(UUID uniqueId)` Gets the `WorldProperties` of a world.
`Collection<World>`	`getWorlds()` Gets all currently loaded `World`s.
`boolean`	`hasWhitelist()` Tests if the server has a whitelist enabled.
`boolean`	`isMainThread()` Checks if the current thread matches the main thread of the server.
`Optional<World>`	`loadWorld(String worldName)` Loads a `World` from the default storage container.
`Optional<World>`	`loadWorld(UUID uniqueId)` Loads a `World` from the default storage container.
`Optional<World>`	`loadWorld(WorldProperties properties)` Loads a `World` from the default storage container.
`Optional<WorldProperties>`	`renameWorld(WorldProperties worldProperties, String newName)` Renames an unloaded world.
`boolean`	`saveWorldProperties(WorldProperties properties)` Persists the given `WorldProperties` to the world storage for it, updating any modified values.
`void`	`setBroadcastChannel(MessageChannel channel)` Sets the channel that server-wide messages should be sent through.
`void`	`setHasWhitelist(boolean enabled)` Sets whether the server is utilizing a whitelist.
`void`	`setPlayerIdleTimeout(int timeout)` Sets the player idle timeout, in minutes.
`void`	`shutdown()` Shuts down the server, and kicks all players with the default kick message.
`void`	`shutdown(Text kickMessage)` Shuts down the server, and kicks all players with the given message.
`boolean`	`unloadWorld(World world)` Unloads a `World`, if there are any connected players in the given world then no operation will occur.

- Method Detail
  - getOnlinePlayers
```
Collection<Player> getOnlinePlayers()
```
    Gets the Players currently online.
    
    Returns:
    
    A Collection of online players
  - getMaxPlayers
```
int getMaxPlayers()
```
    Gets the max players allowed on this server.
    
    Returns:
    
    Maximum number of connected players
  - getPlayer
```
Optional<Player> getPlayer(UUID uniqueId)
```
    Gets a Player by their UUID.
    
    Parameters:
    
    uniqueId - The UUID to get the player from
    
    Returns:
    
    The Player or empty if not found
  - getPlayer
```
Optional<Player> getPlayer(String name)
```
    Gets a Player by their name.
    This only works for online players.
    
    Note: Do not use names for persistent storage, the Notch of today may not be the Notch of yesterday.
    
    Parameters:
    
    name - The name to get the player from
    
    Returns:
    
    The Player or empty if not found
  - getWorlds
```
Collection<World> getWorlds()
```
    Gets all currently loaded Worlds.
    
    Returns:
    
    A collection of loaded worlds
  - getUnloadedWorlds
```
Collection<WorldProperties> getUnloadedWorlds()
```
    Gets the properties of all unloaded worlds.
    
    Returns:
    
    A collection of world properties
  - getAllWorldProperties
```
Collection<WorldProperties> getAllWorldProperties()
```
    Gets the properties of all worlds, loaded or otherwise.
    
    Returns:
    
    A collection of world properties
  - getWorld
```
Optional<World> getWorld(UUID uniqueId)
```
    Gets a loaded World by its unique id (UUID), if it exists.
    
    Parameters:
    
    uniqueId - UUID to lookup
    
    Returns:
    
    The world, if found
  - getWorld
```
Optional<World> getWorld(String worldName)
```
    Gets a loaded World by name, if it exists.
    
    Parameters:
    
    worldName - Name to lookup
    
    Returns:
    
    The world, if found
  - getDefaultWorld
```
Optional<WorldProperties> getDefaultWorld()
```
    Gets the properties of default world.
    
    Returns:
    
    The world properties
  - getDefaultWorldName
```
String getDefaultWorldName()
```
    Gets the default World name that the server creates and loads.
    
    Returns:
    
    The name
  - loadWorld
```
Optional<World> loadWorld(String worldName)
```
    Loads a World from the default storage container. If a world with the given name is already loaded then it is returned instead.
    
    Parameters:
    
    worldName - The name to lookup
    
    Returns:
    
    The world, if found
  - loadWorld
```
Optional<World> loadWorld(UUID uniqueId)
```
    Loads a World from the default storage container. If a world with the given UUID is already loaded then it is returned instead.
    
    Parameters:
    
    uniqueId - The UUID to lookup
    
    Returns:
    
    The world, if found
  - loadWorld
```
Optional<World> loadWorld(WorldProperties properties)
```
    Loads a World from the default storage container. If the world associated with the given properties is already loaded then it is returned instead.
    
    Parameters:
    
    properties - The properties of the world to load
    
    Returns:
    
    The world, if found
  - getWorldProperties
```
Optional<WorldProperties> getWorldProperties(String worldName)
```
    Gets the WorldProperties of a world. If a world with the given name is loaded then this is equivalent to calling World.getProperties(). However, if no loaded world is found then an attempt will be made to match unloaded worlds.
    
    Parameters:
    
    worldName - The name to lookup
    
    Returns:
    
    The world properties, if found
  - getWorldProperties
```
Optional<WorldProperties> getWorldProperties(UUID uniqueId)
```
    Gets the WorldProperties of a world. If a world with the given UUID is loaded then this is equivalent to calling World.getProperties(). However, if no loaded world is found then an attempt will be made to match unloaded worlds.
    
    Parameters:
    
    uniqueId - The UUID to lookup
    
    Returns:
    
    The world properties, if found
  - unloadWorld
```
boolean unloadWorld(World world)
```
    Unloads a World, if there are any connected players in the given world then no operation will occur.
    A world which is unloaded will be removed from memory. However if it is still enabled according to WorldProperties.isEnabled() then it will be loaded again if the server is restarted.
    
    Parameters:
    
    world - The world to unload
    
    Returns:
    
    Whether the operation was successful
  - createWorldProperties
```
WorldProperties createWorldProperties(String folderName,
                                      WorldArchetype archetype)
                               throws IOException
```
    Creates a new WorldProperties from the given WorldArchetype. For the creation of the WorldArchetype please see WorldArchetype.Builder.
    If the World exists at the folder name given, the properties representing that folder name are returned instead.
    
    Although the world is created it is not loaded at this time. Please see one of the following methods for loading the world.
    Parameters:
    
    folderName - The name of the folder for the world
    
    archetype - The archetype for creation
    
    Returns:
    
    The new or existing world properties, if creation was successful
    
    Throws:
    
    IOException - If there are any io issues creating the properties file
  - copyWorld
```
CompletableFuture<Optional<WorldProperties>> copyWorld(WorldProperties worldProperties,
                                                       String copyName)
```
    Creates a world copy asynchronously using the new name given and returns the new world properties if the copy was possible.
    If the world is already loaded then the following will occur:
    - World is saved.
    - World saving is disabled.
    - World is copied.
    - World saving is enabled.
    Parameters:
    
    worldProperties - The world properties to copy
    
    copyName - The name for copied world
    
    Returns:
    
    An Optional containing the properties of the new world instance, if the copy was successful
  - renameWorld
```
Optional<WorldProperties> renameWorld(WorldProperties worldProperties,
                                      String newName)
```
    Renames an unloaded world.
    
    Parameters:
    
    worldProperties - The world properties to rename
    
    newName - The name that should be used as a replacement for the current world name
    
    Returns:
    
    An Optional containing the new WorldProperties if the rename was successful
  - deleteWorld
```
CompletableFuture<Boolean> deleteWorld(WorldProperties worldProperties)
```
    Deletes the provided world's files asynchronously from the disk.
    
    Parameters:
    
    worldProperties - The world properties to delete
    
    Returns:
    
    True if the deletion was successful.
  - saveWorldProperties
```
boolean saveWorldProperties(WorldProperties properties)
```
    Persists the given WorldProperties to the world storage for it, updating any modified values.
    
    Parameters:
    
    properties - The world properties to save
    
    Returns:
    
    True if the save was successful
  - getServerScoreboard
```
Optional<Scoreboard> getServerScoreboard()
```
    Gets the 'server' scoreboard. In Vanilla, this is the scoreboard of dimension 0 (the overworld).
    The server scoreboard is used with the Vanilla /scoreboard command, automatic score updating through criteria, and other things.
    
    The server scoreboard may not be available if dimension 0 is not yet loaded. In Vanilla, this will only occur when the server is first starting, as dimension 0 is normally always loaded.
    
    Returns:
    
    the server scoreboard, if available.
  - getChunkLayout
```
ChunkLayout getChunkLayout()
```
    Returns information about the chunk layout used by this server implementation.
    
    Returns:
    
    The chunk layout used by the implementation
  - getRunningTimeTicks
```
int getRunningTimeTicks()
```
    Gets the time, in ticks, since this server began running for the current session.
    This value is not persisted across server restarts, it is set to zero each time the server starts.
    
    Returns:
    
    The number of ticks since this server started running
  - getBroadcastChannel
```
MessageChannel getBroadcastChannel()
```
    Gets the message channel that server-wide messages are sent through.
    
    Returns:
    
    The server-wide broadcast channel
  - setBroadcastChannel
```
void setBroadcastChannel(MessageChannel channel)
```
    Sets the channel that server-wide messages should be sent through.
    
    Parameters:
    
    channel - The broadcast channel
  - getBoundAddress
```
Optional<InetSocketAddress> getBoundAddress()
```
    Gets the bound InetSocketAddress from where this server is accepting connections.
    
    Returns:
    
    The address or Optional.empty() if not found
  - hasWhitelist
```
boolean hasWhitelist()
```
    Tests if the server has a whitelist enabled.
    
    Returns:
    
    True if enabled, false if not
  - setHasWhitelist
```
void setHasWhitelist(boolean enabled)
```
    Sets whether the server is utilizing a whitelist.
    
    Parameters:
    
    enabled - True to enable the whitelist, false to disable
  - getOnlineMode
```
boolean getOnlineMode()
```
    Tests if this server is set to online mode. Online mode authenticates users against Minecraft's servers, false performs no validity checks.
    
    Returns:
    
    True if enabled, false if not
  - getMotd
```
Text getMotd()
```
    Gets the default message that is displayed in the server list of the client.
    
    Returns:
    
    The server's default description (MOTD)
  - shutdown
```
void shutdown()
```
    Shuts down the server, and kicks all players with the default kick message.
    For the Sponge implementation on the client, this will trigger the Integrated Server to shutdown a tick later.
  - shutdown
```
void shutdown(Text kickMessage)
```
    Shuts down the server, and kicks all players with the given message.
    
    Parameters:
    
    kickMessage - The message to kick players with
  - getConsole
```
ConsoleSource getConsole()
```
    Gets the command source used for commands coming from this server's console.
    
    Returns:
    
    This server's console command source
  - getChunkTicketManager
```
ChunkTicketManager getChunkTicketManager()
```
    Gets the ChunkTicketManager used for requesting tickets to force load chunks.
    
    Returns:
    
    This server's chunk load service
  - getGameProfileManager
```
GameProfileManager getGameProfileManager()
```
    Gets the GameProfileManager for resolving game profiles.
    
    Returns:
    
    This server's game profile manager
  - getTicksPerSecond
```
double getTicksPerSecond()
```
    Gets the current ticks per second. A tick represents one cycle of the game loop.
    Note: The server aims to limit itself at 20 ticks per second. Lower ticks per second may elude to the server taking more time to process information per tick. Examples of overburdening the server per tick include spawning 10,000 cows in a small area.
    
    Returns:
    
    The current ticks per second
  - getDefaultResourcePack
```
Optional<ResourcePack> getDefaultResourcePack()
```
    Gets the default resource pack. The default resource pack is sent to players when they join the server.
    
    Returns:
    
    The default resource pack
  - getPlayerIdleTimeout
```
int getPlayerIdleTimeout()
```
    Gets the player idle timeout, in minutes.
    A return value of 0 disables the player idle timeout.
    
    Returns:
    
    The player idle timeout
  - setPlayerIdleTimeout
```
void setPlayerIdleTimeout(int timeout)
```
    Sets the player idle timeout, in minutes.
    A value of 0 disables the player idle timeout.
    
    Parameters:
    
    timeout - The player idle timeout
  - isMainThread
```
boolean isMainThread()
```
    Checks if the current thread matches the main thread of the server.
    
    Returns:
    
    True if main thread, false if not

Interface Server

Method Summary

Method Detail

getOnlinePlayers

getMaxPlayers

getPlayer

getPlayer

getWorlds

getUnloadedWorlds

getAllWorldProperties

getWorld

getWorld

getDefaultWorld

getDefaultWorldName

loadWorld

loadWorld

loadWorld

getWorldProperties

getWorldProperties

unloadWorld

createWorldProperties

copyWorld

renameWorld

deleteWorld

saveWorldProperties

getServerScoreboard

getChunkLayout

getRunningTimeTicks

getBroadcastChannel

setBroadcastChannel

getBoundAddress

hasWhitelist

setHasWhitelist

getOnlineMode

getMotd

shutdown

shutdown

getConsole

getChunkTicketManager

getGameProfileManager

getTicksPerSecond

getDefaultResourcePack

getPlayerIdleTimeout

setPlayerIdleTimeout

isMainThread