Package be.seeseemelk.mockbukkit

Class ServerMock

java.lang.Object

org.bukkit.Server.Spigot

be.seeseemelk.mockbukkit.ServerMock

All Implemented Interfaces:

net.kyori.adventure.audience.Audience, net.kyori.adventure.audience.ForwardingAudience, net.kyori.adventure.pointer.Pointered, PluginMessageRecipient, Server

public class ServerMock
extends Server.Spigot
implements Server

Mock implementation of a Server and Server.Spigot.

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

net.kyori.adventure.audience.ForwardingAudience.Single

Nested classes/interfaces inherited from interface org.bukkit.Server

Server.Spigot

Field Summary

Fields inherited from interface org.bukkit.Server

BROADCAST_CHANNEL_ADMINISTRATIVE, BROADCAST_CHANNEL_USERS

Constructor Summary

Constructors

Constructor	Description
ServerMock()	Constructs a new ServerMock and sets it up.

Method Summary

Modifier and Type	Method	Description
@NotNull PlayerMock	addPlayer()	Creates a random player and adds it.
void	addPlayer(@NotNull PlayerMock player)	Add a specific player to the set.
@NotNull PlayerMock	addPlayer(@NotNull String name)	Creates a player with a given name and adds it.
boolean	addRecipe(@Nullable Recipe recipe, boolean resendRecipes)
boolean	addRecipe(Recipe recipe)
@NotNull WorldMock	addSimpleWorld(String name)	Adds a very simple super flat world with a given name.
void	addTagRegistry(@NotNull TagRegistry registry)	Adds a tag registry.
void	addWorld(WorldMock world)	Adds the given mocked world to this server.
@NotNull Iterator<Advancement>	advancementIterator()
@NotNull Iterable<? extends net.kyori.adventure.audience.Audience>	audiences()
void	banIP(@NotNull String address)
void	banIP(@NotNull InetAddress address)
int	broadcast(@NotNull String message, @NotNull String permission)	Deprecated.
int	broadcast(@NotNull net.kyori.adventure.text.Component message)
int	broadcast(@NotNull net.kyori.adventure.text.Component message, @NotNull String permission)
void	broadcast(@NotNull net.md_5.bungee.api.chat.BaseComponent component)	Deprecated.
void	broadcast(@NotNull net.md_5.bungee.api.chat.BaseComponent... components)	Deprecated.
int	broadcastMessage(@NotNull String message)	Deprecated.
void	clearRecipes()
@NotNull ItemStack	craftItem(@NotNull ItemStack[] craftingMatrix, @NotNull World world)
@NotNull ItemStack	craftItem(@NotNull ItemStack[] craftingMatrix, @NotNull World world, @NotNull Player player)
@NotNull ItemCraftResult	craftItemResult(@NotNull ItemStack[] craftingMatrix, @NotNull World world)
@NotNull ItemCraftResult	craftItemResult(@NotNull ItemStack[] craftingMatrix, @NotNull World world, @NotNull Player player)
@NotNull BlockData	createBlockData(String data)
@NotNull BlockData	createBlockData(@NotNull Material material)
@NotNull BlockData	createBlockData(@NotNull Material material, @Nullable Consumer<? super BlockData> consumer)
@NotNull BlockData	createBlockData(Material material, String data)
@NotNull BossBar	createBossBar(@NotNull String title, @NotNull BarColor color, @NotNull BarStyle style, BarFlag... flags)
@NotNull KeyedBossBar	createBossBar(@NotNull NamespacedKey key, @NotNull String title, @NotNull BarColor color, @NotNull BarStyle style, BarFlag... flags)
@NotNull ChunkGenerator.ChunkData	createChunkData(@NotNull World world)
@NotNull CommandSender	createCommandSender(@NotNull Consumer<? super net.kyori.adventure.text.Component> feedback)
@Nullable ItemStack	createExplorerMap(@NotNull World world, @NotNull Location location, StructureType structureType, MapCursor.Type mapIcon, int radius, boolean findUnexplored)
@NotNull ItemStack	createExplorerMap(World world, Location location, StructureType structureType)
@NotNull ItemStack	createExplorerMap(World world, Location location, StructureType structureType, int radius, boolean findUnexplored)
@NotNull InventoryMock	createInventory(@Nullable InventoryHolder owner, int size, @NotNull net.kyori.adventure.text.Component title)
@NotNull InventoryMock	createInventory(@Nullable InventoryHolder owner, @NotNull InventoryType type, @NotNull net.kyori.adventure.text.Component title)
@NotNull InventoryMock	createInventory(InventoryHolder owner, int size)
@NotNull InventoryMock	createInventory(InventoryHolder owner, int size, String title)	Deprecated.
@NotNull InventoryMock	createInventory(InventoryHolder owner, @NotNull InventoryType type)
@NotNull InventoryMock	createInventory(InventoryHolder owner, @NotNull InventoryType type, String title)	Deprecated.
@NotNull InventoryMock	createInventory(InventoryHolder owner, @NotNull InventoryType type, String title, int size)	Deprecated.
@NotNull MapViewMock	createMap(@NotNull World world)
@NotNull Tag<Material>	createMaterialTag(@NotNull NamespacedKey key, @NotNull String registryKey, @NotNull Material... materials)	This creates a new Mock Tag for the Material class. Call this in advance before you are gonna access getTag(String, NamespacedKey, Class) or any of the constants defined in Tag.
@NotNull Merchant	createMerchant(String title)	Deprecated.
@NotNull Merchant	createMerchant(@Nullable net.kyori.adventure.text.Component title)
@NotNull PlayerProfileMock	createPlayerProfile(@NotNull String name)	Deprecated.
@NotNull PlayerProfileMock	createPlayerProfile(@NotNull UUID uniqueId)	Deprecated.
@NotNull PlayerProfileMock	createPlayerProfile(@Nullable UUID uniqueId, @Nullable String name)	Deprecated.
@NotNull PlayerProfileMock	createProfile(@NotNull String name)
@NotNull PlayerProfileMock	createProfile(@NotNull UUID uuid)
@NotNull PlayerProfileMock	createProfile(@Nullable UUID uuid, @Nullable String name)
@NotNull PlayerProfileMock	createProfileExact(@Nullable UUID uuid, @Nullable String name)
World	createWorld(@NotNull WorldCreator creator)
@NotNull WorldBorder	createWorldBorder()
boolean	dispatchCommand(@NotNull CommandSender sender, @NotNull String commandLine)
@NotNull CommandResult	execute(@NotNull String command, CommandSender sender, String... args)	Executes a command.
@NotNull CommandResult	execute(@NotNull Command command, CommandSender sender, String... args)	Executes a command.
@NotNull CommandResult	executeConsole(@NotNull String command, String... args)	Executes a command as the console.
@NotNull CommandResult	executeConsole(@NotNull Command command, String... args)	Executes a command as the console.
@NotNull CommandResult	executePlayer(@NotNull String command, String... args)	Executes a command as a player.
@NotNull CommandResult	executePlayer(@NotNull Command command, String... args)	Executes a command as a player.
Advancement	getAdvancement(NamespacedKey key)
boolean	getAllowEnd()
boolean	getAllowFlight()
boolean	getAllowNether()
int	getAmbientSpawnLimit()	Deprecated.
int	getAnimalSpawnLimit()	Deprecated.
@NotNull AsyncScheduler	getAsyncScheduler()
double	getAverageTickTime()
<B extends BanList<E>, E> B	getBanList(@NotNull BanListType<B> type)
@NotNull BanList	getBanList(@NotNull BanList.Type type)
@NotNull Set<OfflinePlayer>	getBannedPlayers()
KeyedBossBar	getBossBar(NamespacedKey key)
@NotNull Iterator<KeyedBossBar>	getBossBars()
@NotNull String	getBukkitVersion()
@NotNull Map<String,String[]>	getCommandAliases()
@NotNull MockCommandMap	getCommandMap()
@NotNull List<String>	getCommandTabComplete(@NotNull CommandSender sender, @NotNull String commandLine)	Gets the tab completion result for a command.
@NotNull YamlConfiguration	getConfig()
long	getConnectionThrottle()
@NotNull ConsoleCommandSenderMock	getConsoleSender()
@Nullable Recipe	getCraftingRecipe(@NotNull ItemStack[] craftingMatrix, @NotNull World world)
protected long	getCurrentServerTime()	This returns the current time of the Server in milliseconds
int	getCurrentTick()
@NotNull DatapackManager	getDatapackManager()
@NotNull DataPackManager	getDataPackManager()	Deprecated.
@NotNull GameMode	getDefaultGameMode()
@NotNull Set<EntityMock>	getEntities()	Returns a set of entities that exist on the server instance.
@Nullable Entity	getEntity(@NotNull UUID uuid)
@NotNull EntityFactory	getEntityFactory()
boolean	getGenerateStructures()
@NotNull GlobalRegionScheduler	getGlobalRegionScheduler()
@NotNull HelpMapMock	getHelpMap()
boolean	getHideOnlinePlayers()
int	getIdleTimeout()
@NotNull List<String>	getInitialDisabledPacks()
@NotNull List<String>	getInitialEnabledPacks()
@NotNull String	getIp()
@NotNull Set<String>	getIPBans()
@NotNull ItemFactory	getItemFactory()
@NotNull Set<String>	getListeningPluginChannels()
@NotNull Logger	getLogger()
LootTable	getLootTable(NamespacedKey key)
MapViewMock	getMap(int id)	Deprecated.
int	getMaxChainedNeighborUpdates()
int	getMaxPlayers()
int	getMaxWorldSize()
@NotNull Messenger	getMessenger()
@NotNull String	getMinecraftVersion()
@NotNull MobGoals	getMobGoals()
int	getMonsterSpawnLimit()	Deprecated.
@NotNull String	getMotd()	Deprecated.
@NotNull String	getName()
@NotNull OfflinePlayer	getOfflinePlayer(@NotNull String name)	Deprecated.
@NotNull OfflinePlayer	getOfflinePlayer(@NotNull UUID id)
@Nullable OfflinePlayer	getOfflinePlayerIfCached(@NotNull String name)
OfflinePlayer @NotNull []	getOfflinePlayers()
boolean	getOnlineMode()
@NotNull Collection<? extends PlayerMock>	getOnlinePlayers()
@NotNull Set<OfflinePlayer>	getOperators()
@NotNull String	getPermissionMessage()
@NotNull PlayerMock	getPlayer(int num)	Get a specific mock player.
Player	getPlayer(@NotNull String name)
Player	getPlayer(@NotNull UUID id)
Player	getPlayerExact(@NotNull String name)
@NotNull MockPlayerList	getPlayerList()	Returns the MockPlayerList instance that is used by this server.
@Nullable UUID	getPlayerUniqueId(@NotNull String playerName)
PluginCommand	getPluginCommand(@NotNull String name)
@NotNull PluginManagerMock	getPluginManager()
@NotNull File	getPluginsFolder()
int	getPort()
@NotNull PotionBrewer	getPotionBrewer()
@Nullable Recipe	getRecipe(@NotNull NamespacedKey key)
@NotNull List<Recipe>	getRecipesFor(@NotNull ItemStack item)
@NotNull RegionScheduler	getRegionScheduler()
<T extends Keyed> @Nullable Registry<T>	getRegistry(@NotNull Class<T> tClass)
@NotNull String	getResourcePack()
@NotNull String	getResourcePackHash()
@NotNull String	getResourcePackPrompt()
@NotNull BukkitSchedulerMock	getScheduler()
@NotNull Criteria	getScoreboardCriteria(@NotNull String name)
@NotNull ScoreboardManagerMock	getScoreboardManager()
@NotNull ServerConfiguration	getServerConfiguration()	Exposes the ServerConfiguration of this ServerMock.
CachedServerIconMock	getServerIcon()
@NotNull ServerLinks	getServerLinks()
@Nullable ResourcePack	getServerResourcePack()
@NotNull ServerTickManager	getServerTickManager()
@NotNull ServicesManagerMock	getServicesManager()
String	getShutdownMessage()	Deprecated.
int	getSimulationDistance()
int	getSpawnLimit(@NotNull SpawnCategory spawnCategory)
int	getSpawnRadius()
@NotNull StructureManager	getStructureManager()
<T extends Keyed> Tag<T>	getTag(@NotNull String registryKey, @NotNull NamespacedKey key, @NotNull Class<T> clazz)
<T extends Keyed> @NotNull Iterable<Tag<T>>	getTags(@NotNull String registry, @NotNull Class<T> clazz)
int	getTicksPerAmbientSpawns()	Deprecated.
int	getTicksPerAnimalSpawns()	Deprecated.
int	getTicksPerMonsterSpawns()	Deprecated.
int	getTicksPerSpawns(@NotNull SpawnCategory spawnCategory)
int	getTicksPerWaterAmbientSpawns()
int	getTicksPerWaterSpawns()	Deprecated.
int	getTicksPerWaterUndergroundCreatureSpawns()	Deprecated.
@org.jetbrains.annotations.NotNull long[]	getTickTimes()
@org.jetbrains.annotations.NotNull double[]	getTPS()
@NotNull MockUnsafeValues	getUnsafe()	Deprecated.
@NotNull String	getUpdateFolder()
@NotNull File	getUpdateFolderFile()
@NotNull String	getVersion()
int	getViewDistance()
@NotNull Warning.WarningState	getWarningState()
int	getWaterAmbientSpawnLimit()	Deprecated.
int	getWaterAnimalSpawnLimit()	Deprecated.
int	getWaterUndergroundCreatureSpawnLimit()	Deprecated.
@NotNull Set<OfflinePlayer>	getWhitelistedPlayers()
World	getWorld(String name)
World	getWorld(UUID uid)
@Nullable World	getWorld(@NotNull net.kyori.adventure.key.Key key)
@Nullable World	getWorld(@NotNull NamespacedKey worldKey)
@NotNull File	getWorldContainer()
@NotNull List<World>	getWorlds()
@NotNull String	getWorldType()
boolean	hasWhitelist()
boolean	isAcceptingTransfers()
boolean	isEnforcingSecureProfiles()
boolean	isHardcore()
boolean	isLoggingIPs()
boolean	isOnMainThread()	Checks if we are on the main thread.
boolean	isOwnedByCurrentRegion(@NotNull Location location)
boolean	isOwnedByCurrentRegion(@NotNull Location location, int squareRadiusChunks)
boolean	isOwnedByCurrentRegion(@NotNull World world, int chunkX, int chunkZ)
boolean	isOwnedByCurrentRegion(@NotNull World world, int chunkX, int chunkZ, int squareRadiusChunks)
boolean	isOwnedByCurrentRegion(@NotNull World world, @NotNull Position position)
boolean	isOwnedByCurrentRegion(@NotNull World world, @NotNull Position position, int squareRadiusChunks)
boolean	isOwnedByCurrentRegion(@NotNull Entity entity)
boolean	isPrimaryThread()
boolean	isResourcePackRequired()
boolean	isStopping()
boolean	isTickingWorlds()
boolean	isWhitelistEnforced()
@NotNull CachedServerIconMock	loadServerIcon(@NotNull BufferedImage image)
@NotNull CachedServerIconMock	loadServerIcon(@NotNull File file)
@NotNull List<Player>	matchPlayer(@NotNull String name)
@NotNull net.kyori.adventure.text.Component	motd()
void	motd(@NotNull net.kyori.adventure.text.Component motd)
@NotNull net.kyori.adventure.text.Component	permissionMessage()
@NotNull Iterator<Recipe>	recipeIterator()
void	registerEntity(@NotNull EntityMock entity)	Registers an entity so that the server can track it more easily.
static void	registerSerializables()	Registers any classes that are serializable with the ConfigurationSerializable system of Bukkit.
void	reload()
boolean	reloadCommandAliases()
void	reloadData()
void	reloadPermissions()
void	reloadWhitelist()
boolean	removeBossBar(NamespacedKey key)
boolean	removeRecipe(@NotNull NamespacedKey key)
boolean	removeRecipe(@NotNull NamespacedKey key, boolean resendRecipes)
boolean	removeWorld(WorldMock world)	Removes a mocked world from this server.
void	resetRecipes()
void	restart()
void	savePlayers()
@NotNull List<Entity>	selectEntities(CommandSender sender, String selector)
void	sendPluginMessage(@NotNull Plugin source, @NotNull String channel, byte[] message)
void	setAllowEnd(boolean allowEnd)	Sets whether the End should be allowed.
void	setAllowFlight(boolean allowFlight)	Sets whether the server should allow flight.
void	setAllowNether(boolean allowNether)	Sets whether the Nether should be allowed.
void	setDefaultGameMode(GameMode mode)
void	setEnforcingSecureProfiles(boolean enforcingSecureProfiles)	Sets whether the server should enforce secure profiles.
void	setGenerateStructures(boolean generateStructures)	Sets whether structures should be generated.
void	setHardcore(boolean hardcore)	Sets whether the server should be in hardcore mode.
void	setHideOnlinePlayers(boolean hideOnlinePlayers)	Set whether to hide online players
void	setIdleTimeout(int threshold)
void	setIp(@NotNull String serverIp)	Sets the server listen IP.
void	setMaxChainedNeighborUpdates(int maxChainedNeighborUpdates)	Sets the maximum number of chained neighbour updates before skipping additional ones.
void	setMaxPlayers(int maxPlayers)
void	setMaxWorldSize(int maxWorldSize)	Set the maximum world size
void	setMotd(@NotNull String motd)
void	setOfflinePlayers(int num)	Set the numbers of mock offline players that are on this server.
void	setOnlineMode(boolean onlineMode)	Sets whether the server should be in online mode.
void	setPlayers(int num)	Set the numbers of mock players that are on this server.
void	setPort(int port)	Sets the server listen port.
void	setServerIcon(CachedServerIconMock serverIcon)	Sets the return value of getServerIcon().
void	setShouldSendChatPreviews(boolean shouldSendChatPreviews)	Deprecated, for removal: This API element is subject to removal in a future version. Chat previews were removed in 1.19.3.
void	setShutdownMessage(@NotNull net.kyori.adventure.text.Component shutdownMessage)	Sets the shutdown message.
void	setSimulationDistance(int simulationDistance)	Set the simulation distance
void	setSpawnRadius(int spawnRadius)
void	setUpdateFolder(@NotNull String updateFolder)	Sets the global update folder.
void	setViewDistance(int viewDistance)	Sets the global view distance for all players.
void	setWarningState(@NotNull Warning.WarningState warningState)	Sets the return value of getWarningState().
void	setWhitelist(boolean value)
void	setWhitelistEnforced(boolean value)
void	setWorldType(ServerConfiguration.LevelType worldType)	Sets the global default World Type
boolean	shouldSendChatPreviews()	Deprecated, for removal: This API element is subject to removal in a future version. Chat previews were removed in 1.19.3.
void	shutdown()
@Nullable net.kyori.adventure.text.Component	shutdownMessage()
@NotNull Server.Spigot	spigot()
boolean	suggestPlayerNamesWhenNullTabCompletions()
void	unbanIP(@NotNull String address)
void	unbanIP(@NotNull InetAddress address)
boolean	unloadWorld(String name, boolean save)
boolean	unloadWorld(World world, boolean save)
void	unregisterEntity(@NotNull EntityMock entity)	Unregisters an entity from the server.
void	updateRecipes()
void	updateResources()

Methods inherited from class org.bukkit.Server.Spigot

getBukkitConfig, getPaperConfig, getSpigotConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kyori.adventure.audience.Audience

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience

clearResourcePacks, clearTitle, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, playSound, playSound, playSound, pointers, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendTitlePart, showBossBar, stopSound

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom

Methods inherited from interface org.bukkit.Server

createExplorerMap, isOwnedByCurrentRegion

Constructor Details

ServerMock

public ServerMock()

Constructs a new ServerMock and sets it up. Does NOT set the server returned from Bukkit.getServer().

Method Details

isOnMainThread

public boolean isOnMainThread()

Checks if we are on the main thread. The main thread is the thread used to create this instance of the mock server.

Returns:

true if we are on the main thread, false if we are running on a different thread.

registerEntity

public void registerEntity(@NotNull
 @NotNull EntityMock entity)

Registers an entity so that the server can track it more easily. Should only be used internally.

Parameters:

entity - The entity to register

unregisterEntity

public void unregisterEntity(@NotNull
 @NotNull EntityMock entity)

Unregisters an entity from the server. Should only be used internally.

Parameters:

entity - The entity to unregister

getEntities

@NotNull
public @NotNull Set<EntityMock> getEntities()

Returns a set of entities that exist on the server instance.

Returns:

A set of entities that exist on this server instance.

addPlayer

public void addPlayer(@NotNull
 @NotNull PlayerMock player)

Add a specific player to the set.

Parameters:

player - The player to add.

addPlayer

@NotNull
public @NotNull PlayerMock addPlayer()

Creates a random player and adds it.

Returns:

The player that was added.

addPlayer

@NotNull
public @NotNull PlayerMock addPlayer(@NotNull
 @NotNull String name)

Creates a player with a given name and adds it.

Parameters:

name - The name to give to the player.

Returns:

The added player.

setPlayers

public void setPlayers(int num)

Set the numbers of mock players that are on this server. Note that it will remove all players that are already on this server.

Parameters:

num - The number of players that are on this server.

setOfflinePlayers

public void setOfflinePlayers(int num)

Set the numbers of mock offline players that are on this server. Note that even players that are online are also considered offline player because an OfflinePlayer really just refers to anyone that has at some point in time played on the server.

Parameters:

num - The number of players that are on this server.

getPlayer

@NotNull
public @NotNull PlayerMock getPlayer(int num)

Get a specific mock player. A player's number will never change between invocations of setPlayers(int).

Parameters:

num - The number of the player to retrieve.

Returns:

The chosen player.

getPlayerList

@NotNull
public @NotNull MockPlayerList getPlayerList()

Returns the MockPlayerList instance that is used by this server.

Returns:

The MockPlayerList instance.

getPlayerUniqueId

@Nullable
public @Nullable UUID getPlayerUniqueId(@NotNull
 @NotNull String playerName)

Specified by:

getPlayerUniqueId in interface Server

addSimpleWorld

@NotNull
public @NotNull WorldMock addSimpleWorld(String name)

Adds a very simple super flat world with a given name.

Parameters:

name - The name to give to the world.

Returns:

The WorldMock that has been created.

addWorld

public void addWorld(WorldMock world)

Adds the given mocked world to this server.

Parameters:

world - The world to add.

removeWorld

public boolean removeWorld(WorldMock world)

Removes a mocked world from this server.

Parameters:

world - The world to remove.

Returns:

true if the world was removed, otherwise false.

executeConsole

@NotNull
public @NotNull CommandResult executeConsole(@NotNull
 @NotNull Command command,
 String... args)

Executes a command as the console.

Parameters:

command - The command to execute.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

executeConsole

@NotNull
public @NotNull CommandResult executeConsole(@NotNull
 @NotNull String command,
 String... args)

Executes a command as the console.

Parameters:

command - The command to execute.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

executePlayer

@NotNull
public @NotNull CommandResult executePlayer(@NotNull
 @NotNull Command command,
 String... args)

Executes a command as a player.

Parameters:

command - The command to execute.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

executePlayer

@NotNull
public @NotNull CommandResult executePlayer(@NotNull
 @NotNull String command,
 String... args)

Executes a command as a player.

Parameters:

command - The command to execute.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

execute

@NotNull
public @NotNull CommandResult execute(@NotNull
 @NotNull Command command,
 CommandSender sender,
 String... args)

Executes a command.

Parameters:

command - The command to execute.

sender - The person that executed the command.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

execute

@NotNull
public @NotNull CommandResult execute(@NotNull
 @NotNull String command,
 CommandSender sender,
 String... args)

Executes a command.

Parameters:

command - The command to execute.

sender - The person that executed the command.

args - The arguments to pass to the commands.

Returns:

The value returned by Command.execute(org.bukkit.command.CommandSender, java.lang.String, java.lang.String[]).

getName

@NotNull
public @NotNull String getName()

Specified by:

getName in interface Server

getVersion

@NotNull
public @NotNull String getVersion()

Specified by:

getVersion in interface Server

getBukkitVersion

@NotNull
public @NotNull String getBukkitVersion()

Specified by:

getBukkitVersion in interface Server

getMinecraftVersion

@NotNull
public @NotNull String getMinecraftVersion()

Specified by:

getMinecraftVersion in interface Server

getOnlinePlayers

@NotNull
public @NotNull Collection<? extends PlayerMock> getOnlinePlayers()

Specified by:

getOnlinePlayers in interface Server

getOfflinePlayers

public OfflinePlayer @NotNull [] getOfflinePlayers()

Specified by:

getOfflinePlayers in interface Server

getOfflinePlayerIfCached

@Nullable
public @Nullable OfflinePlayer getOfflinePlayerIfCached(@NotNull
 @NotNull String name)

Specified by:

getOfflinePlayerIfCached in interface Server

getPlayer

public Player getPlayer(@NotNull
 @NotNull String name)

Specified by:

getPlayer in interface Server

getPlayerExact

public Player getPlayerExact(@NotNull
 @NotNull String name)

Specified by:

getPlayerExact in interface Server

matchPlayer

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

Specified by:

matchPlayer in interface Server

getPlayer

public Player getPlayer(@NotNull
 @NotNull UUID id)

Specified by:

getPlayer in interface Server

getPluginManager

@NotNull
public @NotNull PluginManagerMock getPluginManager()

Specified by:

getPluginManager in interface Server

getCommandMap

@NotNull
public @NotNull MockCommandMap getCommandMap()

Specified by:

getCommandMap in interface Server

getPluginCommand

public PluginCommand getPluginCommand(@NotNull
 @NotNull String name)

Specified by:

getPluginCommand in interface Server

getLogger

@NotNull
public @NotNull Logger getLogger()

Specified by:

getLogger in interface Server

getConsoleSender

@NotNull
public @NotNull ConsoleCommandSenderMock getConsoleSender()

Specified by:

getConsoleSender in interface Server

createCommandSender

@NotNull
public @NotNull CommandSender createCommandSender(@NotNull
 @NotNull Consumer<? super net.kyori.adventure.text.Component> feedback)

Specified by:

createCommandSender in interface Server

createInventory

@NotNull
@Deprecated
public @NotNull InventoryMock createInventory(InventoryHolder owner,
 @NotNull
 @NotNull InventoryType type,
 String title,
 int size)

Deprecated.

Creates an inventory with the provided parameters.

Parameters:

owner - The holder of the inventory.

type - The type of the inventory.

title - The title of the inventory view.

size - The size of the inventory.

Returns:

The created inventory.

Throws:

IllegalArgumentException - If the InventoryType is not creatable.

See Also:

• InventoryType.isCreatable()

createInventory

@NotNull
public @NotNull InventoryMock createInventory(InventoryHolder owner,
 @NotNull
 @NotNull InventoryType type)

Specified by:

createInventory in interface Server

createInventory

@NotNull
public @NotNull InventoryMock createInventory(@Nullable
 @Nullable InventoryHolder owner,
 @NotNull
 @NotNull InventoryType type,
 @NotNull
 @NotNull net.kyori.adventure.text.Component title)

Specified by:

createInventory in interface Server

createInventory

@Deprecated
@NotNull
public @NotNull InventoryMock createInventory(InventoryHolder owner,
 @NotNull
 @NotNull InventoryType type,
 String title)

Deprecated.

Specified by:

createInventory in interface Server

createInventory

@NotNull
public @NotNull InventoryMock createInventory(InventoryHolder owner,
 int size)

Specified by:

createInventory in interface Server

createInventory

@NotNull
public @NotNull InventoryMock createInventory(@Nullable
 @Nullable InventoryHolder owner,
 int size,
 @NotNull
 @NotNull net.kyori.adventure.text.Component title)
                                       throws IllegalArgumentException

Specified by:

createInventory in interface Server

Throws:

IllegalArgumentException

createInventory

@Deprecated
@NotNull
public @NotNull InventoryMock createInventory(InventoryHolder owner,
 int size,
 String title)

Deprecated.

Specified by:

createInventory in interface Server

createMerchant

@NotNull
public @NotNull Merchant createMerchant(@Nullable
 @Nullable net.kyori.adventure.text.Component title)

Specified by:

createMerchant in interface Server

getItemFactory

@NotNull
public @NotNull ItemFactory getItemFactory()

Specified by:

getItemFactory in interface Server

getWorlds

@NotNull
public @NotNull List<World> getWorlds()

Specified by:

getWorlds in interface Server

isTickingWorlds

public boolean isTickingWorlds()

Specified by:

isTickingWorlds in interface Server

getWorld

public World getWorld(String name)

Specified by:

getWorld in interface Server

getWorld

public World getWorld(UUID uid)

Specified by:

getWorld in interface Server

getWorld

@Nullable
public @Nullable World getWorld(@NotNull
 @NotNull NamespacedKey worldKey)

Specified by:

getWorld in interface Server

getWorld

@Nullable
public @Nullable World getWorld(@NotNull
 @NotNull net.kyori.adventure.key.Key key)

Specified by:

getWorld in interface Server

createWorldBorder

@NotNull
public @NotNull WorldBorder createWorldBorder()

Specified by:

createWorldBorder in interface Server

getScheduler

@NotNull
public @NotNull BukkitSchedulerMock getScheduler()

Specified by:

getScheduler in interface Server

getMaxPlayers

public int getMaxPlayers()

Specified by:

getMaxPlayers in interface Server

setMaxPlayers

public void setMaxPlayers(int maxPlayers)

Specified by:

setMaxPlayers in interface Server

getIPBans

@NotNull
public @NotNull Set<String> getIPBans()

Specified by:

getIPBans in interface Server

banIP

public void banIP(@NotNull
 @NotNull String address)

Specified by:

banIP in interface Server

unbanIP

public void unbanIP(@NotNull
 @NotNull String address)

Specified by:

unbanIP in interface Server

banIP

public void banIP(@NotNull
 @NotNull InetAddress address)

Specified by:

banIP in interface Server

unbanIP

public void unbanIP(@NotNull
 @NotNull InetAddress address)

Specified by:

unbanIP in interface Server

getBanList

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

Specified by:

getBanList in interface Server

getOperators

@NotNull
public @NotNull Set<OfflinePlayer> getOperators()

Specified by:

getOperators in interface Server

getDefaultGameMode

@NotNull
public @NotNull GameMode getDefaultGameMode()

Specified by:

getDefaultGameMode in interface Server

setDefaultGameMode

public void setDefaultGameMode(GameMode mode)

Specified by:

setDefaultGameMode in interface Server

broadcastMessage

@Deprecated
public int broadcastMessage(@NotNull
 @NotNull String message)

Deprecated.

Specified by:

broadcastMessage in interface Server

broadcast

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

Deprecated.

Specified by:

broadcast in interface Server

broadcast

public int broadcast(@NotNull
 @NotNull net.kyori.adventure.text.Component message)

Specified by:

broadcast in interface Server

broadcast

public int broadcast(@NotNull
 @NotNull net.kyori.adventure.text.Component message,
 @NotNull
 @NotNull String permission)

Specified by:

broadcast in interface Server

registerSerializables

public static void registerSerializables()

Registers any classes that are serializable with the ConfigurationSerializable system of Bukkit.

addRecipe

public boolean addRecipe(Recipe recipe)

Specified by:

addRecipe in interface Server

addRecipe

public boolean addRecipe(@Nullable
 @Nullable Recipe recipe,
 boolean resendRecipes)

Specified by:

addRecipe in interface Server

getRecipesFor

@NotNull
public @NotNull List<Recipe> getRecipesFor(@NotNull
 @NotNull ItemStack item)

Specified by:

getRecipesFor in interface Server

getRecipe

@Nullable
public @Nullable Recipe getRecipe(@NotNull
 @NotNull NamespacedKey key)

Specified by:

getRecipe in interface Server

getCraftingRecipe

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

Specified by:

getCraftingRecipe in interface Server

craftItem

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

Specified by:

craftItem in interface Server

craftItemResult

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

Specified by:

craftItemResult in interface Server

craftItemResult

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

Specified by:

craftItemResult in interface Server

craftItem

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

Specified by:

craftItem in interface Server

removeRecipe

public boolean removeRecipe(@NotNull
 @NotNull NamespacedKey key)

Specified by:

removeRecipe in interface Server

removeRecipe

public boolean removeRecipe(@NotNull
 @NotNull NamespacedKey key,
 boolean resendRecipes)

Specified by:

removeRecipe in interface Server

recipeIterator

@NotNull
public @NotNull Iterator<Recipe> recipeIterator()

Specified by:

recipeIterator in interface Server

clearRecipes

public void clearRecipes()

Specified by:

clearRecipes in interface Server

dispatchCommand

public boolean dispatchCommand(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String commandLine)

Specified by:

dispatchCommand in interface Server

getCommandTabComplete

@NotNull
public @NotNull List<String> getCommandTabComplete(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String commandLine)

Gets the tab completion result for a command.

Parameters:

sender - The command sender.

commandLine - The command string, without a leading slash.

Returns:

The tab completion result, or an empty list.

getHelpMap

@NotNull
public @NotNull HelpMapMock getHelpMap()

Specified by:

getHelpMap in interface Server

sendPluginMessage

public void sendPluginMessage(@NotNull
 @NotNull Plugin source,
 @NotNull
 @NotNull String channel,
 byte[] message)

Specified by:

sendPluginMessage in interface PluginMessageRecipient

getListeningPluginChannels

@NotNull
public @NotNull Set<String> getListeningPluginChannels()

Specified by:

getListeningPluginChannels in interface PluginMessageRecipient

getPort

public int getPort()

Specified by:

getPort in interface Server

setPort

public void setPort(int port)

Sets the server listen port.

Parameters:

port - The server listen port.

See Also:

• getPort()

getViewDistance

public int getViewDistance()

Specified by:

getViewDistance in interface Server

setViewDistance

public void setViewDistance(int viewDistance)

Sets the global view distance for all players.

Parameters:

viewDistance - The new view distance.

See Also:

• getViewDistance()

getIp

@NotNull
public @NotNull String getIp()

Specified by:

getIp in interface Server

setIp

public void setIp(@NotNull
 @NotNull String serverIp)

Sets the server listen IP.

Parameters:

serverIp - The server listen IP.

See Also:

• getIp()

getWorldType

@NotNull
public @NotNull String getWorldType()

Specified by:

getWorldType in interface Server

setWorldType

public void setWorldType(@NotNull
 ServerConfiguration.LevelType worldType)

Sets the global default World Type

Parameters:

worldType - The new ServerConfiguration.LevelType

See Also:

• getWorldType()

getGenerateStructures

public boolean getGenerateStructures()

Specified by:

getGenerateStructures in interface Server

setGenerateStructures

public void setGenerateStructures(boolean generateStructures)

Sets whether structures should be generated.

Parameters:

generateStructures - Whether structures should be generated.

See Also:

• getGenerateStructures()

getAllowEnd

public boolean getAllowEnd()

Specified by:

getAllowEnd in interface Server

setAllowEnd

public void setAllowEnd(boolean allowEnd)

Sets whether the End should be allowed.

Parameters:

allowEnd - Whether the End should be allowed.

See Also:

• getAllowEnd()

getAllowNether

public boolean getAllowNether()

Specified by:

getAllowNether in interface Server

isLoggingIPs

public boolean isLoggingIPs()

Specified by:

isLoggingIPs in interface Server

getInitialEnabledPacks

@NotNull
public @NotNull List<String> getInitialEnabledPacks()

Specified by:

getInitialEnabledPacks in interface Server

getInitialDisabledPacks

@NotNull
public @NotNull List<String> getInitialDisabledPacks()

Specified by:

getInitialDisabledPacks in interface Server

getDataPackManager

@Deprecated(since="1.19")
@NotNull
public @NotNull DataPackManager getDataPackManager()

Deprecated.

Specified by:

getDataPackManager in interface Server

getServerTickManager

@NotNull
public @NotNull ServerTickManager getServerTickManager()

Specified by:

getServerTickManager in interface Server

getServerResourcePack

@Nullable
public @Nullable ResourcePack getServerResourcePack()

Specified by:

getServerResourcePack in interface Server

setAllowNether

public void setAllowNether(boolean allowNether)

Sets whether the Nether should be allowed.

Parameters:

allowNether - Whether the Nether should be allowed.

See Also:

• getAllowNether()

getResourcePack

@NotNull
public @NotNull String getResourcePack()

Specified by:

getResourcePack in interface Server

getResourcePackHash

@NotNull
public @NotNull String getResourcePackHash()

Specified by:

getResourcePackHash in interface Server

getResourcePackPrompt

@NotNull
public @NotNull String getResourcePackPrompt()

Specified by:

getResourcePackPrompt in interface Server

isResourcePackRequired

public boolean isResourcePackRequired()

Specified by:

isResourcePackRequired in interface Server

hasWhitelist

public boolean hasWhitelist()

Specified by:

hasWhitelist in interface Server

setWhitelist

public void setWhitelist(boolean value)

Specified by:

setWhitelist in interface Server

isWhitelistEnforced

public boolean isWhitelistEnforced()

Specified by:

isWhitelistEnforced in interface Server

setWhitelistEnforced

public void setWhitelistEnforced(boolean value)

Specified by:

setWhitelistEnforced in interface Server

getWhitelistedPlayers

@NotNull
public @NotNull Set<OfflinePlayer> getWhitelistedPlayers()

Specified by:

getWhitelistedPlayers in interface Server

reloadWhitelist

public void reloadWhitelist()

Specified by:

reloadWhitelist in interface Server

getUpdateFolder

@NotNull
public @NotNull String getUpdateFolder()

Specified by:

getUpdateFolder in interface Server

setUpdateFolder

public void setUpdateFolder(@NotNull
 @NotNull String updateFolder)

Sets the global update folder.

Parameters:

updateFolder - The new update folder.

See Also:

• ServerConfiguration.setUpdateFolder(String)

getUpdateFolderFile

@NotNull
public @NotNull File getUpdateFolderFile()

Specified by:

getUpdateFolderFile in interface Server

getConnectionThrottle

public long getConnectionThrottle()

Specified by:

getConnectionThrottle in interface Server

getTicksPerAnimalSpawns

@Deprecated
public int getTicksPerAnimalSpawns()

Deprecated.

Specified by:

getTicksPerAnimalSpawns in interface Server

getTicksPerMonsterSpawns

@Deprecated
public int getTicksPerMonsterSpawns()

Deprecated.

Specified by:

getTicksPerMonsterSpawns in interface Server

getServicesManager

@NotNull
public @NotNull ServicesManagerMock getServicesManager()

Specified by:

getServicesManager in interface Server

createWorld

public World createWorld(@NotNull
 @NotNull WorldCreator creator)

Specified by:

createWorld in interface Server

unloadWorld

public boolean unloadWorld(String name,
 boolean save)

Specified by:

unloadWorld in interface Server

unloadWorld

public boolean unloadWorld(World world,
 boolean save)

Specified by:

unloadWorld in interface Server

createMap

@NotNull
public @NotNull MapViewMock createMap(@NotNull
 @NotNull World world)

Specified by:

createMap in interface Server

reload

public void reload()

Specified by:

reload in interface Server

reloadData

public void reloadData()

Specified by:

reloadData in interface Server

updateResources

public void updateResources()

Specified by:

updateResources in interface Server

updateRecipes

public void updateRecipes()

Specified by:

updateRecipes in interface Server

savePlayers

public void savePlayers()

Specified by:

savePlayers in interface Server

resetRecipes

public void resetRecipes()

Specified by:

resetRecipes in interface Server

getCommandAliases

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

Specified by:

getCommandAliases in interface Server

getSpawnRadius

public int getSpawnRadius()

Specified by:

getSpawnRadius in interface Server

setSpawnRadius

public void setSpawnRadius(int spawnRadius)

Specified by:

setSpawnRadius in interface Server

shouldSendChatPreviews

@Deprecated(forRemoval=true)
public boolean shouldSendChatPreviews()

Deprecated, for removal: This API element is subject to removal in a future version.

Chat previews were removed in 1.19.3.

Specified by:

shouldSendChatPreviews in interface Server

Returns:

true if the server should send a preview, false otherwise

setShouldSendChatPreviews

@Deprecated(forRemoval=true)
public void setShouldSendChatPreviews(boolean shouldSendChatPreviews)

Deprecated, for removal: This API element is subject to removal in a future version.

Chat previews were removed in 1.19.3.

Sets whether the server should send chat previews.

Parameters:

shouldSendChatPreviews - Whether the server should send chat previews.

See Also:

• shouldSendChatPreviews()

isEnforcingSecureProfiles

public boolean isEnforcingSecureProfiles()

Specified by:

isEnforcingSecureProfiles in interface Server

setEnforcingSecureProfiles

public void setEnforcingSecureProfiles(boolean enforcingSecureProfiles)

Sets whether the server should enforce secure profiles.

Parameters:

enforcingSecureProfiles - Whether the server should enforce secure profiles.

See Also:

• isEnforcingSecureProfiles()

getOnlineMode

public boolean getOnlineMode()

Specified by:

getOnlineMode in interface Server

setOnlineMode

public void setOnlineMode(boolean onlineMode)

Sets whether the server should be in online mode.

Parameters:

onlineMode - Whether the server should be in online mode.

See Also:

• getOnlineMode()

getAllowFlight

public boolean getAllowFlight()

Specified by:

getAllowFlight in interface Server

setAllowFlight

public void setAllowFlight(boolean allowFlight)

Sets whether the server should allow flight.

Parameters:

allowFlight - Whether the server should allow flight.

See Also:

• getAllowFlight()

isHardcore

public boolean isHardcore()

Specified by:

isHardcore in interface Server

setHardcore

public void setHardcore(boolean hardcore)

Sets whether the server should be in hardcore mode.

Parameters:

hardcore - Whether the server should be in hardcore mode.

See Also:

• isHardcore()

shutdown

public void shutdown()

Specified by:

shutdown in interface Server

getOfflinePlayer

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

Deprecated.

Specified by:

getOfflinePlayer in interface Server

getOfflinePlayer

@NotNull
public @NotNull OfflinePlayer getOfflinePlayer(@NotNull
 @NotNull UUID id)

Specified by:

getOfflinePlayer in interface Server

getBannedPlayers

@NotNull
public @NotNull Set<OfflinePlayer> getBannedPlayers()

Specified by:

getBannedPlayers in interface Server

getBanList

@NotNull
public <B extends BanList<E>,
E> B getBanList(@NotNull
 @NotNull BanListType<B> type)

Specified by:

getBanList in interface Server

getWorldContainer

@NotNull
public @NotNull File getWorldContainer()

Specified by:

getWorldContainer in interface Server

getMessenger

@NotNull
public @NotNull Messenger getMessenger()

Specified by:

getMessenger in interface Server

createMerchant

@Deprecated
@NotNull
public @NotNull Merchant createMerchant(String title)

Deprecated.

Specified by:

createMerchant in interface Server

getMaxChainedNeighborUpdates

public int getMaxChainedNeighborUpdates()

Specified by:

getMaxChainedNeighborUpdates in interface Server

setMaxChainedNeighborUpdates

public void setMaxChainedNeighborUpdates(int maxChainedNeighborUpdates)

Sets the maximum number of chained neighbour updates before skipping additional ones. Negative values remove the limit.

Parameters:

maxChainedNeighborUpdates - The maximum number of chained neighbour updates.

See Also:

• getMaxChainedNeighborUpdates()

getMonsterSpawnLimit

@Deprecated
public int getMonsterSpawnLimit()

Deprecated.

Specified by:

getMonsterSpawnLimit in interface Server

getAnimalSpawnLimit

@Deprecated
public int getAnimalSpawnLimit()

Deprecated.

Specified by:

getAnimalSpawnLimit in interface Server

getWaterAnimalSpawnLimit

@Deprecated
public int getWaterAnimalSpawnLimit()

Deprecated.

Specified by:

getWaterAnimalSpawnLimit in interface Server

getAmbientSpawnLimit

@Deprecated
public int getAmbientSpawnLimit()

Deprecated.

Specified by:

getAmbientSpawnLimit in interface Server

isPrimaryThread

public boolean isPrimaryThread()

Specified by:

isPrimaryThread in interface Server

motd

@NotNull
public @NotNull net.kyori.adventure.text.Component motd()

Specified by:

motd in interface Server

motd

public void motd(@NotNull
 @NotNull net.kyori.adventure.text.Component motd)

Specified by:

motd in interface Server

getMotd

@Deprecated
@NotNull
public @NotNull String getMotd()

Deprecated.

Specified by:

getMotd in interface Server

setMotd

public void setMotd(@NotNull
 @NotNull String motd)

Specified by:

setMotd in interface Server

getServerLinks

@NotNull
public @NotNull ServerLinks getServerLinks()

Specified by:

getServerLinks in interface Server

shutdownMessage

@Nullable
public @Nullable net.kyori.adventure.text.Component shutdownMessage()

Specified by:

shutdownMessage in interface Server

setShutdownMessage

public void setShutdownMessage(@NotNull
 @NotNull net.kyori.adventure.text.Component shutdownMessage)

Sets the shutdown message.

Parameters:

shutdownMessage - The shutdown message.

See Also:

• shutdownMessage()

getShutdownMessage

@Deprecated
public String getShutdownMessage()

Deprecated.

Specified by:

getShutdownMessage in interface Server

setWarningState

public void setWarningState(@NotNull
 @NotNull Warning.WarningState warningState)

Sets the return value of getWarningState().

Parameters:

warningState - The Warning.WarningState to set.

getWarningState

@NotNull
public @NotNull Warning.WarningState getWarningState()

Specified by:

getWarningState in interface Server

getScoreboardManager

@NotNull
public @NotNull ScoreboardManagerMock getScoreboardManager()

Specified by:

getScoreboardManager in interface Server

getScoreboardCriteria

@NotNull
public @NotNull Criteria getScoreboardCriteria(@NotNull
 @NotNull String name)

Specified by:

getScoreboardCriteria in interface Server

setServerIcon

public void setServerIcon(CachedServerIconMock serverIcon)

Sets the return value of getServerIcon().

Parameters:

serverIcon - The icon to set.

getServerIcon

public CachedServerIconMock getServerIcon()

Specified by:

getServerIcon in interface Server

loadServerIcon

@NotNull
public @NotNull CachedServerIconMock loadServerIcon(@NotNull
 @NotNull File file)
                                             throws IOException

Specified by:

loadServerIcon in interface Server

Throws:

IOException

loadServerIcon

@NotNull
public @NotNull CachedServerIconMock loadServerIcon(@NotNull
 @NotNull BufferedImage image)
                                             throws IOException

Specified by:

loadServerIcon in interface Server

Throws:

IOException

setIdleTimeout

public void setIdleTimeout(int threshold)

Specified by:

setIdleTimeout in interface Server

getIdleTimeout

public int getIdleTimeout()

Specified by:

getIdleTimeout in interface Server

createChunkData

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

Specified by:

createChunkData in interface Server

createBossBar

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

Specified by:

createBossBar in interface Server

getEntity

@Nullable
public @Nullable Entity getEntity(@NotNull
 @NotNull UUID uuid)

Specified by:

getEntity in interface Server

getTPS

@NotNull
public @org.jetbrains.annotations.NotNull double[] getTPS()

Specified by:

getTPS in interface Server

getTickTimes

@NotNull
public @org.jetbrains.annotations.NotNull long[] getTickTimes()

Specified by:

getTickTimes in interface Server

getAverageTickTime

public double getAverageTickTime()

Specified by:

getAverageTickTime in interface Server

getAdvancement

public Advancement getAdvancement(NamespacedKey key)

Specified by:

getAdvancement in interface Server

advancementIterator

@NotNull
public @NotNull Iterator<Advancement> advancementIterator()

Specified by:

advancementIterator in interface Server

getUnsafe

@Deprecated
@NotNull
public @NotNull MockUnsafeValues getUnsafe()

Deprecated.

Specified by:

getUnsafe in interface Server

createBlockData

@NotNull
public @NotNull BlockData createBlockData(@NotNull
 @NotNull Material material)

Specified by:

createBlockData in interface Server

createBlockData

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

Specified by:

createBlockData in interface Server

createBlockData

@NotNull
public @NotNull BlockData createBlockData(String data)

Specified by:

createBlockData in interface Server

createBlockData

@NotNull
public @NotNull BlockData createBlockData(Material material,
 String data)

Specified by:

createBlockData in interface Server

createMaterialTag

@NotNull
public @NotNull Tag<Material> createMaterialTag(@NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull String registryKey,
 @NotNull
 @NotNull Material... materials)

This creates a new Mock Tag for the Material class.
Call this in advance before you are gonna access getTag(String, NamespacedKey, Class) or any of the constants defined in Tag.

Parameters:

key - The NamespacedKey for this Tag

registryKey - The name of the TagRegistry.

materials - Materials which should be covered by this Tag

Returns:

The newly created Tag

addTagRegistry

public void addTagRegistry(@NotNull
 @NotNull TagRegistry registry)

Adds a tag registry.

Parameters:

registry - The registry to add.

getTag

public <T extends Keyed> Tag<T> getTag(@NotNull
 @NotNull String registryKey,
 @NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull Class<T> clazz)

Specified by:

getTag in interface Server

getLootTable

public LootTable getLootTable(NamespacedKey key)

Specified by:

getLootTable in interface Server

createExplorerMap

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

Specified by:

createExplorerMap in interface Server

createExplorerMap

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

Specified by:

createExplorerMap in interface Server

createExplorerMap

@Nullable
public @Nullable ItemStack createExplorerMap(@NotNull
 @NotNull World world,
 @NotNull
 @NotNull Location location,
 @NotNull
 StructureType structureType,
 @NotNull
 MapCursor.Type mapIcon,
 int radius,
 boolean findUnexplored)

Specified by:

createExplorerMap in interface Server

createBossBar

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

Specified by:

createBossBar in interface Server

getBossBars

@NotNull
public @NotNull Iterator<KeyedBossBar> getBossBars()

Specified by:

getBossBars in interface Server

getBossBar

public KeyedBossBar getBossBar(NamespacedKey key)

Specified by:

getBossBar in interface Server

removeBossBar

public boolean removeBossBar(NamespacedKey key)

Specified by:

removeBossBar in interface Server

selectEntities

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

Specified by:

selectEntities in interface Server

getStructureManager

@NotNull
public @NotNull StructureManager getStructureManager()

Specified by:

getStructureManager in interface Server

getRegistry

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

Specified by:

getRegistry in interface Server

getMap

@Deprecated
public MapViewMock getMap(int id)

Deprecated.

Specified by:

getMap in interface Server

getTags

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

Specified by:

getTags in interface Server

getTicksPerWaterSpawns

@Deprecated
public int getTicksPerWaterSpawns()

Deprecated.

Specified by:

getTicksPerWaterSpawns in interface Server

getTicksPerAmbientSpawns

@Deprecated
public int getTicksPerAmbientSpawns()

Deprecated.

Specified by:

getTicksPerAmbientSpawns in interface Server

getCurrentServerTime

protected long getCurrentServerTime()

This returns the current time of the Server in milliseconds

Returns:

The current Server time

getTicksPerWaterAmbientSpawns

public int getTicksPerWaterAmbientSpawns()

Specified by:

getTicksPerWaterAmbientSpawns in interface Server

getTicksPerWaterUndergroundCreatureSpawns

@Deprecated
public int getTicksPerWaterUndergroundCreatureSpawns()

Deprecated.

Specified by:

getTicksPerWaterUndergroundCreatureSpawns in interface Server

getWaterAmbientSpawnLimit

@Deprecated
public int getWaterAmbientSpawnLimit()

Deprecated.

Specified by:

getWaterAmbientSpawnLimit in interface Server

getWaterUndergroundCreatureSpawnLimit

@Deprecated
public int getWaterUndergroundCreatureSpawnLimit()

Deprecated.

Specified by:

getWaterUndergroundCreatureSpawnLimit in interface Server

getMaxWorldSize

public int getMaxWorldSize()

Specified by:

getMaxWorldSize in interface Server

setMaxWorldSize

public void setMaxWorldSize(int maxWorldSize)

Set the maximum world size

Parameters:

maxWorldSize - The maximum world size

See Also:

• getMaxWorldSize()

getSimulationDistance

public int getSimulationDistance()

Specified by:

getSimulationDistance in interface Server

setSimulationDistance

public void setSimulationDistance(int simulationDistance)

Set the simulation distance

Parameters:

simulationDistance - The simulation distance

See Also:

• getSimulationDistance()

getHideOnlinePlayers

public boolean getHideOnlinePlayers()

Specified by:

getHideOnlinePlayers in interface Server

setHideOnlinePlayers

public void setHideOnlinePlayers(boolean hideOnlinePlayers)

Set whether to hide online players

Parameters:

hideOnlinePlayers - Whether to hide online players

See Also:

• getHideOnlinePlayers()

spigot

public @NotNull Server.Spigot spigot()

Specified by:

spigot in interface Server

reloadPermissions

public void reloadPermissions()

Specified by:

reloadPermissions in interface Server

reloadCommandAliases

public boolean reloadCommandAliases()

Specified by:

reloadCommandAliases in interface Server

suggestPlayerNamesWhenNullTabCompletions

public boolean suggestPlayerNamesWhenNullTabCompletions()

Specified by:

suggestPlayerNamesWhenNullTabCompletions in interface Server

getPermissionMessage

@NotNull
public @NotNull String getPermissionMessage()

Specified by:

getPermissionMessage in interface Server

permissionMessage

@NotNull
public @NotNull net.kyori.adventure.text.Component permissionMessage()

Specified by:

permissionMessage in interface Server

createProfile

@NotNull
public @NotNull PlayerProfileMock createProfile(@NotNull
 @NotNull UUID uuid)

Specified by:

createProfile in interface Server

createProfile

@NotNull
public @NotNull PlayerProfileMock createProfile(@NotNull
 @NotNull String name)

Specified by:

createProfile in interface Server

createProfile

@NotNull
public @NotNull PlayerProfileMock createProfile(@Nullable
 @Nullable UUID uuid,
 @Nullable
 @Nullable String name)

Specified by:

createProfile in interface Server

createProfileExact

@NotNull
public @NotNull PlayerProfileMock createProfileExact(@Nullable
 @Nullable UUID uuid,
 @Nullable
 @Nullable String name)

Specified by:

createProfileExact in interface Server

getCurrentTick

public int getCurrentTick()

Specified by:

getCurrentTick in interface Server

isStopping

public boolean isStopping()

Specified by:

isStopping in interface Server

getMobGoals

@NotNull
public @NotNull MobGoals getMobGoals()

Specified by:

getMobGoals in interface Server

getDatapackManager

@NotNull
public @NotNull DatapackManager getDatapackManager()

Specified by:

getDatapackManager in interface Server

getConfig

@NotNull
public @NotNull YamlConfiguration getConfig()

Overrides:

getConfig in class Server.Spigot

broadcast

@Deprecated
public void broadcast(@NotNull
 @NotNull net.md_5.bungee.api.chat.BaseComponent component)

Deprecated.

Specified by:

broadcast in interface Server

Overrides:

broadcast in class Server.Spigot

broadcast

@Deprecated
public void broadcast(@NotNull
 @NotNull net.md_5.bungee.api.chat.BaseComponent... components)

Deprecated.

Specified by:

broadcast in interface Server

Overrides:

broadcast in class Server.Spigot

restart

public void restart()

Overrides:

restart in class Server.Spigot

getTicksPerSpawns

public int getTicksPerSpawns(@NotNull
 @NotNull SpawnCategory spawnCategory)

Specified by:

getTicksPerSpawns in interface Server

createPlayerProfile

@Deprecated
@NotNull
public @NotNull PlayerProfileMock createPlayerProfile(@Nullable
 @Nullable UUID uniqueId,
 @Nullable
 @Nullable String name)

Deprecated.

Specified by:

createPlayerProfile in interface Server

createPlayerProfile

@Deprecated
@NotNull
public @NotNull PlayerProfileMock createPlayerProfile(@NotNull
 @NotNull UUID uniqueId)

Deprecated.

Specified by:

createPlayerProfile in interface Server

createPlayerProfile

@Deprecated
@NotNull
public @NotNull PlayerProfileMock createPlayerProfile(@NotNull
 @NotNull String name)

Deprecated.

Specified by:

createPlayerProfile in interface Server

getSpawnLimit

public int getSpawnLimit(@NotNull
 @NotNull SpawnCategory spawnCategory)

Specified by:

getSpawnLimit in interface Server

getPotionBrewer

@NotNull
public @NotNull PotionBrewer getPotionBrewer()

Specified by:

getPotionBrewer in interface Server

getRegionScheduler

@NotNull
public @NotNull RegionScheduler getRegionScheduler()

Specified by:

getRegionScheduler in interface Server

getAsyncScheduler

@NotNull
public @NotNull AsyncScheduler getAsyncScheduler()

Specified by:

getAsyncScheduler in interface Server

getGlobalRegionScheduler

@NotNull
public @NotNull GlobalRegionScheduler getGlobalRegionScheduler()

Specified by:

getGlobalRegionScheduler in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull World world,
 @NotNull
 @NotNull Position position)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull World world,
 @NotNull
 @NotNull Position position,
 int squareRadiusChunks)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull Location location)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull Location location,
 int squareRadiusChunks)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull World world,
 int chunkX,
 int chunkZ)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull World world,
 int chunkX,
 int chunkZ,
 int squareRadiusChunks)

Specified by:

isOwnedByCurrentRegion in interface Server

isOwnedByCurrentRegion

public boolean isOwnedByCurrentRegion(@NotNull
 @NotNull Entity entity)

Specified by:

isOwnedByCurrentRegion in interface Server

getPluginsFolder

@NotNull
public @NotNull File getPluginsFolder()

Specified by:

getPluginsFolder in interface Server

isAcceptingTransfers

public boolean isAcceptingTransfers()

Specified by:

isAcceptingTransfers in interface Server

getEntityFactory

@NotNull
public @NotNull EntityFactory getEntityFactory()

Specified by:

getEntityFactory in interface Server

audiences

@NotNull
public @NotNull Iterable<? extends net.kyori.adventure.audience.Audience> audiences()

Specified by:

audiences in interface net.kyori.adventure.audience.ForwardingAudience

getServerConfiguration

@NotNull
public @NotNull ServerConfiguration getServerConfiguration()

Exposes the ServerConfiguration of this ServerMock.

Returns:

The ServerConfiguration of this ServerMock.