Represents a server implementation. More...

Inheritance diagram for org.bukkit.Server:

Collaboration diagram for org.bukkit.Server:

Public Member Functions
String	getName ()
	Gets the name of this server implementation.

String	getVersion ()
	Gets the version string of this server implementation.

String	getBukkitVersion ()
	Gets the Bukkit version that this server is running.

Player[]	getOnlinePlayers ()
	Gets a list of all currently logged in players.

int	getMaxPlayers ()
	Get the maximum amount of players which can login to this server.

int	getPort ()
	Get the game port that the server runs on.

int	getViewDistance ()
	Get the view distance from this server.

String	getIp ()
	Get the IP that this server is bound to or empty string if not specified.

String	getServerName ()
	Get the name of this server.

String	getServerId ()
	Get an ID of this server.

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

boolean	getGenerateStructures ()
	Get generate-structures setting.

boolean	getAllowEnd ()
	Gets whether this server allows the End or not.

boolean	getAllowNether ()
	Gets whether this server allows the Nether or not.

boolean	hasWhitelist ()
	Gets whether this server has a whitelist or not.

void	setWhitelist (boolean value)
	Sets the whitelist on or off.

Set< OfflinePlayer >	getWhitelistedPlayers ()
	Gets a list of whitelisted players.

void	reloadWhitelist ()
	Reloads the whitelist from disk.

int	broadcastMessage (String message)
	Broadcast a message to all players.

String	getUpdateFolder ()
	Gets the name of the update folder.

File	getUpdateFolderFile ()
	Gets the update folder.

long	getConnectionThrottle ()
	Gets the value of the connection throttle setting.

int	getTicksPerAnimalSpawns ()
	Gets default ticks per animal spawns value.

int	getTicksPerMonsterSpawns ()
	Gets the default ticks per monster spawns value.

Player	getPlayer (String name)
	Gets a player object by the given username.

Player	getPlayerExact (String name)
	Gets the player with the exact given name, case insensitive.

List< Player >	matchPlayer (String name)
	Attempts to match any players with the given name, and returns a list of all possibly matches.

PluginManager	getPluginManager ()
	Gets the PluginManager for interfacing with plugins.

BukkitScheduler	getScheduler ()
	Gets the Scheduler for managing scheduled events.

ServicesManager	getServicesManager ()
	Gets a services manager.

List< World >	getWorlds ()
	Gets a list of all worlds on this server.

World	createWorld (WorldCreator creator)
	Creates or loads a world with the given name using the specified options.

boolean	unloadWorld (String name, boolean save)
	Unloads a world with the given name.

boolean	unloadWorld (World world, boolean save)
	Unloads the given world.

World	getWorld (String name)
	Gets the world with the given name.

World	getWorld (UUID uid)
	Gets the world from the given Unique ID.

MapView	getMap (short id)
	Gets the map from the given item ID.

MapView	createMap (World world)
	Create a new map with an automatically assigned ID.

void	reload ()
	Reloads the server, refreshing settings and plugin information.

Logger	getLogger ()
	Returns the primary logger associated with this server instance.

PluginCommand	getPluginCommand (String name)
	Gets a PluginCommand with the given name or alias.

void	savePlayers ()
	Writes loaded players to disk.

boolean	dispatchCommand (CommandSender sender, String commandLine) throws CommandException
	Dispatches a command on the server, and executes it if found.

void	configureDbConfig (ServerConfig config)
	Populates a given ServerConfig with values attributes to this server.

boolean	addRecipe (Recipe recipe)
	Adds a recipe to the crafting manager.

List< Recipe >	getRecipesFor (ItemStack result)
	Get a list of all recipes for a given item.

Iterator< Recipe >	recipeIterator ()
	Get an iterator through the list of crafting recipes.

void	clearRecipes ()
	Clears the list of crafting recipes.

void	resetRecipes ()
	Resets the list of crafting recipes to the default.

Map< String, String[]>	getCommandAliases ()
	Gets a list of command aliases defined in the server properties.

int	getSpawnRadius ()
	Gets the radius, in blocks, around each worlds spawn point to protect.

void	setSpawnRadius (int value)
	Sets the radius, in blocks, around each worlds spawn point to protect.

boolean	getOnlineMode ()
	Gets whether the Server is in online mode or not.

boolean	getAllowFlight ()
	Gets whether this server allows flying or not.

boolean	isHardcore ()
	Gets whether the server is in hardcore mode or not.

boolean	useExactLoginLocation ()
	Gets whether to use vanilla (false) or exact behaviour (true).

void	shutdown ()
	Shutdowns the server, stopping everything.

int	broadcast (String message, String permission)
	Broadcasts the specified message to every user with the given permission.

OfflinePlayer	getOfflinePlayer (String name)
	Gets the player by the given name, regardless if they are offline or online.

Set< String >	getIPBans ()
	Gets a set containing all current IPs that are banned.

void	banIP (String address)
	Bans the specified address from the server.

void	unbanIP (String address)
	Unbans the specified address from the server.

Set< OfflinePlayer >	getBannedPlayers ()
	Gets a set containing all banned players.

Set< OfflinePlayer >	getOperators ()
	Gets a set containing all player operators.

GameMode	getDefaultGameMode ()
	Gets the default GameMode for new players.

void	setDefaultGameMode (GameMode mode)
	Sets the default GameMode for new players.

ConsoleCommandSender	getConsoleSender ()
	Gets the ConsoleCommandSender that may be used as an input source for this server.

File	getWorldContainer ()
	Gets the folder that contains all of the various Worlds.

OfflinePlayer[]	getOfflinePlayers ()
	Gets every player that has ever played on this server.

Messenger	getMessenger ()
	Gets the Messenger responsible for this server.

HelpMap	getHelpMap ()
	Gets the HelpMap providing help topics for this server.

Inventory	createInventory (InventoryHolder owner, InventoryType type)
	Creates an empty inventory of the specified type.

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.

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

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

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

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

boolean	isPrimaryThread ()
	Returns true if the current Thread is the server's primary thread.

String	getMotd ()
	Gets the message that is displayed on the server list.

String	getShutdownMessage ()
	Gets the default message that is displayed when the server is stopped.

WarningState	getWarningState ()
	Gets the current warning state for the server.

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

Public Member Functions inherited from org.bukkit.plugin.messaging.PluginMessageRecipient
void	sendPluginMessage (Plugin source, String channel, byte[] message)
	Sends this recipient a Plugin Message on the specified outgoing channel.

Set< String >	getListeningPluginChannels ()
	Gets a set containing all the Plugin Channels that this client is listening on.

Static Public Attributes
static final String	BROADCAST_CHANNEL_ADMINISTRATIVE = "bukkit.broadcast.admin"
	Used for all administrative messages, such as an operator using a command.

static final String	BROADCAST_CHANNEL_USERS = "bukkit.broadcast.user"
	Used for all announcement messages, such as informing users that a player has joined.

Detailed Description

Represents a server implementation.

Definition at line 37 of file Server.java.

Member Function Documentation

boolean org.bukkit.Server.addRecipe ( 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.

Referenced by org.bukkit.Bukkit.addRecipe().

void org.bukkit.Server.banIP ( String address )

Bans the specified address from the server.

Parameters

address IP address to ban

Referenced by org.bukkit.Bukkit.banIP().

int org.bukkit.Server.broadcast	(	String	message,
		String	permission
	)

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

Parameters

message	Message to broadcast
permission	Permission the users must have to receive the broadcast

Returns: Amount of users who received the message

Referenced by org.bukkit.Bukkit.broadcast().

int org.bukkit.Server.broadcastMessage ( 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

Referenced by org.bukkit.Bukkit.broadcastMessage().

void org.bukkit.Server.clearRecipes ( )

Clears the list of crafting recipes.

Referenced by org.bukkit.Bukkit.clearRecipes().

void org.bukkit.Server.configureDbConfig ( ServerConfig config )

Populates a given ServerConfig with values attributes to this server.

Parameters

config ServerConfig to populate

Referenced by org.bukkit.Bukkit.configureDbConfig(), and org.bukkit.plugin.java.JavaPlugin.initialize().

Inventory org.bukkit.Server.createInventory	(	InventoryHolder	owner,
		InventoryType	type
	)

Creates an empty inventory of 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.

Parameters

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

Returns: The new inventory.

Referenced by org.bukkit.Bukkit.createInventory().

Inventory org.bukkit.Server.createInventory	(	InventoryHolder	owner,
		int	size
	)

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

Parameters

owner	The holder of the inventory; can be null if there's no holder.
size	The size of inventory to create; must be a multiple of 9.

Returns: The new inventory.

Exceptions

IllegalArgumentException If the size is not a multiple of 9.

Inventory org.bukkit.Server.createInventory	(	InventoryHolder	owner,
		int	size,
		String	title
	)

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

Parameters

owner	The holder of the inventory; can be null if there's no holder.
size	The size of inventory to create; must be a multiple of 9.
title	The title of the inventory, to be displayed when it is viewed.

Returns: The new inventory.

Exceptions

IllegalArgumentException If the size is not a multiple of 9.

MapView org.bukkit.Server.createMap ( World world )

Create a new map with an automatically assigned ID.

Parameters

world The world the map will belong to.

Returns: The MapView just created.

Referenced by org.bukkit.Bukkit.createMap().

World org.bukkit.Server.createWorld ( 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

Referenced by org.bukkit.Bukkit.createWorld().

boolean org.bukkit.Server.dispatchCommand	(	CommandSender	sender,
		String	commandLine
	)		throws CommandException

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

Parameters

sender	The apparent sender of the command
commandLine	command + arguments. Example: "test abc 123"

Returns: returns false if no target is found.

Exceptions

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

Referenced by org.bukkit.Bukkit.dispatchCommand().

boolean org.bukkit.Server.getAllowEnd ( )

Gets whether this server allows the End or not.

Returns: Whether this server allows the End or not.

Referenced by org.bukkit.Bukkit.getAllowEnd().

boolean org.bukkit.Server.getAllowFlight ( )

Gets whether this server allows flying or not.

Returns: Whether this server allows flying or not.

Referenced by org.bukkit.Bukkit.getAllowFlight().

boolean org.bukkit.Server.getAllowNether ( )

Gets whether this server allows the Nether or not.

Returns: Whether this server allows the Nether or not.

Referenced by org.bukkit.Bukkit.getAllowNether().

int org.bukkit.Server.getAmbientSpawnLimit ( )

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

Returns: The ambient spawn limit

Referenced by org.bukkit.Bukkit.getAmbientSpawnLimit().

int org.bukkit.Server.getAnimalSpawnLimit ( )

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

Returns: The animal spawn limit

Referenced by org.bukkit.Bukkit.getAnimalSpawnLimit().

Set<OfflinePlayer> org.bukkit.Server.getBannedPlayers ( )

Gets a set containing all banned players.

Returns: Set containing banned players

Referenced by org.bukkit.command.defaults.BanListCommand.execute(), and org.bukkit.Bukkit.getBannedPlayers().

String org.bukkit.Server.getBukkitVersion ( )

Gets the Bukkit version that this server is running.

Returns: Version of Bukkit

Referenced by org.bukkit.Bukkit.getBukkitVersion().

Map<String, String[]> org.bukkit.Server.getCommandAliases ( )

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

Returns: Map of aliases to command names

Referenced by org.bukkit.Bukkit.getCommandAliases(), and org.bukkit.command.SimpleCommandMap.registerServerAliases().

long org.bukkit.Server.getConnectionThrottle ( )

Gets the value of the connection throttle setting.

Returns: the value of the connection throttle setting

Referenced by org.bukkit.Bukkit.getConnectionThrottle().

ConsoleCommandSender org.bukkit.Server.getConsoleSender ( )

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

Returns: The Console CommandSender

Referenced by org.bukkit.Bukkit.getConsoleSender().

GameMode org.bukkit.Server.getDefaultGameMode ( )

Gets the default GameMode for new players.

Returns: Default game mode

Referenced by org.bukkit.Bukkit.getDefaultGameMode().

boolean org.bukkit.Server.getGenerateStructures ( )

Get generate-structures setting.

Returns: true if structure generation is enabled, false if not

Referenced by org.bukkit.Bukkit.getGenerateStructures().

HelpMap org.bukkit.Server.getHelpMap ( )

Gets the HelpMap providing help topics for this server.

Returns: The server's HelpMap.

Referenced by org.bukkit.command.defaults.HelpCommand.execute(), org.bukkit.command.defaults.HelpCommand.findPossibleMatches(), org.bukkit.Bukkit.getHelpMap(), and org.bukkit.command.defaults.HelpCommand.tabComplete().

String org.bukkit.Server.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

Referenced by org.bukkit.Bukkit.getIp().

Set<String> org.bukkit.Server.getIPBans ( )

Gets a set containing all current IPs that are banned.

Returns: Set containing banned IP addresses

Referenced by org.bukkit.Bukkit.getIPBans().

ItemFactory org.bukkit.Server.getItemFactory ( )

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

Returns: the item factory

See Also: ItemFactory

Referenced by org.bukkit.Bukkit.getItemFactory().

Logger org.bukkit.Server.getLogger ( )

Returns the primary logger associated with this server instance.

Returns: Logger associated with this server

MapView org.bukkit.Server.getMap ( short id )

Gets the map from the given item ID.

Parameters

id	ID of the map to get.

Returns: The MapView if it exists, or null otherwise.

Referenced by org.bukkit.Bukkit.getMap().

int org.bukkit.Server.getMaxPlayers ( )

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

Returns: The amount of players this server allows

Referenced by org.bukkit.Bukkit.getMaxPlayers().

Messenger org.bukkit.Server.getMessenger ( )

Gets the Messenger responsible for this server.

Returns: Messenger responsible for this server.

Referenced by org.bukkit.plugin.SimplePluginManager.disablePlugin(), and org.bukkit.Bukkit.getMessenger().

int org.bukkit.Server.getMonsterSpawnLimit ( )

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

Returns: The monster spawn limit

Referenced by org.bukkit.Bukkit.getMonsterSpawnLimit().

String org.bukkit.Server.getMotd ( )

Gets the message that is displayed on the server list.

Returns: the servers MOTD

Referenced by org.bukkit.Bukkit.getMotd().

String org.bukkit.Server.getName ( )

Gets the name of this server implementation.

Returns: name of this server implementation

Referenced by org.bukkit.Bukkit.getName().

OfflinePlayer org.bukkit.Server.getOfflinePlayer ( String name )

Gets the player by the given name, 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

name	Name of the player to retrieve

Returns: OfflinePlayer object

Referenced by org.bukkit.Bukkit.getOfflinePlayer().

OfflinePlayer [] org.bukkit.Server.getOfflinePlayers ( )

Gets every player that has ever played on this server.

Returns: Array containing all players

Referenced by org.bukkit.Bukkit.getOfflinePlayers().

boolean org.bukkit.Server.getOnlineMode ( )

Gets whether the Server is in online mode or not.

Returns: Whether the server is in online mode.

Referenced by org.bukkit.Bukkit.getOnlineMode().

Player [] org.bukkit.Server.getOnlinePlayers ( )

Gets a list of all currently logged in players.

Returns: An array of Players that are currently online

Referenced by org.bukkit.Bukkit.getOnlinePlayers(), org.bukkit.event.player.PlayerChatEvent.PlayerChatEvent(), and org.bukkit.event.player.PlayerCommandPreprocessEvent.PlayerCommandPreprocessEvent().

Set<OfflinePlayer> org.bukkit.Server.getOperators ( )

Gets a set containing all player operators.

Returns: Set containing player operators

Referenced by org.bukkit.Bukkit.getOperators().

Player org.bukkit.Server.getPlayer ( String name )

Gets a player object by the given username.

This method may not return objects for offline players

Parameters

name	Name to look up

Returns: Player if it was found, otherwise null

Referenced by org.bukkit.conversations.PlayerNamePrompt.acceptValidatedInput(), org.bukkit.Bukkit.getPlayer(), and org.bukkit.conversations.PlayerNamePrompt.isInputValid().

Player org.bukkit.Server.getPlayerExact ( String name )

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

Parameters

name	Exact name of the player to retrieve

Returns: Player object or null if not found

Referenced by org.bukkit.Bukkit.getPlayerExact().

PluginCommand org.bukkit.Server.getPluginCommand ( String name )

Gets a PluginCommand with the given name or alias.

Parameters

name	Name of the command to retrieve

Returns: PluginCommand if found, otherwise null

Referenced by org.bukkit.plugin.java.JavaPlugin.getCommand(), and org.bukkit.Bukkit.getPluginCommand().

PluginManager org.bukkit.Server.getPluginManager ( )

Gets the PluginManager for interfacing with plugins.

Returns: PluginManager for this Server instance

Referenced by org.bukkit.permissions.Permission.addParent(), org.bukkit.permissions.PermissibleBase.clearPermissions(), org.bukkit.plugin.java.JavaPluginLoader.createRegisteredListeners(), org.bukkit.plugin.java.JavaPluginLoader.disablePlugin(), org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(), org.bukkit.command.defaults.TimingsCommand.execute(), org.bukkit.permissions.Permission.getPermissibles(), org.bukkit.Bukkit.getPluginManager(), org.bukkit.permissions.PermissibleBase.hasPermission(), org.bukkit.permissions.Permission.recalculatePermissibles(), org.bukkit.permissions.PermissibleBase.recalculatePermissions(), org.bukkit.plugin.SimpleServicesManager.unregister(), and org.bukkit.plugin.SimpleServicesManager.unregisterAll().

int org.bukkit.Server.getPort ( )

Get the game port that the server runs on.

Returns: The port number of this server

Referenced by org.bukkit.Bukkit.getPort().

List<Recipe> org.bukkit.Server.getRecipesFor ( 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 whose recipes you want

Returns: The list of recipes

Referenced by org.bukkit.Bukkit.getRecipesFor().

BukkitScheduler org.bukkit.Server.getScheduler ( )

Gets the Scheduler for managing scheduled events.

Returns: Scheduler for this Server instance

Referenced by org.bukkit.permissions.PermissibleBase.addAttachment(), org.bukkit.plugin.SimplePluginManager.disablePlugin(), and org.bukkit.Bukkit.getScheduler().

String org.bukkit.Server.getServerId ( )

Get an ID of this server.

The ID is a simple generally alphanumeric ID that can be used for uniquely identifying this server.

Returns: The ID of this server

Referenced by org.bukkit.Bukkit.getServerId().

String org.bukkit.Server.getServerName ( )

Get the name of this server.

Returns: The name of this server

Referenced by org.bukkit.Bukkit.getServerName().

ServicesManager org.bukkit.Server.getServicesManager ( )

Gets a services manager.

Returns: Services manager

Referenced by org.bukkit.plugin.SimplePluginManager.disablePlugin(), and org.bukkit.Bukkit.getServicesManager().

String org.bukkit.Server.getShutdownMessage ( )

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

Returns: the shutdown message

Referenced by org.bukkit.Bukkit.getShutdownMessage().

int org.bukkit.Server.getSpawnRadius ( )

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

Returns: Spawn radius, or 0 if none

Referenced by org.bukkit.Bukkit.getSpawnRadius().

int org.bukkit.Server.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

Referenced by org.bukkit.Bukkit.getTicksPerAnimalSpawns().

int org.bukkit.Server.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

Referenced by org.bukkit.Bukkit.getTicksPerMonsterSpawns().

String org.bukkit.Server.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

Referenced by org.bukkit.Bukkit.getUpdateFolder(), and org.bukkit.plugin.SimplePluginManager.loadPlugins().

File org.bukkit.Server.getUpdateFolderFile ( )

Gets the update folder.

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

Returns: The name of the update folder

Referenced by org.bukkit.Bukkit.getUpdateFolderFile().

String org.bukkit.Server.getVersion ( )

Gets the version string of this server implementation.

Returns: version of this server implementation

Referenced by org.bukkit.Bukkit.getVersion().

int org.bukkit.Server.getViewDistance ( )

Get the view distance from this server.

Returns: The view distance from this server.

Referenced by org.bukkit.Bukkit.getViewDistance().

WarningState org.bukkit.Server.getWarningState ( )

Gets the current warning state for the server.

Returns: The configured WarningState

Referenced by org.bukkit.plugin.java.JavaPluginLoader.createRegisteredListeners(), org.bukkit.Bukkit.getWarningState(), and org.bukkit.plugin.java.JavaPluginLoader.JavaPluginLoader().

int org.bukkit.Server.getWaterAnimalSpawnLimit ( )

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

Returns: The water animal spawn limit

Referenced by org.bukkit.Bukkit.getWaterAnimalSpawnLimit().

Set<OfflinePlayer> org.bukkit.Server.getWhitelistedPlayers ( )

Gets a list of whitelisted players.

Returns: Set containing all whitelisted players

Referenced by org.bukkit.Bukkit.getWhitelistedPlayers().

World org.bukkit.Server.getWorld ( String name )

Gets the world with the given name.

Parameters

name	Name of the world to retrieve

Returns: World with the given name, or null if none exists

Referenced by org.bukkit.Bukkit.getWorld().

World org.bukkit.Server.getWorld ( UUID uid )

Gets the world from the given Unique ID.

Parameters

uid	Unique ID of the world to retrieve.

Returns: World with the given Unique ID, or null if none exists.

File org.bukkit.Server.getWorldContainer ( )

Gets the folder that contains all of the various Worlds.

Returns: World container folder

Referenced by org.bukkit.Bukkit.getWorldContainer().

List<World> org.bukkit.Server.getWorlds ( )

Gets a list of all worlds on this server.

Returns: A list of worlds

Referenced by org.bukkit.Bukkit.getWorlds().

String org.bukkit.Server.getWorldType ( )

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

Returns: The value of level-type (e.g. DEFAULT, FLAT, DEFAULT_1_1)

Referenced by org.bukkit.Bukkit.getWorldType().

boolean org.bukkit.Server.hasWhitelist ( )

Gets whether this server has a whitelist or not.

Returns: Whether this server has a whitelist or not.

Referenced by org.bukkit.Bukkit.hasWhitelist().

boolean org.bukkit.Server.isHardcore ( )

Gets whether the server is in hardcore mode or not.

Returns: Whether this server is in hardcore mode or not.

Referenced by org.bukkit.Bukkit.isHardcore().

boolean org.bukkit.Server.isPrimaryThread ( )

Returns true if the current Thread is the server's primary thread.

Referenced by org.bukkit.plugin.SimplePluginManager.callEvent(), and org.bukkit.Bukkit.isPrimaryThread().

List<Player> org.bukkit.Server.matchPlayer ( 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	Name to match

Returns: List of all possible players

Referenced by org.bukkit.Bukkit.matchPlayer().

Iterator<Recipe> org.bukkit.Server.recipeIterator ( )

Get an iterator through the list of crafting recipes.

Returns: The iterator.

Referenced by org.bukkit.Bukkit.recipeIterator().

void org.bukkit.Server.reload ( )

Reloads the server, refreshing settings and plugin information.

Referenced by org.bukkit.Bukkit.reload().

void org.bukkit.Server.reloadWhitelist ( )

Reloads the whitelist from disk.

Referenced by org.bukkit.Bukkit.reloadWhitelist().

void org.bukkit.Server.resetRecipes ( )

Resets the list of crafting recipes to the default.

Referenced by org.bukkit.Bukkit.resetRecipes().

void org.bukkit.Server.savePlayers ( )

Writes loaded players to disk.

Referenced by org.bukkit.Bukkit.savePlayers().

void org.bukkit.Server.setDefaultGameMode ( GameMode mode )

Sets the default GameMode for new players.

Parameters

mode	New game mode

Referenced by org.bukkit.command.defaults.DefaultGameModeCommand.execute(), and org.bukkit.Bukkit.setDefaultGameMode().

void org.bukkit.Server.setSpawnRadius ( int value )

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

Parameters

value New spawn radius, or 0 if none

Referenced by org.bukkit.Bukkit.setSpawnRadius().

void org.bukkit.Server.setWhitelist ( boolean value )

Sets the whitelist on or off.

Parameters

value true if whitelist is on, otherwise false

Referenced by org.bukkit.Bukkit.setWhitelist().

void org.bukkit.Server.shutdown ( )

Shutdowns the server, stopping everything.

Referenced by org.bukkit.Bukkit.shutdown().

void org.bukkit.Server.unbanIP ( String address )

Unbans the specified address from the server.

Parameters

address IP address to unban

Referenced by org.bukkit.Bukkit.unbanIP().

boolean org.bukkit.Server.unloadWorld	(	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: Whether the action was Successful

Referenced by org.bukkit.Bukkit.unloadWorld().

boolean org.bukkit.Server.unloadWorld	(	World	world,
		boolean	save
	)

Unloads the given world.

Parameters

world	The world to unload
save	Whether to save the chunks before unloading.

Returns: Whether the action was Successful

boolean org.bukkit.Server.useExactLoginLocation ( )

Gets whether to use vanilla (false) or exact behaviour (true).

Vanilla behaviour: check for collisions and move the player if needed. Exact behaviour: spawn players exactly where they should be.

Returns: Whether to use vanilla (false) or exact behaviour (true).

Referenced by org.bukkit.Bukkit.useExactLoginLocation().

Member Data Documentation

final String org.bukkit.Server.BROADCAST_CHANNEL_ADMINISTRATIVE = "bukkit.broadcast.admin"

static

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

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

Definition at line 43 of file Server.java.

Referenced by org.bukkit.command.Command.broadcastCommandMessage().

final String org.bukkit.Server.BROADCAST_CHANNEL_USERS = "bukkit.broadcast.user"

static

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

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

Definition at line 50 of file Server.java.

The documentation for this interface was generated from the following file:

org/bukkit/Server.java

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation