### FileConfiguration.options() Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Gets the ConfigurationOptions for this FileConfiguration. ```APIDOC ## options() ### Description Gets the `ConfigurationOptions` for this `FileConfiguration`. ### Method `options()` ### Class `org.bukkit.configuration.file.FileConfiguration` ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/metadata/MetadataStoreBase.html Initializes a new instance of the MetadataStoreBase class. ```APIDOC ## Constructor MetadataStoreBase ### Description Initializes a new instance of the `MetadataStoreBase` class. ### Method `public MetadataStoreBase()` ``` -------------------------------- ### getUsage Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Gets an example usage of this command. ```APIDOC ## getUsage() ### Description Gets an example usage of this command. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response (200) - **usage** (string) - An example usage string. ``` -------------------------------- ### SpawnerEntry.Equipment Usage Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/spawner/class-use/SpawnerEntry.Equipment.html Demonstrates how to get and set the equipment for a SpawnerEntry. ```APIDOC ## SpawnerEntry.Equipment ### Description Represents the equipment that will be applied to a spawned entity. ### Methods #### `getEquipment()` ##### Description Gets the equipment which will be applied to the spawned entity. ##### Returns - `SpawnerEntry.Equipment` - The equipment for the spawned entity. #### `setEquipment(SpawnerEntry.Equipment equipment)` ##### Description Sets the equipment which will be applied to the spawned entity. ##### Parameters - **equipment** (`SpawnerEntry.Equipment`) - Required - The equipment to set. ### Constructors #### `SpawnerEntry(EntitySnapshot snapshot, int spawnWeight, SpawnRule spawnRule, SpawnerEntry.Equipment equipment)` ##### Description Constructs a new SpawnerEntry with the specified parameters, including equipment. ##### Parameters - **snapshot** (`EntitySnapshot`) - Required - The entity snapshot. - **spawnWeight** (`int`) - Required - The spawn weight. - **spawnRule** (`SpawnRule`) - Required - The spawn rule. - **equipment** (`SpawnerEntry.Equipment`) - Required - The equipment to apply. ``` -------------------------------- ### getStartLevel() Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html Gets the level that this Enchantment should start at. ```APIDOC ## getStartLevel() ### Description Gets the level that this Enchantment should start at. ### Method abstract int ### Returns (int) The starting level of the enchantment. ``` -------------------------------- ### Server Methods Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Methods for retrieving initial pack configurations. ```APIDOC ## Server ### Description Provides methods to get lists of packs that are initially disabled or enabled. ### Methods #### getInitialDisabledPacks() Gets a list of packs that will not be enabled automatically. #### getInitialEnabledPacks() Gets a list of packs to be enabled. ``` -------------------------------- ### Enchantment Methods Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Method to get the starting level of an Enchantment. ```APIDOC ## getStartLevel() ### Description Gets the level that this Enchantment should start at ### Method Method in class org.bukkit.enchantments.Enchantment ### Endpoint N/A (Class Method) ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/command/SimpleCommandMap.html Initializes a new instance of the SimpleCommandMap class. ```APIDOC ## SimpleCommandMap(Server server) ### Description Initializes a new instance of the SimpleCommandMap class. ### Constructor `SimpleCommandMap(Server server)` ``` -------------------------------- ### getDeathAnimationTicks Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Get the current time in ticks relative to the start of this dragon's death animation. ```APIDOC ## getDeathAnimationTicks() ### Description Get the current time in ticks relative to the start of this dragon's death animation. ### Method Method ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/command/SimpleCommandMap.html Initializes a new instance of the SimpleCommandMap class. ```APIDOC ## SimpleCommandMap ### Description Initializes a new instance of the SimpleCommandMap class. ### Parameters - **server** (Server) - The server instance. ``` -------------------------------- ### Raid Status and Information Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Raid.html Methods to check if a raid has started, get its current status, and retrieve information about its progression. ```APIDOC ## isStarted ### Description Get whether this raid started. ### Method `boolean isStarted()` ### Returns whether raid is started ``` ```APIDOC ## getStatus ### Description Gets the current status of the raid. Do not use this method to check if the raid has been started, call `isStarted()` instead. ### Method `Raid.RaidStatus getStatus()` ### Returns Raids status ``` ```APIDOC ## getActiveTicks ### Description Gets the amount of ticks this raid has existed. ### Method `long getActiveTicks()` ### Returns active ticks ``` ```APIDOC ## getSpawnedGroups ### Description Gets the number of raider groups which have spawned. ### Method `int getSpawnedGroups()` ### Returns total spawned groups ``` ```APIDOC ## getTotalGroups ### Description Gets the number of raider groups which would spawn. This also includes the group which spawns in the additional wave (if present). ### Method `int getTotalGroups()` ### Returns total groups ``` ```APIDOC ## getTotalWaves ### Description Gets the number of waves in this raid (exclude the additional wave). ### Method `int getTotalWaves()` ### Returns number of waves ``` ```APIDOC ## getTotalHealth ### Description Gets the sum of all raider's health. ### Method `float getTotalHealth()` ### Returns total raiders health ``` ```APIDOC ## getHeroes ### Description Get the UUID of all heroes in this raid. ### Method `Set getHeroes()` ### Returns a set of unique ids ``` ```APIDOC ## getRaiders ### Description Gets all remaining `Raider` in the present wave. ### Method `List getRaiders()` ### Returns a list of current raiders ``` -------------------------------- ### Get Specific Line Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/sign/SignSide.html Retrieves the line of text at a specific index on this side of the sign. Line indexing starts at 0. ```APIDOC ## getLine ### Description Gets the line of text at the specified index on this side of the sign. For example, getLine(0) will return the first line of text. ### Method `String getLine(int index)` ### Parameters * **index** (int) - Line number to get the text from, starting at 0 ### Returns Text on the given line ### Throws * `IndexOutOfBoundsException` - Thrown when the line does not exist ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/SimplePluginManager.html Initializes a new instance of the SimplePluginManager. ```APIDOC ## Constructor Details ### SimplePluginManager public SimplePluginManager(@NotNull Server instance, @NotNull SimpleCommandMap commandMap) ``` -------------------------------- ### BlockData getAsString() Example Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/data/BlockData.html Demonstrates how to get the string representation of BlockData, with options to include or omit unspecified states. This is useful for serialization and debugging. ```java String dataString = "minecraft:chest[waterlogged=true]" BlockData data = Bukkit.createBlockData(dataString); dataString.equals(data.getAsString(true)); // This would return true dataString.equals(data.getAsString(false)); // This would return false as all states are present dataString.equals(data.getAsString()); // This is equivalent to the above, "getAsString(false)" ``` -------------------------------- ### getServer() Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Gets the current Server singleton. ```APIDOC ## getServer() ### Description Gets the current `Server` singleton. ### Method Static method ### Class org.bukkit.Bukkit ``` ```APIDOC ## getServer() ### Description Returns the server instance that this command is running on. ### Method Method ### Interface org.bukkit.command.CommandSender ``` ```APIDOC ## getServer() ### Description Gets the `Server` that contains this Entity. ### Method Method ### Interface org.bukkit.entity.Entity ``` ```APIDOC ## getServer() ### Description Returns the Server instance currently running this plugin. ### Method Method ### Class org.bukkit.plugin.java.JavaPlugin ``` ```APIDOC ## getServer() ### Description Returns the Server instance currently running this plugin. ### Method Method ### Interface org.bukkit.plugin.Plugin ``` -------------------------------- ### MemoryConfiguration.options() Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Gets the ConfigurationOptions for this MemoryConfiguration. ```APIDOC ## options() ### Description Gets the `ConfigurationOptions` for this `MemoryConfiguration`. ### Method `options()` ### Class `org.bukkit.configuration.MemoryConfiguration` ``` -------------------------------- ### BookMeta.Spigot Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/BookMeta.Spigot.html Initializes a new instance of the Spigot BookMeta class. ```APIDOC ## Spigot() ### Description Constructs a new Spigot BookMeta object. ### Method `Spigot()` ### Endpoint N/A (Constructor) ``` -------------------------------- ### getBuffer Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/generator/LimitedRegion.html Gets the buffer around the central chunk which is accessible. The returned value is in normal world coordinate scale. For example: If the method returns 16 you have a working area of 48x48. ```APIDOC ## getBuffer ### Description Gets the buffer around the central chunk which is accessible. The returned value is in normal world coordinate scale. ### Returns - The buffer in X and Z direction (int) ``` -------------------------------- ### Getting the HelpMap Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/class-use/HelpMap.html You can obtain the HelpMap instance from either the Bukkit static class or the Server instance. The HelpMap provides access to help topics registered on the server. ```APIDOC ## Bukkit.getHelpMap() ### Description Gets the `HelpMap` providing help topics for this server. ### Method `static HelpMap` ### Endpoint N/A (Static method) ## Server.getHelpMap() ### Description Gets the `HelpMap` providing help topics for this server. ### Method `HelpMap` ### Endpoint N/A (Instance method) ``` -------------------------------- ### Get Recipe Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Server.html Get the Recipe for the given key. ```APIDOC ## getRecipe ### Description Get the `Recipe` for the given key. ### Parameters * `recipeKey` (NamespacedKey) - the key of the recipe to return ### Returns * `Recipe` - the recipe for the given key or null. ``` -------------------------------- ### MapCanvas Get Pixel Color Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Get a pixel from the canvas. ```APIDOC ## getPixelColor(int x, int y) ### Description Get a pixel from the canvas. ### Method N/A (Method signature) ### Endpoint N/A ### Parameters #### Path Parameters - **x** (int) - Required - The x-coordinate of the pixel. - **y** (int) - Required - The y-coordinate of the pixel. ### Request Example N/A ### Response #### Success Response - **color** (Color) - The color of the pixel at the specified coordinates. ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/SimpleServicesManager.html Initializes a new instance of the SimpleServicesManager class. ```APIDOC ## SimpleServicesManager() ### Description Initializes a new instance of the SimpleServicesManager class. ### Constructor `SimpleServicesManager()` ``` -------------------------------- ### Get Horse Style Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.html Gets the horse's style. ```APIDOC Horse.Style getStyle() Gets the horse's style. ``` -------------------------------- ### getLoad Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/PluginDescriptionFile.html Retrieves the phase of server startup at which the plugin should be loaded. ```APIDOC ### getLoad @NotNull public PluginLoadOrder getLoad() Gives the phase of server startup that the plugin should be loaded. * Possible values are in `PluginLoadOrder`. * Defaults to `PluginLoadOrder.POSTWORLD`. * Certain caveats apply to each phase. ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/map/MinecraftFont.html Initializes a new instance of the MinecraftFont class. ```APIDOC ## Constructor: MinecraftFont() ### Description Initialize a new MinecraftFont. ### Signature `public MinecraftFont()` ``` -------------------------------- ### Get Horse Inventory Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.html Get the object's inventory. ```APIDOC HorseInventory getInventory() Get the object's inventory. ``` -------------------------------- ### Constructor Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/permissions/PermissibleBase.html Initializes a new PermissibleBase instance. ```APIDOC ## Constructor PermissibleBase ### Description Initializes a new PermissibleBase instance. ### Parameters * **opable** (ServerOperator) - The server operator associated with this permissible base. ``` -------------------------------- ### Get Horse Color Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.html Gets the horse's color. ```APIDOC Horse.Color getColor() Gets the horse's color. ``` -------------------------------- ### Server Instance Management Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html Methods for setting the server instance and spawn radius. ```APIDOC ## setServer(Server server) ### Description Attempts to set the `Server` singleton. ### Returns `static void` ``` ```APIDOC ## setSpawnRadius(int value) ### Description Sets the radius, in blocks, around each worlds spawn point to protect. ### Returns `static void` ``` -------------------------------- ### Get World by Name Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html Gets the world with the given name. ```APIDOC ## getWorld ### Description Gets the world with the given name. ### Parameters #### Path Parameters - `name` (String) - The name of the world to retrieve ### Returns - a world with the given name, or null if none exists ``` -------------------------------- ### Show Demo Screen Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Player.html Shows the demo screen to the player. ```APIDOC ## showDemoScreen ### Description Shows the demo screen to the player, this screen is normally only seen in the demo version of the game. Servers can modify the text on this screen using a resource pack. ### Method `showDemoScreen` ``` -------------------------------- ### getModZ Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Get the amount of Z-coordinates to modify to get the represented block ```APIDOC ## getModZ() ### Description Get the amount of Z-coordinates to modify to get the represented block ### Method Method ### Endpoint org.bukkit.block.BlockFace ``` -------------------------------- ### Server.Spigot.getConfig() Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/configuration/file/class-use/YamlConfiguration.html Gets the server's main configuration file. ```APIDOC ## Server.Spigot.getConfig() ### Description Gets the server's main configuration file. ### Method YamlConfiguration ``` -------------------------------- ### getModY Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Get the amount of Y-coordinates to modify to get the represented block ```APIDOC ## getModY() ### Description Get the amount of Y-coordinates to modify to get the represented block ### Method Method ### Endpoint org.bukkit.block.BlockFace ``` -------------------------------- ### getFullText(CommandSender) - IndexHelpTopic Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Returns the full description of this help topic. ```APIDOC ## getFullText(CommandSender) - IndexHelpTopic ### Description Returns the full description of this help topic. ### Method GET ### Endpoint /indexhelptopic/fulltext ``` -------------------------------- ### getModX Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Get the amount of X-coordinates to modify to get the represented block ```APIDOC ## getModX() ### Description Get the amount of X-coordinates to modify to get the represented block ### Method Method ### Endpoint org.bukkit.block.BlockFace ``` -------------------------------- ### showDemoScreen Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Player.html Shows the demo screen to the player. ```APIDOC ## showDemoScreen() ### Description Shows the demo screen to the player, this screen is normally only seen in the demo version of the game. ### Method `void` ``` -------------------------------- ### Get Plugin Command Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html Gets a PluginCommand with the given name or alias. ```APIDOC ## getPluginCommand ### Description Gets a `PluginCommand` with the given name or alias. ### Parameters #### Path Parameters - `name` (String) - The name of the plugin command to retrieve ### Returns - a `PluginCommand` with the given name, or null if none exists ``` -------------------------------- ### Get World by UUID Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html Gets the world from the given Unique ID. ```APIDOC ## getWorld ### Description Gets the world from the given Unique ID. ### Parameters #### Path Parameters - `uid` (UUID) - A unique ID of the world to retrieve ### Returns - a world with the given Unique ID, or null if none exists ``` -------------------------------- ### getFullText(CommandSender) - HelpTopic Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Returns the full description of this help topic that is displayed when the user requests this topic's details. ```APIDOC ## getFullText(CommandSender) - HelpTopic ### Description Returns the full description of this help topic that is displayed when the user requests this topic's details. ### Method GET ### Endpoint /helptopic/fulltext ``` -------------------------------- ### LightningStrike Methods Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/LightningStrike.html Provides methods to check if a lightning strike is an effect, get and set flash counts, get and set life ticks, and get or set the causing player. ```APIDOC ## isEffect ### Description Returns whether the strike is an effect that does no damage. ### Returns - `boolean`: whether the strike is an effect ## getFlashes ### Description Get the amount of flashes that will occur before the lightning is removed. By default this value is between 1 and 3. ### Returns - `int`: the flashes ## setFlashes ### Description Set the amount of flashes that will occur before the lightning is removed. One flash will occur after this lightning strike's life has reduced below 0. ### Parameters - `flashes` (int) - the flashes ## getLifeTicks ### Description Get the amount of ticks this lightning strike will inflict damage upon its hit entities. When life ticks are negative, there is a random chance that another flash will be initiated and life ticks reset to 1. ### Returns - `int`: the life ticks ## setLifeTicks ### Description Get the amount of ticks this lightning strike will inflict damage upon its hit entities. When life ticks are negative, there is a random chance that another flash will be initiated and life ticks reset to 1. Additionally, if life ticks are set to 2 (the default value when a lightning strike has been spawned), a list of events will occur: Impact sound effects will be played, Fire will be spawned (dependent on difficulty), Lightning rods will be powered (if hit), Copper will be stripped (if hit), `GameEvent.LIGHTNING_STRIKE` will be dispatched. ### Parameters - `ticks` (int) - the life ticks ## getCausingPlayer ### Description Get the `Player` that caused this lightning to strike. This will occur naturally if a trident enchanted with `Channeling` were thrown at an entity during a storm. ### Returns - `Player`: the player ## setCausingPlayer ### Description Set the `Player` that caused this lightning to strike. ### Parameters - `player` (Player) - the player ``` -------------------------------- ### Constructor Summary Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/PluginDescriptionFile.html Constructors for creating a PluginDescriptionFile object. ```APIDOC ## Constructor Summary Constructors ### PluginDescriptionFile(InputStream stream) ### PluginDescriptionFile(Reader reader) Loads a PluginDescriptionFile from the specified reader. ### PluginDescriptionFile(String pluginName, String pluginVersion, String mainClass) Creates a new PluginDescriptionFile with the given detailed information. ``` -------------------------------- ### HelpCommand Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/command/defaults/HelpCommand.html Provides functionality for in-game help commands. ```APIDOC ## Class: HelpCommand Extends: `BukkitCommand` Description: Handles in-game help commands, allowing players to access information about other commands. ### Constructor - `HelpCommand()`: Creates a new instance of the HelpCommand. ### Methods - `execute(CommandSender sender, String currentAlias, String[] args)`: Executes the command. Returns true if the command was successful, otherwise false. - `tabComplete(CommandSender sender, String alias, String[] args)`: Provides tab completion suggestions for the help command. Returns a list of possible completions. - `findPossibleMatches(String searchString)`: Protected method to find possible help topics matching a search string. - `damerauLevenshteinDistance(String s1, String s2)`: Protected static method to compute the Damerau-Levenshtein distance between two strings. ``` -------------------------------- ### StructurePiece - Get Bounding Box Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html Gets the bounding box of a structure piece. ```APIDOC ## StructurePiece.getBoundingBox() ### Description Gets the bounding box of this structure piece. ### Method BoundingBox ``` -------------------------------- ### HelpTopicFactory.createTopic Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/class-use/HelpTopic.html Creates a HelpTopic for a given command, allowing for custom help topic generation based on command implementations. ```APIDOC ## HelpTopicFactory.createTopic ### Description This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it. ### Method HelpTopic ### Parameters - **command** (TCommand) - Description of the command object used to create the topic. ``` -------------------------------- ### GeneratedStructure - Get Bounding Box Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html Gets the bounding box of a placed structure. ```APIDOC ## GeneratedStructure.getBoundingBox() ### Description Gets the bounding box of this placed structure. ### Method BoundingBox ``` -------------------------------- ### HelpCommand.execute Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/command/class-use/CommandSender.html Executes the help command. ```APIDOC ## HelpCommand.execute ### Description Executes the help command. ### Method Signature `boolean execute(CommandSender sender, String currentAlias, String[] args)` ``` -------------------------------- ### AsyncStructureSpawnEvent - Get Bounding Box Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html Gets the bounding box of the structure being spawned. ```APIDOC ## AsyncStructureSpawnEvent.getBoundingBox() ### Description Get the bounding box of the structure. ### Method BoundingBox ``` -------------------------------- ### AsyncStructureGenerateEvent - Get Bounding Box Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html Gets the bounding box of the structure being generated. ```APIDOC ## AsyncStructureGenerateEvent.getBoundingBox() ### Description Get the bounding box of the structure. ### Method BoundingBox ``` -------------------------------- ### setResourcePack (String, byte[], String, boolean) Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Player.html Requests the player's client to download and switch resource packs. The client downloads asynchronously and switches upon completion. If a pack with the same hash exists, it's applied directly. A prompt can be shown, and the player can be disconnected if they decline. ```APIDOC ## setResourcePack ### Description Request that the player's client download and switch resource packs. The player's client will download the new resource pack asynchronously in the background, and will automatically switch to it once the download is complete. If the client has downloaded and cached a resource pack with the same hash in the past it will not download but directly apply the cached pack. If the hash is null and the client has downloaded and cached the same resource pack in the past, it will perform a file size check against the response content to determine if the resource pack has changed and needs to be downloaded again. When this request is sent for the very first time from a given server, the client will first display a confirmation GUI to the player before proceeding with the download. Notes: * Players can disable server resources on their client, in which case this method will have no affect on them. Use the `PlayerResourcePackStatusEvent` to figure out whether or not the player loaded the pack! * To remove a resource pack you can use `removeResourcePack(UUID)` or `removeResourcePacks()`. * The request is sent with empty string as the hash when the hash is not provided. This might result in newer versions not loading the pack correctly. ### Parameters * `url` - The URL from which the client will download the resource pack. The string must contain only US-ASCII characters and should be encoded as per RFC 1738. * `hash` - The sha1 hash sum of the resource pack file which is used to apply a cached version of the pack directly without downloading if it is available. Hast to be 20 bytes long! * `prompt` - The optional custom prompt message to be shown to client. * `force` - If true, the client will be disconnected from the server when it declines to use the resource pack. ### Throws * `IllegalArgumentException` - Thrown if the URL is null. * `IllegalArgumentException` - Thrown if the URL is too long. The length restriction is an implementation specific arbitrary value. * `IllegalArgumentException` - Thrown if the hash is not 20 bytes long. ``` -------------------------------- ### create Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/MenuType.Typed.html Creates a view of the specified menu type. The player provided must be the player the view is opened for. ```APIDOC ## create ### Description Creates a view of the specified menu type. The player provided to create this view must be the player the view is opened for. See `HumanEntity.openInventory(InventoryView)` for more information. ### Method `create` ### Parameters #### Path Parameters - **player** (HumanEntity) - Required - the player the view belongs to - **title** (String) - Required - the title of the view ### Returns - **V** (InventoryView) - the created `InventoryView` ``` -------------------------------- ### Block - Get Bounding Box Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html Gets the approximate bounding box for a block. ```APIDOC ## Block.getBoundingBox() ### Description Gets the approximate bounding box for this block. ### Method BoundingBox ``` -------------------------------- ### Get Team Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/scoreboard/Scoreboard.html Retrieves a team by its name or gets the team a player belongs to. ```APIDOC ## getTeam ### Description Gets a Team by name on this Scoreboard. ### Method Signature ```java Team getTeam(@NotNull String teamName) ``` ### Parameters #### Path Parameters - **teamName** (String) - Required - The name of the team to retrieve. ### Returns - **Team** - The Team with the specified name, or null if not found. ``` ```APIDOC ## getEntryTeam ### Description Gets a Team for a given entry on this Scoreboard. ### Method Signature ```java Team getEntryTeam(@NotNull String entry) ``` ### Parameters #### Path Parameters - **entry** (String) - Required - The entry to find the team for. ### Returns - **Team** - The Team the entry belongs to, or null if the entry is not on a team. ``` -------------------------------- ### getPrompt Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Gets the prompt to show of the resource pack. ```APIDOC ## getPrompt() ### Description Gets the prompt to show of the resource pack. ### Method Method ### Interface org.bukkit.packs.ResourcePack ``` -------------------------------- ### DecoratedPot Methods Using DecoratedPot.Side Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/class-use/DecoratedPot.Side.html Demonstrates how to interact with DecoratedPot instances using the DecoratedPot.Side enum to manage sherds. ```APIDOC ## DecoratedPot ### Methods #### `Map getSherds()` Gets a Map of all sides on this decorated pot and the sherds on them. #### `Material getSherd(DecoratedPot.Side side)` Get the sherd on the provided side. #### `void setSherd(DecoratedPot.Side side, Material sherd)` Set the sherd on the provided side. ``` -------------------------------- ### Get Handler List Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/enchantment/EnchantItemEvent.html A static method to get the handler list for EnchantItemEvent. ```APIDOC ## Get Handler List @NotNull public static HandlerList getHandlerList() ``` -------------------------------- ### Plugin.getDescription() Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/class-use/PluginDescriptionFile.html Returns the plugin.yaml file containing the details for this plugin. ```APIDOC ## Plugin.getDescription() ### Description Returns the plugin.yaml file containing the details for this plugin. ### Method `PluginDescriptionFile` ### Endpoint N/A (Java Method) ``` -------------------------------- ### Get Configuration Options Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/configuration/file/FileConfiguration.html Gets the `FileConfigurationOptions` for this `Configuration`. All setters through this method are chainable. ```APIDOC ## options() ### Description Gets the `ConfigurationOptions` for this `Configuration`. All setters through this method are chainable. ### Returns * `FileConfigurationOptions` - Options for this configuration. ``` -------------------------------- ### Custom PersistentDataType Implementation Example Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/persistence/PersistentDataType.html Example of how to implement a custom PersistentDataType for UUID. ```APIDOC ## Custom Implementation Example: UUIDTagType ```java public class UUIDTagType implements PersistentDataType { @Override public Class getPrimitiveType() { return byte[].class; } @Override public Class getComplexType() { return UUID.class; } @Override public byte[] toPrimitive(UUID complex, PersistentDataAdapterContext context) { ByteBuffer bb = ByteBuffer.wrap(new byte[16]); bb.putLong(complex.getMostSignificantBits()); bb.putLong(complex.getLeastSignificantBits()); return bb.array(); } @Override public UUID fromPrimitive(byte[] primitive, PersistentDataAdapterContext context) { ByteBuffer bb = ByteBuffer.wrap(primitive); long firstLong = bb.getLong(); long secondLong = bb.getLong(); return new UUID(firstLong, secondLong); } } ``` **Note**: Any plugin-owned implementation of this interface is required to define one of the existing primitive types found in this interface. `BOOLEAN` is a convenience type and not a primitive. ``` -------------------------------- ### setServer(Server) Source: https://hub.spigotmc.org/javadocs/spigot/index-all.html Attempts to set the `Server` singleton. ```APIDOC ## setServer(Server) ### Description Attempts to set the `Server` singleton. ### Method Static ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### BlockType.Typed Examples Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/class-use/BlockType.Typed.html Examples of BlockType.Typed instances, illustrating the specific BlockData they represent. ```APIDOC ## BlockType.Typed ### Description Represents a block type that can be waterlogged, such as BARRIER. ### BlockType BARRIER ### BlockData Waterlogged ``` ```APIDOC ## BlockType.Typed ### Description Represents a block type that is orientable, meaning its orientation can be changed. Examples include BASALT and BIRCH_LOG. ### BlockType BASALT ### BlockData Orientable ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type that uses standard BlockData. Examples include BEACON and BEDROCK. ### BlockType BEACON ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a block type that is a Beehive or Bee Nest, with associated Beehive block data. ### BlockType BEE_NEST ### BlockData Beehive ``` ```APIDOC ## BlockType.Typed ### Description Represents a Beehive block type, which has specific Beehive block data. ### BlockType BEEHIVE ### BlockData Beehive ``` ```APIDOC ## BlockType.Typed ### Description Represents a block type that is ageable, such as BEETROOTS, which progresses through growth stages. ### BlockType BEETROOTS ### BlockData Ageable ``` ```APIDOC ## BlockType.Typed ### Description Represents a BELL block type, which has associated Bell block data. ### BlockType BELL ### BlockData Bell ``` ```APIDOC ## BlockType.Typed ### Description Represents a BIG_DRIPLEAF block type, which has associated BigDripleaf block data. ### BlockType BIG_DRIPLEAF ### BlockData BigDripleaf ``` ```APIDOC ## BlockType.Typed ### Description Represents a BIG_DRIPLEAF_STEM block type, which is part of the dripleaf system and uses Dripleaf block data. ### BlockType BIG_DRIPLEAF_STEM ### BlockData Dripleaf ``` ```APIDOC ## BlockType.Typed ### Description Represents a block type that acts as a switch, such as BIRCH_BUTTON, with associated Switch block data. ### BlockType BIRCH_BUTTON ### BlockData Switch ``` ```APIDOC ## BlockType.Typed ### Description Represents a door block type, like BIRCH_DOOR, which has Door block data. ### BlockType BIRCH_DOOR ### BlockData Door ``` ```APIDOC ## BlockType.Typed ### Description Represents a fence block type, such as BIRCH_FENCE, with associated Fence block data. ### BlockType BIRCH_FENCE ### BlockData Fence ``` ```APIDOC ## BlockType.Typed ### Description Represents a fence gate block type, like BIRCH_FENCE_GATE, which uses Gate block data. ### BlockType BIRCH_FENCE_GATE ### BlockData Gate ``` ```APIDOC ## BlockType.Typed ### Description Represents a hanging sign block type, such as BIRCH_HANGING_SIGN, with associated HangingSign block data. ### BlockType BIRCH_HANGING_SIGN ### BlockData HangingSign ``` ```APIDOC ## BlockType.Typed ### Description Represents a leaves block type, like BIRCH_LEAVES, which has Leaves block data. ### BlockType BIRCH_LEAVES ### BlockData Leaves ``` ```APIDOC ## BlockType.Typed ### Description Represents an orientable block type, such as BIRCH_LOG, with associated Orientable block data. ### BlockType BIRCH_LOG ### BlockData Orientable ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BIRCH_PLANKS. ### BlockType BIRCH_PLANKS ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a powerable block type, such as BIRCH_PRESSURE_PLATE, with associated Powerable block data. ### BlockType BIRCH_PRESSURE_PLATE ### BlockData Powerable ``` ```APIDOC ## BlockType.Typed ### Description Represents a sapling block type, like BIRCH_SAPLING, which has Sapling block data. ### BlockType BIRCH_SAPLING ### BlockData Sapling ``` ```APIDOC ## BlockType.Typed ### Description Represents a shelf block type, such as BIRCH_SHELF, with associated Shelf block data. ### BlockType BIRCH_SHELF ### BlockData Shelf ``` ```APIDOC ## BlockType.Typed ### Description Represents a sign block type, like BIRCH_SIGN, which has Sign block data. ### BlockType BIRCH_SIGN ### BlockData Sign ``` ```APIDOC ## BlockType.Typed ### Description Represents a slab block type, such as BIRCH_SLAB, with associated Slab block data. ### BlockType BIRCH_SLAB ### BlockData Slab ``` ```APIDOC ## BlockType.Typed ### Description Represents a stairs block type, like BIRCH_STAIRS, which has Stairs block data. ### BlockType BIRCH_STAIRS ### BlockData Stairs ``` ```APIDOC ## BlockType.Typed ### Description Represents a trapdoor block type, such as BIRCH_TRAPDOOR, with associated TrapDoor block data. ### BlockType BIRCH_TRAPDOOR ### BlockData TrapDoor ``` ```APIDOC ## BlockType.Typed ### Description Represents a wall-hanging sign block type, like BIRCH_WALL_HANGING_SIGN, with associated WallHangingSign block data. ### BlockType BIRCH_WALL_HANGING_SIGN ### BlockData WallHangingSign ``` ```APIDOC ## BlockType.Typed ### Description Represents a wall sign block type, such as BIRCH_WALL_SIGN, with associated WallSign block data. ### BlockType BIRCH_WALL_SIGN ### BlockData WallSign ``` ```APIDOC ## BlockType.Typed ### Description Represents an orientable block type, like BIRCH_WOOD, with associated Orientable block data. ### BlockType BIRCH_WOOD ### BlockData Orientable ``` ```APIDOC ## BlockType.Typed ### Description Represents a rotatable block type, such as BLACK_BANNER, with associated Rotatable block data. ### BlockType BLACK_BANNER ### BlockData Rotatable ``` ```APIDOC ## BlockType.Typed ### Description Represents a bed block type, like BLACK_BED, which has Bed block data. ### BlockType BLACK_BED ### BlockData Bed ``` ```APIDOC ## BlockType.Typed ### Description Represents a candle block type, such as BLACK_CANDLE, with associated Candle block data. ### BlockType BLACK_CANDLE ### BlockData Candle ``` ```APIDOC ## BlockType.Typed ### Description Represents a lightable block type, like BLACK_CANDLE_CAKE, which has Lightable block data. ### BlockType BLACK_CANDLE_CAKE ### BlockData Lightable ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLACK_CARPET. ### BlockType BLACK_CARPET ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLACK_CONCRETE. ### BlockType BLACK_CONCRETE ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLACK_CONCRETE_POWDER. ### BlockType BLACK_CONCRETE_POWDER ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a directional block type, like BLACK_GLAZED_TERRACOTTA, with associated Directional block data. ### BlockType BLACK_GLAZED_TERRACOTTA ### BlockData Directional ``` ```APIDOC ## BlockType.Typed ### Description Represents a directional block type, such as BLACK_SHULKER_BOX, with associated Directional block data. ### BlockType BLACK_SHULKER_BOX ### BlockData Directional ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLACK_STAINED_GLASS. ### BlockType BLACK_STAINED_GLASS ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a glass pane block type, such as BLACK_STAINED_GLASS_PANE, with associated GlassPane block data. ### BlockType BLACK_STAINED_GLASS_PANE ### BlockData GlassPane ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLACK_TERRACOTTA. ### BlockType BLACK_TERRACOTTA ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a directional block type, such as BLACK_WALL_BANNER, with associated Directional block data. ### BlockType BLACK_WALL_BANNER ### BlockData Directional ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLACK_WOOL. ### BlockType BLACK_WOOL ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLACKSTONE. ### BlockType BLACKSTONE ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a slab block type, like BLACKSTONE_SLAB, with associated Slab block data. ### BlockType BLACKSTONE_SLAB ### BlockData Slab ``` ```APIDOC ## BlockType.Typed ### Description Represents a stairs block type, such as BLACKSTONE_STAIRS, with associated Stairs block data. ### BlockType BLACKSTONE_STAIRS ### BlockData Stairs ``` ```APIDOC ## BlockType.Typed ### Description Represents a wall block type, like BLACKSTONE_WALL, with associated Wall block data. ### BlockType BLACKSTONE_WALL ### BlockData Wall ``` ```APIDOC ## BlockType.Typed ### Description Represents a blast furnace block type, with associated Furnace block data. ### BlockType BLAST_FURNACE ### BlockData Furnace ``` ```APIDOC ## BlockType.Typed ### Description Represents a rotatable block type, such as BLUE_BANNER, with associated Rotatable block data. ### BlockType BLUE_BANNER ### BlockData Rotatable ``` ```APIDOC ## BlockType.Typed ### Description Represents a bed block type, like BLUE_BED, which has Bed block data. ### BlockType BLUE_BED ### BlockData Bed ``` ```APIDOC ## BlockType.Typed ### Description Represents a candle block type, such as BLUE_CANDLE, with associated Candle block data. ### BlockType BLUE_CANDLE ### BlockData Candle ``` ```APIDOC ## BlockType.Typed ### Description Represents a lightable block type, like BLUE_CANDLE_CAKE, which has Lightable block data. ### BlockType BLUE_CANDLE_CAKE ### BlockData Lightable ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLUE_CARPET. ### BlockType BLUE_CARPET ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLUE_CONCRETE. ### BlockType BLUE_CONCRETE ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLUE_CONCRETE_POWDER. ### BlockType BLUE_CONCRETE_POWDER ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a directional block type, like BLUE_GLAZED_TERRACOTTA, with associated Directional block data. ### BlockType BLUE_GLAZED_TERRACOTTA ### BlockData Directional ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, such as BLUE_ICE. ### BlockType BLUE_ICE ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLUE_ORCHID. ### BlockType BLUE_ORCHID ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a directional block type, such as BLUE_SHULKER_BOX, with associated Directional block data. ### BlockType BLUE_SHULKER_BOX ### BlockData Directional ``` ```APIDOC ## BlockType.Typed ### Description Represents a generic block type with standard BlockData, like BLUE_STAINED_GLASS. ### BlockType BLUE_STAINED_GLASS ### BlockData BlockData ``` ```APIDOC ## BlockType.Typed ### Description Represents a glass pane block type, such as BLUE_STAINED_GLASS_PANE, with associated GlassPane block data. ### BlockType BLUE_STAINED_GLASS_PANE ### BlockData GlassPane ```