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 String	BROADCAST_CHANNEL_ADMINISTRATIVE	Used for all administrative messages, such as an operator using a command.
static 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(@Nullable Recipe recipe)	Adds a recipe to the crafting manager.
@NotNull Iterator<Advancement>	advancementIterator()	Get an iterator through all advancements.
void	banIP(@NotNull String address)	Bans the specified address from the server.
int	broadcast(@NotNull String message, @NotNull String permission)	Broadcasts the specified message to every user with the given permission name.
int	broadcastMessage(@NotNull String message)	Broadcast a message to all players.
void	clearRecipes()	Clears the list of crafting recipes.
@NotNull BlockData	createBlockData(@NotNull String data)	Creates a new BlockData instance with material and properties parsed from provided data.
@NotNull BlockData	createBlockData(@NotNull Material material)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.
@NotNull BlockData	createBlockData(@NotNull Material material, @Nullable Consumer<BlockData> consumer)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults.
@NotNull BlockData	createBlockData(@Nullable Material material, @Nullable String data)	Creates a new BlockData instance for the specified Material, with all properties initialized to unspecified defaults, except for those provided in data.
@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.
@NotNull BossBar	createBossBar(@Nullable String title, @NotNull BarColor color, @NotNull BarStyle style, @NotNull BarFlag... flags)	Creates a boss bar instance to display to players.
ChunkGenerator.ChunkData	createChunkData(@NotNull World world)	Create a ChunkData for use in a generator.
@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.
@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.
@NotNull Inventory	createInventory(@Nullable InventoryHolder owner, int size)	Creates an empty inventory of type InventoryType.CHEST with the specified size.
@NotNull Inventory	createInventory(@Nullable InventoryHolder owner, int size, @NotNull String title)	Creates an empty inventory of type InventoryType.CHEST with the specified size and title.
@NotNull Inventory	createInventory(@Nullable InventoryHolder owner, @NotNull InventoryType type)	Creates an empty inventory with the specified type.
@NotNull Inventory	createInventory(@Nullable InventoryHolder owner, @NotNull InventoryType type, @NotNull String title)	Creates an empty inventory with the specified type and title.
@NotNull MapView	createMap(@NotNull World world)	Create a new map with an automatically assigned ID.
@NotNull Merchant	createMerchant(@Nullable String title)	Creates an empty merchant.
@Nullable World	createWorld(@NotNull WorldCreator creator)	Creates or loads a world with the given name using the specified options.
boolean	dispatchCommand(@NotNull CommandSender sender, @NotNull String commandLine)	Dispatches a command on this server, and executes it if found.
@Nullable Advancement	getAdvancement(@NotNull 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()	Gets user-specified limit for number of ambient mobs that can spawn in a chunk.
int	getAnimalSpawnLimit()	Gets user-specified limit for number of animals that can spawn in a chunk.
@NotNull BanList	getBanList(BanList.Type type)	Gets a ban list for the supplied type.
@NotNull Set<OfflinePlayer>	getBannedPlayers()	Gets a set containing all banned players.
@Nullable KeyedBossBar	getBossBar(@NotNull NamespacedKey key)	Gets the KeyedBossBar specified by this key.
@NotNull Iterator<KeyedBossBar>	getBossBars()	Gets an unmodifiable iterator through all persistent bossbars.
@NotNull String	getBukkitVersion()	Gets the Bukkit version that this server is running.
@NotNull 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.
@NotNull ConsoleCommandSender	getConsoleSender()	Gets a ConsoleCommandSender that may be used as an input source for this server.
@NotNull GameMode	getDefaultGameMode()	Gets the default GameMode for new players.
@Nullable Entity	getEntity(@NotNull UUID uuid)	Gets an entity on the server by its UUID
boolean	getGenerateStructures()	Get generate-structures setting.
@NotNull HelpMap	getHelpMap()	Gets the HelpMap providing help topics for this server.
int	getIdleTimeout()	Gets the idle kick timeout.
@NotNull String	getIp()	Get the IP that this server is bound to, or empty string if not specified.
@NotNull Set<String>	getIPBans()	Gets a set containing all current IPs that are banned.
@NotNull ItemFactory	getItemFactory()	Gets the instance of the item factory (for ItemMeta).
@NotNull Logger	getLogger()	Returns the primary logger associated with this server instance.
@Nullable LootTable	getLootTable(@NotNull NamespacedKey key)	Gets the specified LootTable.
@Nullable MapView	getMap(int id)	Deprecated. Magic value
int	getMaxPlayers()	Get the maximum amount of players which can login to this server.
@NotNull Messenger	getMessenger()	Gets the Messenger responsible for this server.
int	getMonsterSpawnLimit()	Gets user-specified limit for number of monsters that can spawn in a chunk.
@NotNull String	getMotd()	Gets the message that is displayed on the server list.
@NotNull String	getName()	Gets the name of this server implementation.
@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.
@NotNull OfflinePlayer	getOfflinePlayer(@NotNull UUID id)	Gets the player by the given UUID, regardless if they are offline or online.
@NotNull OfflinePlayer[]	getOfflinePlayers()	Gets every player that has ever played on this server.
boolean	getOnlineMode()	Gets whether the Server is in online mode or not.
@NotNull Collection<? extends Player>	getOnlinePlayers()	Gets a view of all currently logged in players.
@NotNull Set<OfflinePlayer>	getOperators()	Gets a set containing all player operators.
@Nullable Player	getPlayer(@NotNull String name)	Gets a player object by the given username.
@Nullable Player	getPlayer(@NotNull UUID id)	Gets the player with the given UUID.
@Nullable Player	getPlayerExact(@NotNull String name)	Gets the player with the exact given name, case insensitive.
@Nullable PluginCommand	getPluginCommand(@NotNull String name)	Gets a PluginCommand with the given name or alias.
@NotNull PluginManager	getPluginManager()	Gets the plugin manager for interfacing with plugins.
int	getPort()	Get the game port that the server runs on.
@NotNull List<Recipe>	getRecipesFor(@NotNull ItemStack result)	Get a list of all recipes for a given item.
@NotNull BukkitScheduler	getScheduler()	Gets the scheduler for managing scheduled events.
@Nullable ScoreboardManager	getScoreboardManager()	Gets the instance of the scoreboard manager.
@Nullable CachedServerIcon	getServerIcon()	Gets an instance of the server's default server-icon.
@NotNull ServicesManager	getServicesManager()	Gets a services manager.
@Nullable String	getShutdownMessage()	Gets the default message that is displayed when the server is stopped.
int	getSpawnRadius()	Gets the radius, in blocks, around each worlds spawn point to protect.
<T extends Keyed> @Nullable Tag<T>	getTag(@NotNull String registry, @NotNull NamespacedKey tag, @NotNull Class<T> clazz)	Gets a tag which has already been defined within the server.
<T extends Keyed> @NotNull Iterable<Tag<T>>	getTags(@NotNull String registry, @NotNull Class<T> clazz)	Gets a all tags which have been defined within the server.
int	getTicksPerAmbientSpawns()	Gets the default ticks per ambient mob spawns value.
int	getTicksPerAnimalSpawns()	Gets default ticks per animal spawns value.
int	getTicksPerMonsterSpawns()	Gets the default ticks per monster spawns value.
int	getTicksPerWaterSpawns()	Gets the default ticks per water mob spawns value.
@NotNull UnsafeValues	getUnsafe()	Deprecated.
@NotNull String	getUpdateFolder()	Gets the name of the update folder.
@NotNull File	getUpdateFolderFile()	Gets the update folder.
@NotNull String	getVersion()	Gets the version string of this server implementation.
int	getViewDistance()	Get the view distance from this server.
@NotNull Warning.WarningState	getWarningState()	Gets the current warning state for the server.
int	getWaterAnimalSpawnLimit()	Gets user-specified limit for number of water animals that can spawn in a chunk.
@NotNull Set<OfflinePlayer>	getWhitelistedPlayers()	Gets a list of whitelisted players.
@Nullable World	getWorld(@NotNull String name)	Gets the world with the given name.
@Nullable World	getWorld(@NotNull UUID uid)	Gets the world from the given Unique ID.
@NotNull File	getWorldContainer()	Gets the folder that contains all of the various Worlds.
@NotNull List<World>	getWorlds()	Gets a list of all worlds on this server.
@NotNull String	getWorldType()	Get world type (level-type setting) for default world.
boolean	hasWhitelist()	Gets whether this server has a whitelist or not.
boolean	isHardcore()	Gets whether the server is in hardcore mode or not.
boolean	isPrimaryThread()	Checks the current thread against the expected primary thread for the server.
@NotNull CachedServerIcon	loadServerIcon(@NotNull BufferedImage image)	Creates a cached server-icon for the specific image.
@NotNull CachedServerIcon	loadServerIcon(@NotNull File file)	Loads an image from a file, and returns a cached image for the specific server-icon.
@NotNull List<Player>	matchPlayer(@NotNull String name)	Attempts to match any players with the given name, and returns a list of all possibly matches.
@NotNull 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(@NotNull NamespacedKey key)	Removes a KeyedBossBar specified by this key.
boolean	removeRecipe(@NotNull 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.
@NotNull List<Entity>	selectEntities(@NotNull CommandSender sender, @NotNull String selector)	Selects entities using the given Vanilla selector.
void	setDefaultGameMode(@NotNull GameMode mode)	Sets the default GameMode for new players.
void	setIdleTimeout(int threshold)	Set the idle kick timeout.
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	shutdown()	Shutdowns the server, stopping everything.
@NotNull Server.Spigot	spigot()
void	unbanIP(@NotNull String address)	Unbans the specified address from the server.
boolean	unloadWorld(@NotNull String name, boolean save)	Unloads a world with the given name.
boolean	unloadWorld(@NotNull World world, boolean save)	Unloads the given world.

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

getListeningPluginChannels, sendPluginMessage

Field Detail

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 Detail

getName

@NotNull
@NotNull String getName()

Gets the name of this server implementation.

Returns:

name of this server implementation

getVersion

@NotNull
@NotNull String getVersion()

Gets the version string of this server implementation.

Returns:

version of this server implementation

getBukkitVersion

@NotNull
@NotNull String getBukkitVersion()

Gets the Bukkit version that this server is running.

Returns:

version of Bukkit

getOnlinePlayers

@NotNull
@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

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.

getIp

@NotNull
@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
@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

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

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

getWhitelistedPlayers

@NotNull
@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
                     @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
@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
@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

int getTicksPerAnimalSpawns()

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

int getTicksPerMonsterSpawns()

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

int getTicksPerWaterSpawns()

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

getTicksPerAmbientSpawns

int getTicksPerAmbientSpawns()

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

getPlayer

@Nullable
@Nullable Player getPlayer(@NotNull
                           @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
@Nullable Player getPlayerExact(@NotNull
                                @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
@NotNull List<Player> matchPlayer(@NotNull
                                  @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
@Nullable Player getPlayer(@NotNull
                           @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
@NotNull PluginManager getPluginManager()

Gets the plugin manager for interfacing with plugins.

Returns:

a plugin manager for this Server instance

getScheduler

@NotNull
@NotNull BukkitScheduler getScheduler()

Gets the scheduler for managing scheduled events.

Returns:

a scheduling service for this server

getServicesManager

@NotNull
@NotNull ServicesManager getServicesManager()

Gets a services manager.

Returns:

s services manager

getWorlds

@NotNull
@NotNull List<World> getWorlds()

Gets a list of all worlds on this server.

Returns:

a list of worlds

createWorld

@Nullable
@Nullable World createWorld(@NotNull
                            @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
                    @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
                    @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
@Nullable World getWorld(@NotNull
                         @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
@Nullable World getWorld(@NotNull
                         @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

getMap

@Deprecated
@Nullable
@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
@NotNull MapView createMap(@NotNull
                           @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
@NotNull ItemStack createExplorerMap(@NotNull
                                     @NotNull World world,
                                     @NotNull
                                     @NotNull Location location,
                                     @NotNull
                                     @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
@NotNull ItemStack createExplorerMap(@NotNull
                                     @NotNull World world,
                                     @NotNull
                                     @NotNull Location location,
                                     @NotNull
                                     @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
@NotNull Logger getLogger()

Returns the primary logger associated with this server instance.

Returns:

Logger associated with this server

getPluginCommand

@Nullable
@Nullable PluginCommand getPluginCommand(@NotNull
                                         @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
                        @NotNull CommandSender sender,
                        @NotNull
                        @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
                  @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
@NotNull List<Recipe> getRecipesFor(@NotNull
                                    @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

recipeIterator

@NotNull
@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
                     @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
@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

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
              @NotNull String message,
              @NotNull
              @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
@NotNull OfflinePlayer getOfflinePlayer(@NotNull
                                        @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
@NotNull OfflinePlayer getOfflinePlayer(@NotNull
                                        @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

getIPBans

@NotNull
@NotNull Set<String> getIPBans()

Gets a set containing all current IPs that are banned.

Returns:

a set containing banned IP addresses

banIP

void banIP(@NotNull
           @NotNull String address)

Bans the specified address from the server.

Parameters:

address - the IP address to ban

unbanIP

void unbanIP(@NotNull
             @NotNull String address)

Unbans the specified address from the server.

Parameters:

address - the IP address to unban

getBannedPlayers

@NotNull
@NotNull Set<OfflinePlayer> getBannedPlayers()

Gets a set containing all banned players.

Returns:

a set containing banned players

getBanList

@NotNull
@NotNull BanList getBanList(@NotNull
                            BanList.Type type)

Gets a ban list for the supplied type.

Bans by name are no longer supported and this method will return null when trying to request them. The replacement is bans by UUID.

Parameters:

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

Returns:

a ban list of the specified type

getOperators

@NotNull
@NotNull Set<OfflinePlayer> getOperators()

Gets a set containing all player operators.

Returns:

a set containing player operators

getDefaultGameMode

@NotNull
@NotNull GameMode getDefaultGameMode()

Gets the default GameMode for new players.

Returns:

the default game mode

setDefaultGameMode

void setDefaultGameMode(@NotNull
                        @NotNull GameMode mode)

Sets the default GameMode for new players.

Parameters:

mode - the new game mode

getConsoleSender

@NotNull
@NotNull ConsoleCommandSender getConsoleSender()

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

Returns:

a console command sender

getWorldContainer

@NotNull
@NotNull File getWorldContainer()

Gets the folder that contains all of the various Worlds.

Returns:

folder that contains all worlds

getOfflinePlayers

@NotNull
@NotNull OfflinePlayer[] getOfflinePlayers()

Gets every player that has ever played on this server.

Returns:

an array containing all previous players

getMessenger

@NotNull
@NotNull Messenger getMessenger()

Gets the Messenger responsible for this server.

Returns:

messenger responsible for this server

getHelpMap

@NotNull
@NotNull HelpMap getHelpMap()

Gets the HelpMap providing help topics for this server.

Returns:

a help map for this server

createInventory

@NotNull
@NotNull Inventory createInventory(@Nullable
                                   @Nullable InventoryHolder owner,
                                   @NotNull
                                   @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
@NotNull Inventory createInventory(@Nullable
                                   @Nullable InventoryHolder owner,
                                   @NotNull
                                   @NotNull InventoryType type,
                                   @NotNull
                                   @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
@NotNull Inventory createInventory(@Nullable
                                   @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
@NotNull Inventory createInventory(@Nullable
                                   @Nullable InventoryHolder owner,
                                   int size,
                                   @NotNull
                                   @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
@NotNull Merchant createMerchant(@Nullable
                                 @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

getMonsterSpawnLimit

int getMonsterSpawnLimit()

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

Returns:

the monster spawn limit

getAnimalSpawnLimit

int getAnimalSpawnLimit()

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

Returns:

the animal spawn limit

getWaterAnimalSpawnLimit

int getWaterAnimalSpawnLimit()

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

Returns:

the water animal spawn limit

getAmbientSpawnLimit

int getAmbientSpawnLimit()

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

Returns:

the ambient 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
@NotNull String getMotd()

Gets the message that is displayed on the server list.

Returns:

the servers MOTD

getShutdownMessage

@Nullable
@Nullable String getShutdownMessage()

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

Returns:

the shutdown message

getWarningState

@NotNull
@NotNull Warning.WarningState getWarningState()

Gets the current warning state for the server.

Returns:

the configured warning state

getItemFactory

@NotNull
@NotNull ItemFactory getItemFactory()

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

Returns:

the item factory

See Also:

ItemFactory

getScoreboardManager

@Nullable
@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.

getServerIcon

@Nullable
@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
@NotNull CachedServerIcon loadServerIcon(@NotNull
                                         @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
@NotNull CachedServerIcon loadServerIcon(@NotNull
                                         @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
                                         @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
@NotNull BossBar createBossBar(@Nullable
                               @Nullable String title,
                               @NotNull
                               @NotNull BarColor color,
                               @NotNull
                               @NotNull BarStyle style,
                               @NotNull
                               @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
@NotNull KeyedBossBar createBossBar(@NotNull
                                    @NotNull NamespacedKey key,
                                    @Nullable
                                    @Nullable String title,
                                    @NotNull
                                    @NotNull BarColor color,
                                    @NotNull
                                    @NotNull BarStyle style,
                                    @NotNull
                                    @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
@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
@Nullable KeyedBossBar getBossBar(@NotNull
                                  @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
                      @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
@Nullable Entity getEntity(@NotNull
                           @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
@Nullable Advancement getAdvancement(@NotNull
                                     @NotNull NamespacedKey key)

Get the advancement specified by this key.

Parameters:

key - unique advancement key

Returns:

advancement or null if not exists

advancementIterator

@NotNull
@NotNull Iterator<Advancement> advancementIterator()

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

Returns:

an advancement iterator

createBlockData

@NotNull
@NotNull BlockData createBlockData(@NotNull
                                   @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
@NotNull BlockData createBlockData(@NotNull
                                   @NotNull Material material,
                                   @Nullable
                                   @Nullable Consumer<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
@NotNull BlockData createBlockData(@NotNull
                                   @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")
@NotNull BlockData createBlockData(@Nullable
                                   @Nullable Material material,
                                   @Nullable
                                   @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> @Nullable Tag<T> getTag(@NotNull
                                          @NotNull String registry,
                                          @NotNull
                                          @NotNull NamespacedKey tag,
                                          @NotNull
                                          @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> @NotNull Iterable<Tag<T>> getTags(@NotNull
                                                    @NotNull String registry,
                                                    @NotNull
                                                    @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
@Nullable LootTable getLootTable(@NotNull
                                 @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
@NotNull List<Entity> selectEntities(@NotNull
                                     @NotNull CommandSender sender,
                                     @NotNull
                                     @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

getUnsafe

@Deprecated
@NotNull
@NotNull UnsafeValues getUnsafe()

Deprecated.

Returns:

the unsafe values instance

See Also:

UnsafeValues

spigot

@NotNull
@NotNull Server.Spigot spigot()