Package org.bukkit

Interface Server

All Superinterfaces:

PluginMessageRecipient

public interface Server
extends PluginMessageRecipient

Represents a server implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Server.Spigot

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROADCAST_CHANNEL_ADMINISTRATIVE	Used for all administrative messages, such as an operator using a command.
static final String	BROADCAST_CHANNEL_USERS	Used for all announcement messages, such as informing users that a player has joined.

Method Summary

Modifier and Type	Method	Description
boolean	addRecipe(Recipe recipe)	Adds a recipe to the crafting manager.
Iterator<Advancement>	advancementIterator()	Get an iterator through all advancements.
void	banIP(String address)	Deprecated. see banIP(InetAddress)
void	banIP(InetAddress address)	Bans the specified address from the server.
int	broadcast(String message, String permission)	Broadcasts the specified message to every user with the given permission name.
int	broadcastMessage(String message)	Broadcast a message to all players.
void	clearRecipes()	Clears the list of crafting recipes.
ItemStack	craftItem(ItemStack[] craftingMatrix, World world)	Get the crafted item using the list of ItemStack provided.
ItemStack	craftItem(ItemStack[] craftingMatrix, World world, Player player)	Get the crafted item using the list of ItemStack provided.
ItemCraftResult	craftItemResult(ItemStack[] craftingMatrix, World world)	Get the crafted item using the list of ItemStack provided.
ItemCraftResult	craftItemResult(ItemStack[] craftingMatrix, World world, Player player)	Get the crafted item using the list of ItemStack provided.
BlockData	createBlockData(String data)	Creates a new BlockData instance with material and properties parsed from provided data.
BlockData	createBlockData(Material material)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.
BlockData	createBlockData(Material material, String data)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults, except for those provided in data.
BlockData	createBlockData(Material material, Consumer<? super BlockData> consumer)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.
BossBar	createBossBar(String title, BarColor color, BarStyle style, BarFlag... flags)	Creates a boss bar instance to display to players.
KeyedBossBar	createBossBar(NamespacedKey key, String title, BarColor color, BarStyle style, BarFlag... flags)	Creates a boss bar instance to display to players.
ChunkGenerator.ChunkData	createChunkData(World world)	Create a ChunkData for use in a generator.
ItemStack	createExplorerMap(World world, Location location, StructureType structureType)	Create a new explorer map targeting the closest nearby structure of a given StructureType.
ItemStack	createExplorerMap(World world, Location location, StructureType structureType, int radius, boolean findUnexplored)	Create a new explorer map targeting the closest nearby structure of a given StructureType.
Inventory	createInventory(InventoryHolder owner, int size)	Creates an empty inventory of type InventoryType.CHEST with the specified size.
Inventory	createInventory(InventoryHolder owner, int size, String title)	Creates an empty inventory of type InventoryType.CHEST with the specified size and title.
Inventory	createInventory(InventoryHolder owner, InventoryType type)	Creates an empty inventory with the specified type.
Inventory	createInventory(InventoryHolder owner, InventoryType type, String title)	Creates an empty inventory with the specified type and title.
MapView	createMap(World world)	Create a new map with an automatically assigned ID.
Merchant	createMerchant(String title)	Creates an empty merchant.
PlayerProfile	createPlayerProfile(String name)	Creates a new PlayerProfile.
PlayerProfile	createPlayerProfile(UUID uniqueId)	Creates a new PlayerProfile.
PlayerProfile	createPlayerProfile(UUID uniqueId, String name)	Creates a new PlayerProfile.
World	createWorld(WorldCreator creator)	Creates or loads a world with the given name using the specified options.
WorldBorder	createWorldBorder()	Create a new virtual WorldBorder.
boolean	dispatchCommand(CommandSender sender, String commandLine)	Dispatches a command on this server, and executes it if found.
Advancement	getAdvancement(NamespacedKey key)	Get the advancement specified by this key.
boolean	getAllowEnd()	Gets whether this server allows the End or not.
boolean	getAllowFlight()	Gets whether this server allows flying or not.
boolean	getAllowNether()	Gets whether this server allows the Nether or not.
int	getAmbientSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
int	getAnimalSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
<T extends BanList<?>> T	getBanList(BanList.Type type)	Gets a ban list for the supplied type.
Set<OfflinePlayer>	getBannedPlayers()	Gets a set containing all banned players.
KeyedBossBar	getBossBar(NamespacedKey key)	Gets the KeyedBossBar specified by this key.
Iterator<KeyedBossBar>	getBossBars()	Gets an unmodifiable iterator through all persistent bossbars.
String	getBukkitVersion()	Gets the Bukkit version that this server is running.
Map<String,String[]>	getCommandAliases()	Gets a list of command aliases defined in the server properties.
long	getConnectionThrottle()	Gets the value of the connection throttle setting.
ConsoleCommandSender	getConsoleSender()	Gets a ConsoleCommandSender that may be used as an input source for this server.
Recipe	getCraftingRecipe(ItemStack[] craftingMatrix, World world)	Get the Recipe for the list of ItemStacks provided.
DataPackManager	getDataPackManager()	Get the DataPack Manager.
GameMode	getDefaultGameMode()	Gets the default GameMode for new players.
Entity	getEntity(UUID uuid)	Gets an entity on the server by its UUID
EntityFactory	getEntityFactory()	Gets the instance of the entity factory (for EntitySnapshot).
boolean	getGenerateStructures()	Get generate-structures setting.
HelpMap	getHelpMap()	Gets the HelpMap providing help topics for this server.
boolean	getHideOnlinePlayers()	Gets whether the Server hide online players in server status.
int	getIdleTimeout()	Gets the idle kick timeout.
List<String>	getInitialDisabledPacks()	Gets a list of packs that will not be enabled automatically.
List<String>	getInitialEnabledPacks()	Gets a list of packs to be enabled.
String	getIp()	Get the IP that this server is bound to, or empty string if not specified.
Set<String>	getIPBans()	Gets a set containing all current IPs that are banned.
ItemFactory	getItemFactory()	Gets the instance of the item factory (for ItemMeta).
Logger	getLogger()	Returns the primary logger associated with this server instance.
LootTable	getLootTable(NamespacedKey key)	Gets the specified LootTable.
MapView	getMap(int id)	Deprecated. Magic value
int	getMaxChainedNeighborUpdates()	Gets the amount of consecutive neighbor updates before skipping additional ones.
int	getMaxPlayers()	Get the maximum amount of players which can login to this server.
int	getMaxWorldSize()	Get max world size.
Messenger	getMessenger()	Gets the Messenger responsible for this server.
int	getMonsterSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
String	getMotd()	Gets the message that is displayed on the server list.
String	getName()	Gets the name of this server implementation.
OfflinePlayer	getOfflinePlayer(String name)	Deprecated. Persistent storage of users should be by UUID as names are no longer unique past a single session.
OfflinePlayer	getOfflinePlayer(UUID id)	Gets the player by the given UUID, regardless if they are offline or online.
OfflinePlayer[]	getOfflinePlayers()	Gets every player that has ever played on this server.
boolean	getOnlineMode()	Gets whether the Server is in online mode or not.
Collection<? extends Player>	getOnlinePlayers()	Gets a view of all currently logged in players.
Set<OfflinePlayer>	getOperators()	Gets a set containing all player operators.
Player	getPlayer(String name)	Gets a player object by the given username.
Player	getPlayer(UUID id)	Gets the player with the given UUID.
Player	getPlayerExact(String name)	Gets the player with the exact given name, case insensitive.
PluginCommand	getPluginCommand(String name)	Gets a PluginCommand with the given name or alias.
PluginManager	getPluginManager()	Gets the plugin manager for interfacing with plugins.
int	getPort()	Get the game port that the server runs on.
Recipe	getRecipe(NamespacedKey recipeKey)	Get the Recipe for the given key.
List<Recipe>	getRecipesFor(ItemStack result)	Get a list of all recipes for a given item.
<T extends Keyed> Registry<T>	getRegistry(Class<T> tClass)	Returns the registry for the given class.
String	getResourcePack()	Gets the server resource pack uri, or empty string if not specified.
String	getResourcePackHash()	Gets the SHA-1 digest of the server resource pack, or empty string if not specified.
String	getResourcePackPrompt()	Gets the custom prompt message to be shown when the server resource pack is required, or empty string if not specified.
BukkitScheduler	getScheduler()	Gets the scheduler for managing scheduled events.
Criteria	getScoreboardCriteria(String name)	Get (or create) a new Criteria by its name.
ScoreboardManager	getScoreboardManager()	Gets the instance of the scoreboard manager.
CachedServerIcon	getServerIcon()	Gets an instance of the server's default server-icon.
ResourcePack	getServerResourcePack()	Gets the resource pack configured to be sent to clients by the server.
ServerTickManager	getServerTickManager()	Get the ServerTick Manager.
ServicesManager	getServicesManager()	Gets a services manager.
String	getShutdownMessage()	Gets the default message that is displayed when the server is stopped.
int	getSimulationDistance()	Get the simulation distance from this server.
int	getSpawnLimit(SpawnCategory spawnCategory)	Gets user-specified limit for number of SpawnCategory mobs that can spawn in a chunk.
int	getSpawnRadius()	Gets the radius, in blocks, around each worlds spawn point to protect.
StructureManager	getStructureManager()	Gets the structure manager for loading and saving structures.
<T extends Keyed> Tag<T>	getTag(String registry, NamespacedKey tag, Class<T> clazz)	Gets a tag which has already been defined within the server.
<T extends Keyed> Iterable<Tag<T>>	getTags(String registry, Class<T> clazz)	Gets a all tags which have been defined within the server.
int	getTicksPerAmbientSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
int	getTicksPerAnimalSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
int	getTicksPerMonsterSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
int	getTicksPerSpawns(SpawnCategory spawnCategory)	Gets the default ticks per SpawnCategory spawns value.
int	getTicksPerWaterAmbientSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
int	getTicksPerWaterSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
int	getTicksPerWaterUndergroundCreatureSpawns()	Deprecated. Deprecated in favor of getTicksPerSpawns(SpawnCategory)
UnsafeValues	getUnsafe()	Deprecated.
String	getUpdateFolder()	Gets the name of the update folder.
File	getUpdateFolderFile()	Gets the update folder.
String	getVersion()	Gets the version string of this server implementation.
int	getViewDistance()	Get the view distance from this server.
Warning.WarningState	getWarningState()	Gets the current warning state for the server.
int	getWaterAmbientSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
int	getWaterAnimalSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
int	getWaterUndergroundCreatureSpawnLimit()	Deprecated. Deprecated in favor of getSpawnLimit(SpawnCategory)
Set<OfflinePlayer>	getWhitelistedPlayers()	Gets a list of whitelisted players.
World	getWorld(String name)	Gets the world with the given name.
World	getWorld(UUID uid)	Gets the world from the given Unique ID.
File	getWorldContainer()	Gets the folder that contains all of the various Worlds.
List<World>	getWorlds()	Gets a list of all worlds on this server.
String	getWorldType()	Get world type (level-type setting) for default world.
boolean	hasWhitelist()	Gets whether this server has a whitelist or not.
boolean	isAcceptingTransfers()	Gets whether this server is allowing connections transferred from other servers.
boolean	isEnforcingSecureProfiles()	Gets whether the server only allow players with Mojang-signed public key to join
boolean	isHardcore()	Gets whether the server is in hardcore mode or not.
boolean	isLoggingIPs()	Gets whether the server is logging the IP addresses of players.
boolean	isPrimaryThread()	Checks the current thread against the expected primary thread for the server.
boolean	isResourcePackRequired()	Gets whether the server resource pack is enforced.
boolean	isWhitelistEnforced()	Gets whether the server whitelist is enforced.
CachedServerIcon	loadServerIcon(BufferedImage image)	Creates a cached server-icon for the specific image.
CachedServerIcon	loadServerIcon(File file)	Loads an image from a file, and returns a cached image for the specific server-icon.
List<Player>	matchPlayer(String name)	Attempts to match any players with the given name, and returns a list of all possibly matches.
Iterator<Recipe>	recipeIterator()	Get an iterator through the list of crafting recipes.
void	reload()	Reloads the server, refreshing settings and plugin information.
void	reloadData()	Reload only the Minecraft data for the server.
void	reloadWhitelist()	Reloads the whitelist from disk.
boolean	removeBossBar(NamespacedKey key)	Removes a KeyedBossBar specified by this key.
boolean	removeRecipe(NamespacedKey key)	Remove a recipe from the server.
void	resetRecipes()	Resets the list of crafting recipes to the default.
void	savePlayers()	Writes loaded players to disk.
List<Entity>	selectEntities(CommandSender sender, String selector)	Selects entities using the given Vanilla selector.
void	setDefaultGameMode(GameMode mode)	Sets the default GameMode for new players.
void	setIdleTimeout(int threshold)	Set the idle kick timeout.
void	setMaxPlayers(int maxPlayers)	Set the maximum amount of players allowed to be logged in at once.
void	setMotd(String motd)	Set the message that is displayed on the server list.
void	setSpawnRadius(int value)	Sets the radius, in blocks, around each worlds spawn point to protect.
void	setWhitelist(boolean value)	Sets if the server is whitelisted.
void	setWhitelistEnforced(boolean value)	Sets if the server whitelist is enforced.
boolean	shouldSendChatPreviews()	Deprecated. chat previews have been removed
void	shutdown()	Shutdowns the server, stopping everything.
Server.Spigot	spigot()
void	unbanIP(String address)	Deprecated. see unbanIP(InetAddress)
void	unbanIP(InetAddress address)	Unbans the specified address from the server.
boolean	unloadWorld(String name, boolean save)	Unloads a world with the given name.
boolean	unloadWorld(World world, boolean save)	Unloads the given world.

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageRecipient

getListeningPluginChannels, sendPluginMessage

Field Details

BROADCAST_CHANNEL_ADMINISTRATIVE

static final String BROADCAST_CHANNEL_ADMINISTRATIVE

Used for all administrative messages, such as an operator using a command.

For use in broadcast(java.lang.String, java.lang.String).

See Also:

• Constant Field Values

BROADCAST_CHANNEL_USERS

static final String BROADCAST_CHANNEL_USERS

Used for all announcement messages, such as informing users that a player has joined.

For use in broadcast(java.lang.String, java.lang.String).

See Also:

• Constant Field Values

Method Details

getName

@NotNull
String getName()

Gets the name of this server implementation.

Returns:

name of this server implementation

getVersion

@NotNull
String getVersion()

Gets the version string of this server implementation.

Returns:

version of this server implementation

getBukkitVersion

@NotNull
String getBukkitVersion()

Gets the Bukkit version that this server is running.

Returns:

version of Bukkit

getOnlinePlayers

@NotNull
Collection<? extends Player> getOnlinePlayers()

Gets a view of all currently logged in players. This view is a reused object, making some operations like Collection.size() zero-allocation.

The collection is a view backed by the internal representation, such that, changes to the internal state of the server will be reflected immediately. However, the reuse of the returned collection (identity) is not strictly guaranteed for future or all implementations. Casting the collection, or relying on interface implementations (like Serializable or List), is deprecated.

Iteration behavior is undefined outside of self-contained main-thread uses. Normal and immediate iterator use without consequences that affect the collection are fully supported. The effects following (non-exhaustive) teleportation, death, and kicking are undefined. Any use of this collection from asynchronous threads is unsafe.

For safe consequential iteration or mimicking the old array behavior, using Collection.toArray(Object[]) is recommended. For making snapshots, ImmutableList.copyOf(Collection) is recommended.

Returns:

a view of currently online players.

getMaxPlayers

int getMaxPlayers()

Get the maximum amount of players which can login to this server.

Returns:

the amount of players this server allows

setMaxPlayers

void setMaxPlayers(int maxPlayers)

Set the maximum amount of players allowed to be logged in at once.

Parameters:

maxPlayers - The maximum amount of concurrent players

getPort

int getPort()

Get the game port that the server runs on.

Returns:

the port number of this server

getViewDistance

int getViewDistance()

Get the view distance from this server.

Returns:

the view distance from this server.

getSimulationDistance

int getSimulationDistance()

Get the simulation distance from this server.

Returns:

the simulation distance from this server.

getIp

@NotNull
String getIp()

Get the IP that this server is bound to, or empty string if not specified.

Returns:

the IP string that this server is bound to, otherwise empty string

getWorldType

@NotNull
String getWorldType()

Get world type (level-type setting) for default world.

Returns:

the value of level-type (e.g. DEFAULT, FLAT, DEFAULT_1_1)

getGenerateStructures

boolean getGenerateStructures()

Get generate-structures setting.

Returns:

true if structure generation is enabled, false otherwise

getMaxWorldSize

int getMaxWorldSize()

Get max world size.

Returns:

the maximum world size as specified for the server

getAllowEnd

boolean getAllowEnd()

Gets whether this server allows the End or not.

Returns:

whether this server allows the End or not

getAllowNether

boolean getAllowNether()

Gets whether this server allows the Nether or not.

Returns:

whether this server allows the Nether or not

isLoggingIPs

boolean isLoggingIPs()

Gets whether the server is logging the IP addresses of players.

Returns:

whether the server is logging the IP addresses of players

getInitialEnabledPacks

@NotNull
List<String> getInitialEnabledPacks()

Gets a list of packs to be enabled.

Returns:

a list of packs names

getInitialDisabledPacks

@NotNull
List<String> getInitialDisabledPacks()

Gets a list of packs that will not be enabled automatically.

Returns:

a list of packs names

getDataPackManager

@NotNull
DataPackManager getDataPackManager()

Get the DataPack Manager.

Returns:

the manager

getServerTickManager

@NotNull
ServerTickManager getServerTickManager()

Get the ServerTick Manager.

Returns:

the manager

getServerResourcePack

@Nullable
ResourcePack getServerResourcePack()

Gets the resource pack configured to be sent to clients by the server.

Returns:

the resource pack

getResourcePack

@NotNull
String getResourcePack()

Gets the server resource pack uri, or empty string if not specified.

Returns:

the server resource pack uri, otherwise empty string

getResourcePackHash

@NotNull
String getResourcePackHash()

Gets the SHA-1 digest of the server resource pack, or empty string if not specified.

Returns:

the SHA-1 digest of the server resource pack, otherwise empty string

getResourcePackPrompt

@NotNull
String getResourcePackPrompt()

Gets the custom prompt message to be shown when the server resource pack is required, or empty string if not specified.

Returns:

the custom prompt message to be shown when the server resource, otherwise empty string

isResourcePackRequired

boolean isResourcePackRequired()

Gets whether the server resource pack is enforced.

Returns:

whether the server resource pack is enforced

hasWhitelist

boolean hasWhitelist()

Gets whether this server has a whitelist or not.

Returns:

whether this server has a whitelist or not

setWhitelist

void setWhitelist(boolean value)

Sets if the server is whitelisted.

Parameters:

value - true for whitelist on, false for off

isWhitelistEnforced

boolean isWhitelistEnforced()

Gets whether the server whitelist is enforced. If the whitelist is enforced, non-whitelisted players will be disconnected when the server whitelist is reloaded.

Returns:

whether the server whitelist is enforced

setWhitelistEnforced

void setWhitelistEnforced(boolean value)

Sets if the server whitelist is enforced. If the whitelist is enforced, non-whitelisted players will be disconnected when the server whitelist is reloaded.

Parameters:

value - true for enforced, false for not

getWhitelistedPlayers

@NotNull
Set<OfflinePlayer> getWhitelistedPlayers()

Gets a list of whitelisted players.

Returns:

a set containing all whitelisted players

reloadWhitelist

void reloadWhitelist()

Reloads the whitelist from disk.

broadcastMessage

int broadcastMessage(@NotNull
 String message)

Broadcast a message to all players.

This is the same as calling broadcast(java.lang.String, java.lang.String) to BROADCAST_CHANNEL_USERS

Parameters:

message - the message

Returns:

the number of players

getUpdateFolder

@NotNull
String getUpdateFolder()

Gets the name of the update folder. The update folder is used to safely update plugins at the right moment on a plugin load.

The update folder name is relative to the plugins folder.

Returns:

the name of the update folder

getUpdateFolderFile

@NotNull
File getUpdateFolderFile()

Gets the update folder. The update folder is used to safely update plugins at the right moment on a plugin load.

Returns:

the update folder

getConnectionThrottle

long getConnectionThrottle()

Gets the value of the connection throttle setting.

Returns:

the value of the connection throttle setting

getTicksPerAnimalSpawns

@Deprecated
int getTicksPerAnimalSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets default ticks per animal spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn monsters every tick.
• A value of 400 will mean the server will attempt to spawn monsters every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, animal spawning will be disabled. We recommend using spawn-animals to control this instead.

Minecraft default: 400.

Returns:

the default ticks per animal spawns value

getTicksPerMonsterSpawns

@Deprecated
int getTicksPerMonsterSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets the default ticks per monster spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn monsters every tick.
• A value of 400 will mean the server will attempt to spawn monsters every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, monsters spawning will be disabled. We recommend using spawn-monsters to control this instead.

Minecraft default: 1.

Returns:

the default ticks per monsters spawn value

getTicksPerWaterSpawns

@Deprecated
int getTicksPerWaterSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets the default ticks per water mob spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn water mobs every tick.
• A value of 400 will mean the server will attempt to spawn water mobs every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, water mobs spawning will be disabled.

Minecraft default: 1.

Returns:

the default ticks per water mobs spawn value

getTicksPerWaterAmbientSpawns

@Deprecated
int getTicksPerWaterAmbientSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets the default ticks per water ambient mob spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn water ambient mobs every tick.
• A value of 400 will mean the server will attempt to spawn water ambient mobs every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, ambient mobs spawning will be disabled.

Minecraft default: 1.

Returns:

the default ticks per water ambient mobs spawn value

getTicksPerWaterUndergroundCreatureSpawns

@Deprecated
int getTicksPerWaterUndergroundCreatureSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets the default ticks per water underground creature spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn water underground creature every tick.
• A value of 400 will mean the server will attempt to spawn water underground creature every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, water underground creature spawning will be disabled.

Minecraft default: 1.

Returns:

the default ticks per water underground creature spawn value

getTicksPerAmbientSpawns

@Deprecated
int getTicksPerAmbientSpawns()

Deprecated.

Deprecated in favor of getTicksPerSpawns(SpawnCategory)

Gets the default ticks per ambient mob spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn ambient mobs every tick.
• A value of 400 will mean the server will attempt to spawn ambient mobs every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, ambient mobs spawning will be disabled.

Minecraft default: 1.

Returns:

the default ticks per ambient mobs spawn value

getTicksPerSpawns

int getTicksPerSpawns(@NotNull
 SpawnCategory spawnCategory)

Gets the default ticks per SpawnCategory spawns value.

Example Usage:

• A value of 1 will mean the server will attempt to spawn SpawnCategory mobs every tick.
• A value of 400 will mean the server will attempt to spawn SpawnCategory mobs every 400th tick.
• A value below 0 will be reset back to Minecraft's default.

Note: If set to 0, SpawnCategory mobs spawning will be disabled.

Minecraft default: 1.
Note: the SpawnCategory.MISC are not consider.

Parameters:

spawnCategory - the category of spawn

Returns:

the default ticks per SpawnCategory mobs spawn value

getPlayer

@Nullable
Player getPlayer(@NotNull
 String name)

Gets a player object by the given username.

This method may not return objects for offline players.

Parameters:

name - the name to look up

Returns:

a player if one was found, null otherwise

getPlayerExact

@Nullable
Player getPlayerExact(@NotNull
 String name)

Gets the player with the exact given name, case insensitive.

Parameters:

name - Exact name of the player to retrieve

Returns:

a player object if one was found, null otherwise

matchPlayer

@NotNull
List<Player> matchPlayer(@NotNull
 String name)

Attempts to match any players with the given name, and returns a list of all possibly matches.

This list is not sorted in any particular order. If an exact match is found, the returned list will only contain a single result.

Parameters:

name - the (partial) name to match

Returns:

list of all possible players

getPlayer

@Nullable
Player getPlayer(@NotNull
 UUID id)

Gets the player with the given UUID.

Parameters:

id - UUID of the player to retrieve

Returns:

a player object if one was found, null otherwise

getPluginManager

@NotNull
PluginManager getPluginManager()

Gets the plugin manager for interfacing with plugins.

Returns:

a plugin manager for this Server instance

getScheduler

@NotNull
BukkitScheduler getScheduler()

Gets the scheduler for managing scheduled events.

Returns:

a scheduling service for this server

getServicesManager

@NotNull
ServicesManager getServicesManager()

Gets a services manager.

Returns:

s services manager

getWorlds

@NotNull
List<World> getWorlds()

Gets a list of all worlds on this server.

Returns:

a list of worlds

createWorld

@Nullable
World createWorld(@NotNull
 WorldCreator creator)

Creates or loads a world with the given name using the specified options.

If the world is already loaded, it will just return the equivalent of getWorld(creator.name()).

Parameters:

creator - the options to use when creating the world

Returns:

newly created or loaded world

unloadWorld

boolean unloadWorld(@NotNull
 String name,
 boolean save)

Unloads a world with the given name.

Parameters:

name - Name of the world to unload

save - whether to save the chunks before unloading

Returns:

true if successful, false otherwise

unloadWorld

boolean unloadWorld(@NotNull
 World world,
 boolean save)

Unloads the given world.

Parameters:

world - the world to unload

save - whether to save the chunks before unloading

Returns:

true if successful, false otherwise

getWorld

@Nullable
World getWorld(@NotNull
 String name)

Gets the world with the given name.

Parameters:

name - the name of the world to retrieve

Returns:

a world with the given name, or null if none exists

getWorld

@Nullable
World getWorld(@NotNull
 UUID uid)

Gets the world from the given Unique ID.

Parameters:

uid - a unique-id of the world to retrieve

Returns:

a world with the given Unique ID, or null if none exists

createWorldBorder

@NotNull
WorldBorder createWorldBorder()

Create a new virtual WorldBorder.

Note that world borders created by the server will not respect any world scaling effects (i.e. coordinates are not divided by 8 in the nether).

Returns:

the created world border instance

See Also:

• Player.setWorldBorder(WorldBorder)

getMap

@Deprecated
@Nullable
MapView getMap(int id)

Deprecated.

Magic value

Gets the map from the given item ID.

Parameters:

id - the id of the map to get

Returns:

a map view if it exists, or null otherwise

createMap

@NotNull
MapView createMap(@NotNull
 World world)

Create a new map with an automatically assigned ID.

Parameters:

world - the world the map will belong to

Returns:

a newly created map view

createExplorerMap

@NotNull
ItemStack createExplorerMap(@NotNull
 World world,
 @NotNull
 Location location,
 @NotNull
 StructureType structureType)

Create a new explorer map targeting the closest nearby structure of a given StructureType.
This method uses implementation default values for radius and findUnexplored (usually 100, true).

Parameters:

world - the world the map will belong to

location - the origin location to find the nearest structure

structureType - the type of structure to find

Returns:

a newly created item stack

See Also:

• World.locateNearestStructure(org.bukkit.Location, org.bukkit.StructureType, int, boolean)

createExplorerMap

@NotNull
ItemStack createExplorerMap(@NotNull
 World world,
 @NotNull
 Location location,
 @NotNull
 StructureType structureType,
 int radius,
 boolean findUnexplored)

Create a new explorer map targeting the closest nearby structure of a given StructureType.
This method uses implementation default values for radius and findUnexplored (usually 100, true).

Parameters:

world - the world the map will belong to

location - the origin location to find the nearest structure

structureType - the type of structure to find

radius - radius to search, see World#locateNearestStructure for more information

findUnexplored - whether to find unexplored structures

Returns:

the newly created item stack

See Also:

• World.locateNearestStructure(org.bukkit.Location, org.bukkit.StructureType, int, boolean)

reload

void reload()

Reloads the server, refreshing settings and plugin information.

reloadData

void reloadData()

Reload only the Minecraft data for the server. This includes custom advancements and loot tables.

getLogger

@NotNull
Logger getLogger()

Returns the primary logger associated with this server instance.

Returns:

Logger associated with this server

getPluginCommand

@Nullable
PluginCommand getPluginCommand(@NotNull
 String name)

Gets a PluginCommand with the given name or alias.

Parameters:

name - the name of the command to retrieve

Returns:

a plugin command if found, null otherwise

savePlayers

void savePlayers()

Writes loaded players to disk.

dispatchCommand

boolean dispatchCommand(@NotNull
 CommandSender sender,
 @NotNull
 String commandLine)
                 throws CommandException

Dispatches a command on this server, and executes it if found.

Parameters:

sender - the apparent sender of the command

commandLine - the command + arguments. Example: test abc 123

Returns:

returns false if no target is found

Throws:

CommandException - thrown when the executor for the given command fails with an unhandled exception

addRecipe

@Contract("null -> false")
boolean addRecipe(@Nullable
 Recipe recipe)

Adds a recipe to the crafting manager.

Parameters:

recipe - the recipe to add

Returns:

true if the recipe was added, false if it wasn't for some reason

getRecipesFor

@NotNull
List<Recipe> getRecipesFor(@NotNull
 ItemStack result)

Get a list of all recipes for a given item. The stack size is ignored in comparisons. If the durability is -1, it will match any data value.

Parameters:

result - the item to match against recipe results

Returns:

a list of recipes with the given result

getRecipe

@Nullable
Recipe getRecipe(@NotNull
 NamespacedKey recipeKey)

Get the Recipe for the given key.

Parameters:

recipeKey - the key of the recipe to return

Returns:

the recipe for the given key or null.

getCraftingRecipe

@Nullable
Recipe getCraftingRecipe(@NotNull
 ItemStack[] craftingMatrix,
 @NotNull
 World world)

Get the Recipe for the list of ItemStacks provided.

The list is formatted as a crafting matrix where the index follow the pattern below:

 [ 0 1 2 ]
 [ 3 4 5 ]
 [ 6 7 8 ]
 

NOTE: This method will not modify the provided ItemStack array, for that, use craftItem(ItemStack[], World, Player).

Parameters:

craftingMatrix - list of items to be crafted from. Must not contain more than 9 items.

world - The world the crafting takes place in.

Returns:

the Recipe resulting from the given crafting matrix.

craftItem

@NotNull
ItemStack craftItem(@NotNull
 ItemStack[] craftingMatrix,
 @NotNull
 World world,
 @NotNull
 Player player)

Get the crafted item using the list of ItemStack provided.

The list is formatted as a crafting matrix where the index follow the pattern below:

 [ 0 1 2 ]
 [ 3 4 5 ]
 [ 6 7 8 ]
 

The World and Player arguments are required to fulfill the Bukkit Crafting events.

Calls PrepareItemCraftEvent to imitate the Player initiating the crafting event.

Parameters:

craftingMatrix - list of items to be crafted from. Must not contain more than 9 items.

world - The world the crafting takes place in.

player - The player to imitate the crafting event on.

Returns:

the ItemStack resulting from the given crafting matrix, if no recipe is found an ItemStack of Material.AIR is returned.

craftItem

@NotNull
ItemStack craftItem(@NotNull
 ItemStack[] craftingMatrix,
 @NotNull
 World world)

Get the crafted item using the list of ItemStack provided.

The list is formatted as a crafting matrix where the index follow the pattern below:

 [ 0 1 2 ]
 [ 3 4 5 ]
 [ 6 7 8 ]
 

Parameters:

craftingMatrix - list of items to be crafted from. Must not contain more than 9 items.

world - The world the crafting takes place in.

Returns:

the ItemStack resulting from the given crafting matrix, if no recipe is found an ItemStack of Material.AIR is returned.

craftItemResult

@NotNull
ItemCraftResult craftItemResult(@NotNull
 ItemStack[] craftingMatrix,
 @NotNull
 World world,
 @NotNull
 Player player)

Get the crafted item using the list of ItemStack provided.

The list is formatted as a crafting matrix where the index follow the pattern below:

 [ 0 1 2 ]
 [ 3 4 5 ]
 [ 6 7 8 ]
 

The World and Player arguments are required to fulfill the Bukkit Crafting events.

Calls PrepareItemCraftEvent to imitate the Player initiating the crafting event.

Parameters:

craftingMatrix - list of items to be crafted from. Must not contain more than 9 items.

world - The world the crafting takes place in.

player - The player to imitate the crafting event on.

Returns:

resulting ItemCraftResult containing the resulting item, matrix and any overflow items.

craftItemResult

@NotNull
ItemCraftResult craftItemResult(@NotNull
 ItemStack[] craftingMatrix,
 @NotNull
 World world)

Get the crafted item using the list of ItemStack provided.

The list is formatted as a crafting matrix where the index follow the pattern below:

 [ 0 1 2 ]
 [ 3 4 5 ]
 [ 6 7 8 ]
 

Parameters:

craftingMatrix - list of items to be crafted from. Must not contain more than 9 items.

world - The world the crafting takes place in.

Returns:

resulting ItemCraftResult containing the resulting item, matrix and any overflow items.

recipeIterator

@NotNull
Iterator<Recipe> recipeIterator()

Get an iterator through the list of crafting recipes.

Returns:

an iterator

clearRecipes

void clearRecipes()

Clears the list of crafting recipes.

resetRecipes

void resetRecipes()

Resets the list of crafting recipes to the default.

removeRecipe

boolean removeRecipe(@NotNull
 NamespacedKey key)

Remove a recipe from the server. Note that removing a recipe may cause permanent loss of data associated with that recipe (eg whether it has been discovered by players).

Parameters:

key - NamespacedKey of recipe to remove.

Returns:

True if recipe was removed

getCommandAliases

@NotNull
Map<String,String[]> getCommandAliases()

Gets a list of command aliases defined in the server properties.

Returns:

a map of aliases to command names

getSpawnRadius

int getSpawnRadius()

Gets the radius, in blocks, around each worlds spawn point to protect.

Returns:

spawn radius, or 0 if none

setSpawnRadius

void setSpawnRadius(int value)

Sets the radius, in blocks, around each worlds spawn point to protect.

Parameters:

value - new spawn radius, or 0 if none

shouldSendChatPreviews

@Deprecated
boolean shouldSendChatPreviews()

Deprecated.

chat previews have been removed

Gets whether the server should send a preview of the player's chat message to the client when the player types a message

Returns:

true if the server should send a preview, false otherwise

isEnforcingSecureProfiles

boolean isEnforcingSecureProfiles()

Gets whether the server only allow players with Mojang-signed public key to join

Returns:

true if only Mojang-signed players can join, false otherwise

isAcceptingTransfers

boolean isAcceptingTransfers()

Gets whether this server is allowing connections transferred from other servers.

Returns:

true if the server accepts transfers, false otherwise

getHideOnlinePlayers

boolean getHideOnlinePlayers()

Gets whether the Server hide online players in server status.

Returns:

true if the server hide online players, false otherwise

getOnlineMode

boolean getOnlineMode()

Gets whether the Server is in online mode or not.

Returns:

true if the server authenticates clients, false otherwise

getAllowFlight

boolean getAllowFlight()

Gets whether this server allows flying or not.

Returns:

true if the server allows flight, false otherwise

isHardcore

boolean isHardcore()

Gets whether the server is in hardcore mode or not.

Returns:

true if the server mode is hardcore, false otherwise

shutdown

void shutdown()

Shutdowns the server, stopping everything.

broadcast

int broadcast(@NotNull
 String message,
 @NotNull
 String permission)

Broadcasts the specified message to every user with the given permission name.

Parameters:

message - message to broadcast

permission - the required permission permissibles must have to receive the broadcast

Returns:

number of message recipients

getOfflinePlayer

@Deprecated
@NotNull
OfflinePlayer getOfflinePlayer(@NotNull
 String name)

Deprecated.

Persistent storage of users should be by UUID as names are no longer unique past a single session.

Gets the player by the given name, regardless if they are offline or online.

This method may involve a blocking web request to get the UUID for the given name.

This will return an object even if the player does not exist. To this method, all players will exist.

Parameters:

name - the name the player to retrieve

Returns:

an offline player

See Also:

• getOfflinePlayer(java.util.UUID)

getOfflinePlayer

@NotNull
OfflinePlayer getOfflinePlayer(@NotNull
 UUID id)

Gets the player by the given UUID, regardless if they are offline or online.

This will return an object even if the player does not exist. To this method, all players will exist.

Parameters:

id - the UUID of the player to retrieve

Returns:

an offline player

createPlayerProfile

@NotNull
PlayerProfile createPlayerProfile(@Nullable
 UUID uniqueId,
 @Nullable
 String name)

Creates a new PlayerProfile.

Parameters:

uniqueId - the unique id

name - the name

Returns:

the new PlayerProfile

Throws:

IllegalArgumentException - if both the unique id is null and the name is null or blank

createPlayerProfile

@NotNull
PlayerProfile createPlayerProfile(@NotNull
 UUID uniqueId)

Creates a new PlayerProfile.

Parameters:

uniqueId - the unique id

Returns:

the new PlayerProfile

Throws:

IllegalArgumentException - if the unique id is null

createPlayerProfile

@NotNull
PlayerProfile createPlayerProfile(@NotNull
 String name)

Creates a new PlayerProfile.

Parameters:

name - the name

Returns:

the new PlayerProfile

Throws:

IllegalArgumentException - if the name is null or blank

getIPBans

@NotNull
Set<String> getIPBans()

Gets a set containing all current IPs that are banned.

Returns:

a set containing banned IP addresses

banIP

@Deprecated
void banIP(@NotNull
 String address)

Deprecated.

see banIP(InetAddress)

Bans the specified address from the server.

Parameters:

address - the IP address to ban

unbanIP

@Deprecated
void unbanIP(@NotNull
 String address)

Deprecated.

see unbanIP(InetAddress)

Unbans the specified address from the server.

Parameters:

address - the IP address to unban

banIP

void banIP(@NotNull
 InetAddress address)

Bans the specified address from the server.

Parameters:

address - the IP address to ban

unbanIP

void unbanIP(@NotNull
 InetAddress address)

Unbans the specified address from the server.

Parameters:

address - the IP address to unban

getBannedPlayers

@NotNull
Set<OfflinePlayer> getBannedPlayers()

Gets a set containing all banned players.

Returns:

a set containing banned players

getBanList

@NotNull
<T extends BanList<?>> T getBanList(@NotNull
 BanList.Type type)

Gets a ban list for the supplied type.

Type Parameters:

T - The ban target

Parameters:

type - the type of list to fetch, cannot be null

Returns:

a ban list of the specified type

getOperators

@NotNull
Set<OfflinePlayer> getOperators()

Gets a set containing all player operators.

Returns:

a set containing player operators

getDefaultGameMode

@NotNull
GameMode getDefaultGameMode()

Gets the default GameMode for new players.

Returns:

the default game mode

setDefaultGameMode

void setDefaultGameMode(@NotNull
 GameMode mode)

Sets the default GameMode for new players.

Parameters:

mode - the new game mode

getConsoleSender

@NotNull
ConsoleCommandSender getConsoleSender()

Gets a ConsoleCommandSender that may be used as an input source for this server.

Returns:

a console command sender

getWorldContainer

@NotNull
File getWorldContainer()

Gets the folder that contains all of the various Worlds.

Returns:

folder that contains all worlds

getOfflinePlayers

@NotNull
OfflinePlayer[] getOfflinePlayers()

Gets every player that has ever played on this server.

Returns:

an array containing all previous players

getMessenger

@NotNull
Messenger getMessenger()

Gets the Messenger responsible for this server.

Returns:

messenger responsible for this server

getHelpMap

@NotNull
HelpMap getHelpMap()

Gets the HelpMap providing help topics for this server.

Returns:

a help map for this server

createInventory

@NotNull
Inventory createInventory(@Nullable
 InventoryHolder owner,
 @NotNull
 InventoryType type)

Creates an empty inventory with the specified type. If the type is InventoryType.CHEST, the new inventory has a size of 27; otherwise the new inventory has the normal size for its type.
InventoryType.WORKBENCH will not process crafting recipes if created with this method. Use HumanEntity.openWorkbench(Location, boolean) instead.
InventoryType.ENCHANTING will not process ItemStacks for possible enchanting results. Use HumanEntity.openEnchanting(Location, boolean) instead.

Parameters:

owner - the holder of the inventory, or null to indicate no holder

type - the type of inventory to create

Returns:

a new inventory

Throws:

IllegalArgumentException - if the InventoryType cannot be viewed.

See Also:

• InventoryType.isCreatable()

createInventory

@NotNull
Inventory createInventory(@Nullable
 InventoryHolder owner,
 @NotNull
 InventoryType type,
 @NotNull
 String title)

Creates an empty inventory with the specified type and title. If the type is InventoryType.CHEST, the new inventory has a size of 27; otherwise the new inventory has the normal size for its type.
It should be noted that some inventory types do not support titles and may not render with said titles on the Minecraft client.
InventoryType.WORKBENCH will not process crafting recipes if created with this method. Use HumanEntity.openWorkbench(Location, boolean) instead.
InventoryType.ENCHANTING will not process ItemStacks for possible enchanting results. Use HumanEntity.openEnchanting(Location, boolean) instead.

Parameters:

owner - The holder of the inventory; can be null if there's no holder.

type - The type of inventory to create.

title - The title of the inventory, to be displayed when it is viewed.

Returns:

The new inventory.

Throws:

IllegalArgumentException - if the InventoryType cannot be viewed.

See Also:

• InventoryType.isCreatable()

createInventory

@NotNull
Inventory createInventory(@Nullable
 InventoryHolder owner,
 int size)
                   throws IllegalArgumentException

Creates an empty inventory of type InventoryType.CHEST with the specified size.

Parameters:

owner - the holder of the inventory, or null to indicate no holder

size - a multiple of 9 as the size of inventory to create

Returns:

a new inventory

Throws:

IllegalArgumentException - if the size is not a multiple of 9

createInventory

@NotNull
Inventory createInventory(@Nullable
 InventoryHolder owner,
 int size,
 @NotNull
 String title)
                   throws IllegalArgumentException

Creates an empty inventory of type InventoryType.CHEST with the specified size and title.

Parameters:

owner - the holder of the inventory, or null to indicate no holder

size - a multiple of 9 as the size of inventory to create

title - the title of the inventory, displayed when inventory is viewed

Returns:

a new inventory

Throws:

IllegalArgumentException - if the size is not a multiple of 9

createMerchant

@NotNull
Merchant createMerchant(@Nullable
 String title)

Creates an empty merchant.

Parameters:

title - the title of the corresponding merchant inventory, displayed when the merchant inventory is viewed

Returns:

a new merchant

getMaxChainedNeighborUpdates

int getMaxChainedNeighborUpdates()

Gets the amount of consecutive neighbor updates before skipping additional ones.

Returns:

the amount of consecutive neighbor updates, if the value is negative then the limit it's not used

getMonsterSpawnLimit

@Deprecated
int getMonsterSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Gets user-specified limit for number of monsters that can spawn in a chunk.

Returns:

the monster spawn limit

getAnimalSpawnLimit

@Deprecated
int getAnimalSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Gets user-specified limit for number of animals that can spawn in a chunk.

Returns:

the animal spawn limit

getWaterAnimalSpawnLimit

@Deprecated
int getWaterAnimalSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Gets user-specified limit for number of water animals that can spawn in a chunk.

Returns:

the water animal spawn limit

getWaterAmbientSpawnLimit

@Deprecated
int getWaterAmbientSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Gets user-specified limit for number of water ambient mobs that can spawn in a chunk.

Returns:

the water ambient spawn limit

getWaterUndergroundCreatureSpawnLimit

@Deprecated
int getWaterUndergroundCreatureSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Get user-specified limit for number of water creature underground that can spawn in a chunk.

Returns:

the water underground creature limit

getAmbientSpawnLimit

@Deprecated
int getAmbientSpawnLimit()

Deprecated.

Deprecated in favor of getSpawnLimit(SpawnCategory)

Gets user-specified limit for number of ambient mobs that can spawn in a chunk.

Returns:

the ambient spawn limit

getSpawnLimit

int getSpawnLimit(@NotNull
 SpawnCategory spawnCategory)

Gets user-specified limit for number of SpawnCategory mobs that can spawn in a chunk. Note: the SpawnCategory.MISC are not consider.

Parameters:

spawnCategory - the category spawn

Returns:

the SpawnCategory spawn limit

isPrimaryThread

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

getMotd

@NotNull
String getMotd()

Gets the message that is displayed on the server list.

Returns:

the servers MOTD

setMotd

void setMotd(@NotNull
 String motd)

Set the message that is displayed on the server list.

Parameters:

motd - The message to be displayed

getShutdownMessage

@Nullable
String getShutdownMessage()

Gets the default message that is displayed when the server is stopped.

Returns:

the shutdown message

getWarningState

@NotNull
Warning.WarningState getWarningState()

Gets the current warning state for the server.

Returns:

the configured warning state

getItemFactory

@NotNull
ItemFactory getItemFactory()

Gets the instance of the item factory (for ItemMeta).

Returns:

the item factory

See Also:

• ItemFactory

getEntityFactory

@NotNull
EntityFactory getEntityFactory()

Gets the instance of the entity factory (for EntitySnapshot).

Returns:

the entity factory

See Also:

• EntityFactory

getScoreboardManager

@Nullable
ScoreboardManager getScoreboardManager()

Gets the instance of the scoreboard manager.

This will only exist after the first world has loaded.

Returns:

the scoreboard manager or null if no worlds are loaded.

getScoreboardCriteria

@NotNull
Criteria getScoreboardCriteria(@NotNull
 String name)

Get (or create) a new Criteria by its name.

Parameters:

name - the criteria name

Returns:

the criteria

See Also:

• Criteria for a list of constants

getServerIcon

@Nullable
CachedServerIcon getServerIcon()

Gets an instance of the server's default server-icon.

Returns:

the default server-icon; null values may be used by the implementation to indicate no defined icon, but this behavior is not guaranteed

loadServerIcon

@NotNull
CachedServerIcon loadServerIcon(@NotNull
 File file)
                         throws IllegalArgumentException,
Exception

Loads an image from a file, and returns a cached image for the specific server-icon.

Size and type are implementation defined. An incompatible file is guaranteed to throw an implementation-defined Exception.

Parameters:

file - the file to load the from

Returns:

a cached server-icon that can be used for a ServerListPingEvent.setServerIcon(CachedServerIcon)

Throws:

IllegalArgumentException - if image is null

Exception - if the image does not meet current server server-icon specifications

loadServerIcon

@NotNull
CachedServerIcon loadServerIcon(@NotNull
 BufferedImage image)
                         throws IllegalArgumentException,
Exception

Creates a cached server-icon for the specific image.

Size and type are implementation defined. An incompatible file is guaranteed to throw an implementation-defined Exception.

Parameters:

image - the image to use

Returns:

a cached server-icon that can be used for a ServerListPingEvent.setServerIcon(CachedServerIcon)

Throws:

IllegalArgumentException - if image is null

Exception - if the image does not meet current server server-icon specifications

setIdleTimeout

void setIdleTimeout(int threshold)

Set the idle kick timeout. Any players idle for the specified amount of time will be automatically kicked.

A value of 0 will disable the idle kick timeout.

Parameters:

threshold - the idle timeout in minutes

getIdleTimeout

int getIdleTimeout()

Gets the idle kick timeout.

Returns:

the idle timeout in minutes

createChunkData

@NotNull
ChunkGenerator.ChunkData createChunkData(@NotNull
 World world)

Create a ChunkData for use in a generator. See ChunkGenerator.generateChunkData(org.bukkit.World, java.util.Random, int, int, org.bukkit.generator.ChunkGenerator.BiomeGrid)

Parameters:

world - the world to create the ChunkData for

Returns:

a new ChunkData for the world

createBossBar

@NotNull
BossBar createBossBar(@Nullable
 String title,
 @NotNull
 BarColor color,
 @NotNull
 BarStyle style,
 @NotNull
 BarFlag... flags)

Creates a boss bar instance to display to players. The progress defaults to 1.0

Parameters:

title - the title of the boss bar

color - the color of the boss bar

style - the style of the boss bar

flags - an optional list of flags to set on the boss bar

Returns:

the created boss bar

createBossBar

@NotNull
KeyedBossBar createBossBar(@NotNull
 NamespacedKey key,
 @Nullable
 String title,
 @NotNull
 BarColor color,
 @NotNull
 BarStyle style,
 @NotNull
 BarFlag... flags)

Creates a boss bar instance to display to players. The progress defaults to 1.0.
This instance is added to the persistent storage of the server and will be editable by commands and restored after restart.

Parameters:

key - the key of the boss bar that is used to access the boss bar

title - the title of the boss bar

color - the color of the boss bar

style - the style of the boss bar

flags - an optional list of flags to set on the boss bar

Returns:

the created boss bar

getBossBars

@NotNull
Iterator<KeyedBossBar> getBossBars()

Gets an unmodifiable iterator through all persistent bossbars.

• not bound to a Boss
• not created using createBossBar(String, BarColor, BarStyle, BarFlag...)

e.g. bossbars created using the bossbar command

Returns:

a bossbar iterator

getBossBar

@Nullable
KeyedBossBar getBossBar(@NotNull
 NamespacedKey key)

Gets the KeyedBossBar specified by this key.

• not bound to a Boss
• not created using createBossBar(String, BarColor, BarStyle, BarFlag...)

e.g. bossbars created using the bossbar command

Parameters:

key - unique bossbar key

Returns:

bossbar or null if not exists

removeBossBar

boolean removeBossBar(@NotNull
 NamespacedKey key)

Removes a KeyedBossBar specified by this key.

• not bound to a Boss
• not created using createBossBar(String, BarColor, BarStyle, BarFlag...)

e.g. bossbars created using the bossbar command

Parameters:

key - unique bossbar key

Returns:

true if removal succeeded or false

getEntity

@Nullable
Entity getEntity(@NotNull
 UUID uuid)

Gets an entity on the server by its UUID

Parameters:

uuid - the UUID of the entity

Returns:

the entity with the given UUID, or null if it isn't found

getAdvancement

@Nullable
Advancement getAdvancement(@NotNull
 NamespacedKey key)

Get the advancement specified by this key.

Parameters:

key - unique advancement key

Returns:

advancement or null if not exists

advancementIterator

@NotNull
Iterator<Advancement> advancementIterator()

Get an iterator through all advancements. Advancements cannot be removed from this iterator,

Returns:

an advancement iterator

createBlockData

@NotNull
BlockData createBlockData(@NotNull
 Material material)

Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.

Parameters:

material - the material

Returns:

new data instance

createBlockData

@NotNull
BlockData createBlockData(@NotNull
 Material material,
 @Nullable
 Consumer<? super BlockData> consumer)

Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.

Parameters:

material - the material

consumer - consumer to run on new instance before returning

Returns:

new data instance

createBlockData

@NotNull
BlockData createBlockData(@NotNull
 String data)
                   throws IllegalArgumentException

Creates a new BlockData instance with material and properties parsed from provided data.

Parameters:

data - data string

Returns:

new data instance

Throws:

IllegalArgumentException - if the specified data is not valid

createBlockData

@NotNull
@Contract("null, null -> fail")
BlockData createBlockData(@Nullable
 Material material,
 @Nullable
 String data)
                   throws IllegalArgumentException

Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults, except for those provided in data.
If material is specified, then the data string must not also contain the material.

Parameters:

material - the material

data - data string

Returns:

new data instance

Throws:

IllegalArgumentException - if the specified data is not valid

getTag

@Nullable
<T extends Keyed> Tag<T> getTag(@NotNull
 String registry,
 @NotNull
 NamespacedKey tag,
 @NotNull
 Class<T> clazz)

Gets a tag which has already been defined within the server. Plugins are suggested to use the concrete tags in Tag rather than this method which makes no guarantees about which tags are available, and may also be less performant due to lack of caching.
Tags will be searched for in an implementation specific manner, but a path consisting of namespace/tags/registry/key is expected.
Server implementations are allowed to handle only the registries indicated in Tag.

Type Parameters:

T - type of the tag

Parameters:

registry - the tag registry to look at

tag - the name of the tag

clazz - the class of the tag entries

Returns:

the tag or null

getTags

@NotNull
<T extends Keyed> Iterable<Tag<T>> getTags(@NotNull
 String registry,
 @NotNull
 Class<T> clazz)

Gets a all tags which have been defined within the server.
Server implementations are allowed to handle only the registries indicated in Tag.
No guarantees are made about the mutability of the returned iterator.

Type Parameters:

T - type of the tag

Parameters:

registry - the tag registry to look at

clazz - the class of the tag entries

Returns:

all defined tags

getLootTable

@Nullable
LootTable getLootTable(@NotNull
 NamespacedKey key)

Gets the specified LootTable.

Parameters:

key - the name of the LootTable

Returns:

the LootTable, or null if no LootTable is found with that name

selectEntities

@NotNull
List<Entity> selectEntities(@NotNull
 CommandSender sender,
 @NotNull
 String selector)
                     throws IllegalArgumentException

Selects entities using the given Vanilla selector.
No guarantees are made about the selector format, other than they match the Vanilla format for the active Minecraft version.
Usually a selector will start with '@', unless selecting a Player in which case it may simply be the Player's name or UUID.
Note that in Vanilla, elevated permissions are usually required to use '@' selectors, but this method should not check such permissions from the sender.

Parameters:

sender - the sender to execute as, must be provided

selector - the selection string

Returns:

a list of the selected entities. The list will not be null, but no further guarantees are made.

Throws:

IllegalArgumentException - if the selector is malformed in any way or a parameter is null

getStructureManager

@NotNull
StructureManager getStructureManager()

Gets the structure manager for loading and saving structures.

Returns:

the structure manager

getRegistry

@Nullable
<T extends Keyed> Registry<T> getRegistry(@NotNull
 Class<T> tClass)

Returns the registry for the given class.
If no registry is present for the given class null will be returned.
Depending on the implementation not every registry present in Registry will be returned by this method.

Type Parameters:

T - type of the registry

Parameters:

tClass - of the registry to get

Returns:

the corresponding registry or null if not present

getUnsafe

@Deprecated
@NotNull
UnsafeValues getUnsafe()

Deprecated.

Returns:

the unsafe values instance

See Also:

• UnsafeValues

spigot

@NotNull
Server.Spigot spigot()