### Get Command Usage

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/command/Command.html

Gets an example usage of this command.

```APIDOC
## getUsage

### Description
Gets an example usage of this command.

### Returns
One or more example usages
```

--------------------------------

### getUsage

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets an example usage of this command.

```APIDOC
## getUsage

### Description
Gets an example usage of this command.

### Method
Method in class org.bukkit.command.Command
```

--------------------------------

### Brewing Start Event Handler List

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the handler list for the BrewingStartEvent.

```APIDOC
## getHandlerList()

### Description
Gets the handler list for the BrewingStartEvent.

### Method
Static method

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Plugin.yml Example

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/PluginDescriptionFile.html

An example of a plugin.yml file, demonstrating the structure and common fields for Bukkit plugins.

```yaml
name: Inferno
provides: [Hell]
version: 1.4.1
description: This plugin is so 31337. You can set yourself on fire.
# We could place every author in the authors list, but chose not to for illustrative purposes
# Also, having an author distinguishes that person as the project lead, and ensures their
```

--------------------------------

### Inventory Block Start Event Handler List

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the handler list for the InventoryBlockStartEvent.

```APIDOC
## getHandlerList()

### Description
Gets the handler list for the InventoryBlockStartEvent.

### Method
Static method

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Campfire Start Event Handler List

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the handler list for the CampfireStartEvent.

```APIDOC
## getHandlerList()

### Description
Gets the handler list for the CampfireStartEvent.

### Method
Static method

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### General Item Setting and Getting

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/PlayerInventory.html

Methods for setting and getting items by index or equipment slot.

```APIDOC
## setItem

### Description
Stores the ItemStack at the given index of the inventory. Indexes 0-8 are hotbar, 9-35 are main inventory, 36-39 are armor, and 40 is off-hand.

### Parameters
- `index` (int) - The index where to put the ItemStack.
- `item` (ItemStack) - The ItemStack to set.

### Throws
- `ArrayIndexOutOfBoundsException` - when index < 0 || index > 40
```

```APIDOC
## setItem

### Description
Stores the ItemStack at the given equipment slot in the inventory.

### Parameters
- `slot` (EquipmentSlot) - The slot to put the ItemStack.
- `item` (ItemStack) - The ItemStack to set.
```

```APIDOC
## getItem

### Description
Gets the ItemStack at the given equipment slot in the inventory.

### Parameters
- `slot` (EquipmentSlot) - The slot to get the ItemStack.

### Returns
The ItemStack in the given slot or null if there is not one.
```

--------------------------------

### InventoryBlockStartEvent Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Used when: A Furnace starts smelting `FurnaceStartSmeltEvent` A Brewing-Stand starts brewing `BrewingStartEvent` A Campfire starts cooking `CampfireStartEvent`

```APIDOC
## InventoryBlockStartEvent(Block, ItemStack)

### Description
Constructor for class org.bukkit.event.block.InventoryBlockStartEvent. Used when: A Furnace starts smelting `FurnaceStartSmeltEvent` A Brewing-Stand starts brewing `BrewingStartEvent` A Campfire starts cooking `CampfireStartEvent`.

### Parameters
* **Block** - The block involved in the event.
* **ItemStack** - The item stack involved in the event.
```

--------------------------------

### Plugin Permissions Hierarchy Example

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/PluginDescriptionFile.html

An example demonstrating a hierarchical structure for plugin permissions, including descriptions and nested children. This defines permissions for 'inferno.*', 'inferno.flagrate', and 'inferno.burningdeaths'.

```yaml
permissions:
  inferno.*
    description: Gives access to all Inferno commands
    children:
      inferno.flagrate: true
      inferno.burningdeaths: true
  inferno.flagate:
    description: Allows you to ignite yourself
    default: true
  inferno.burningdeaths:
    description: Allows you to see how many times you have burned to death
    default: true
```

--------------------------------

### YamlConfigurationOptions.width()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets how long a line can be, before it gets split.

```APIDOC
## width()

### Description
Gets how long a line can be, before it gets split.

### Method
`width()`

### Class
`org.bukkit.configuration.file.YamlConfigurationOptions`
```

--------------------------------

### Define Full Command Structure in plugin.yml

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/PluginDescriptionFile.html

A comprehensive example showing how to define multiple commands with their descriptions, aliases, permissions, permission messages, and usage instructions.

```yaml
commands:
  flagrate:
    description: Set yourself on fire.
    aliases: [combust_me, combustMe]
    permission: inferno.flagrate
    permission-message: You do not have /<permission>
    usage: Syntax error! Perhaps you meant /<command> PlayerName?
  burningdeaths:
    description: List how many times you have died by fire.
    aliases:
    - burning_deaths
    - burningDeaths
    permission: inferno.burningdeaths
    usage: |
      /<command> [player]
      Example: /<command> - see how many times you have burned to death
      Example: /<command> CaptainIce - see how many times CaptainIce has burned to death
  # The next command has no description, aliases, etc. defined, but is still valid
  # Having an empty declaration is useful for defining the description, permission, and messages from a configuration dynamically
  apocalypse:

```

--------------------------------

### getStartLevel

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the level that this Enchantment should start at.

```APIDOC
## getStartLevel()

### Description
Gets the level that this Enchantment should start at.

### Method
GET (conceptual)

### Endpoint
N/A (Method call)

### Parameters
None

### Response
- **Integer**: The starting level.
```

--------------------------------

### getExample() - EquipmentSlotGroup

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Deprecated. for internal compatibility use only

```APIDOC
## getExample()

### Description
Deprecated. for internal compatibility use only

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Object** (Object) - An example object.
```

--------------------------------

### Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/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.
```

--------------------------------

### BookMeta.Spigot Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/BookMeta.Spigot.html

Initializes a new instance of the Spigot BookMeta class.

```APIDOC
## Spigot()

### Description
Initializes a new instance of the Spigot BookMeta class.

### Constructor
`Spigot()`
```

--------------------------------

### Recipe Input and Creation

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/class-use/Material.html

Demonstrates setting Material as input for various recipes and creating recipes with Material types.

```APIDOC
## ShapedRecipe.setIngredient

### Description
Sets an ingredient for a shaped recipe using a character key, a Material, and raw data.

### Method
`ShapedRecipe.setIngredient(char key, Material ingredient, int raw)`

### Parameters
- `key` (char) - The key representing the ingredient's position in the crafting grid.
- `ingredient` (Material) - The material to be used as an ingredient.
- `raw` (int) - Raw data associated with the material (deprecated).

## CookingRecipe.setInput

### Description
Sets the input material for a cooking recipe.

### Method
`CookingRecipe.setInput(Material input)`

### Parameters
- `input` (Material) - The material that serves as the input for the recipe.

## FurnaceRecipe.setInput (Deprecated)

### Description
Sets the input material for a furnace recipe. This method is deprecated.

### Method
`FurnaceRecipe.setInput(Material input)`

### Parameters
- `input` (Material) - The material that serves as the input for the furnace recipe.

## FurnaceRecipe.setInput (Deprecated with data)

### Description
Sets the input material and data for a furnace recipe. This method is deprecated.

### Method
`FurnaceRecipe.setInput(Material input, int data)`

### Parameters
- `input` (Material) - The material that serves as the input for the furnace recipe.
- `data` (int) - The data value for the material (deprecated).

## StonecuttingRecipe.setInput

### Description
Sets the input material for a stonecutting recipe.

### Method
`StonecuttingRecipe.setInput(Material input)`

### Parameters
- `input` (Material) - The material that serves as the input for the stonecutting recipe.

## BlastingRecipe Constructor

### Description
Creates a blasting recipe.

### Method
`BlastingRecipe(NamespacedKey key, ItemStack result, Material source, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## CampfireRecipe Constructor

### Description
Creates a campfire recipe.

### Method
`CampfireRecipe(NamespacedKey key, ItemStack result, Material source, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## CookingRecipe Constructor

### Description
Creates a cooking recipe to craft the specified ItemStack.

### Method
`CookingRecipe(NamespacedKey key, ItemStack result, Material source, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## DyeRecipe Constructor

### Description
Creates a dye recipe to produce a result of the specified type.

### Method
`DyeRecipe(NamespacedKey key, Material result, RecipeChoice input, RecipeChoice material)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (Material) - The material produced by the recipe.
- `input` (RecipeChoice) - The recipe choice for the input.
- `material` (RecipeChoice) - The recipe choice for the material.

## FurnaceRecipe Constructor (Deprecated)

### Description
Creates a furnace recipe. This constructor is deprecated.

### Method
`FurnaceRecipe(ItemStack result, Material source)`

### Parameters
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.

## FurnaceRecipe Constructor (Deprecated with data)

### Description
Creates a furnace recipe with data. This constructor is deprecated.

### Method
`FurnaceRecipe(ItemStack result, Material source, int data)`

### Parameters
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `data` (int) - The data value for the material.

## FurnaceRecipe Constructor (with NamespacedKey)

### Description
Creates a furnace recipe to craft the specified ItemStack.

### Method
`FurnaceRecipe(NamespacedKey key, ItemStack result, Material source, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## FurnaceRecipe Constructor (Deprecated with NamespacedKey)

### Description
Creates a furnace recipe with data and a NamespacedKey. This constructor is deprecated.

### Method
`FurnaceRecipe(NamespacedKey key, ItemStack result, Material source, int data, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `data` (int) - The data value for the material.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## ImbueRecipe Constructor

### Description
Creates an imbue recipe to produce a result of the specified type.

### Method
`ImbueRecipe(NamespacedKey key, Material result, RecipeChoice input, RecipeChoice material)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (Material) - The material produced by the recipe.
- `input` (RecipeChoice) - The recipe choice for the input.
- `material` (RecipeChoice) - The recipe choice for the material.

## SmokingRecipe Constructor

### Description
Creates a smoking recipe.

### Method
`SmokingRecipe(NamespacedKey key, ItemStack result, Material source, float experience, int cookingTime)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.
- `experience` (float) - The experience gained upon crafting.
- `cookingTime` (int) - The time it takes to cook.

## StonecuttingRecipe Constructor

### Description
Creates a Stonecutting recipe to craft the specified ItemStack.

### Method
`StonecuttingRecipe(NamespacedKey key, ItemStack result, Material source)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (ItemStack) - The item produced by the recipe.
- `source` (Material) - The material used as input for the recipe.

## TransmuteRecipe Constructor

### Description
Creates a transmute recipe to produce a result of the specified type.

### Method
`TransmuteRecipe(NamespacedKey key, Material result, RecipeChoice input, RecipeChoice material)`

### Parameters
- `key` (NamespacedKey) - The unique key for the recipe.
- `result` (Material) - The material produced by the recipe.
- `input` (RecipeChoice) - The recipe choice for the input.
- `material` (RecipeChoice) - The recipe choice for the material.
```

--------------------------------

### Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/SimplePluginManager.html

Initializes a new SimplePluginManager instance.

```APIDOC
## Constructor Details
### SimplePluginManager
public SimplePluginManager(@NotNull Server instance, @NotNull SimpleCommandMap commandMap)
```

--------------------------------

### EquipmentSlotGroup Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/class-use/EquipmentSlot.html

Details on how EquipmentSlotGroup interacts with EquipmentSlot, including getting an example slot and testing against a slot.

```APIDOC
## EquipmentSlotGroup Class

### Methods

#### `EquipmentSlot getExample()`
Deprecated. for internal compatibility use only

#### `boolean test(EquipmentSlot test)`
Tests if the group contains the specified equipment slot.
```

--------------------------------

### Getting and Loading Server Icons

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/util/class-use/CachedServerIcon.html

Demonstrates how to obtain the default server icon and how to load custom server icons from various sources.

```APIDOC
## Bukkit API - Server Icon Management

### Description
Provides methods to interact with the server's icon, allowing retrieval of the default icon and creation of new icons from images or files.

### Methods

#### `static CachedServerIcon Bukkit.getServerIcon()`
*   **Description**: Gets an instance of the server's default server-icon.
*   **Returns**: A `CachedServerIcon` representing the default server icon.

#### `CachedServerIcon Server.getServerIcon()`
*   **Description**: Gets an instance of the server's default server-icon.
*   **Returns**: A `CachedServerIcon` representing the default server icon.

#### `static CachedServerIcon Bukkit.loadServerIcon(BufferedImage image)`
*   **Description**: Creates a cached server-icon for the specific image.
*   **Parameters**:
    *   `image` (BufferedImage) - The image to use for the server icon.
*   **Returns**: A `CachedServerIcon` created from the provided image.

#### `static CachedServerIcon Bukkit.loadServerIcon(File file)`
*   **Description**: Loads an image from a file, and returns a cached image for the specific server-icon.
*   **Parameters**:
    *   `file` (File) - The file containing the image for the server icon.
*   **Returns**: A `CachedServerIcon` loaded from the provided file.

#### `CachedServerIcon Server.loadServerIcon(BufferedImage image)`
*   **Description**: Creates a cached server-icon for the specific image.
*   **Parameters**:
    *   `image` (BufferedImage) - The image to use for the server icon.
*   **Returns**: A `CachedServerIcon` created from the provided image.

#### `CachedServerIcon Server.loadServerIcon(File file)`
*   **Description**: Loads an image from a file, and returns a cached image for the specific server-icon.
*   **Parameters**:
    *   `file` (File) - The file containing the image for the server icon.
*   **Returns**: A `CachedServerIcon` loaded from the provided file.
```

--------------------------------

### getDeathAnimationTicks()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the current time in ticks relative to the start of this Ender Dragon's death animation.

```APIDOC
## getDeathAnimationTicks()

### Description
Get the current time in ticks relative to the start of this dragon's death animation.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
#### Success Response (200)
- **ticks** (int) - The time in ticks.
```

--------------------------------

### getDeathAnimationTicks

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EnderDragon.html

Gets the current time in ticks relative to the start of the EnderDragon's death animation. Returns 0 if the dragon is alive.

```APIDOC
## Method Details
### getDeathAnimationTicks
int getDeathAnimationTicks()
Get the current time in ticks relative to the start of this dragon's death animation. If this dragon is alive, 0 will be returned. This value will never exceed 200 (the length of the animation).

Returns:
    this dragon's death animation ticks
```

--------------------------------

### Bukkit.getHelpMap()

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/help/class-use/HelpMap.html

Retrieves the HelpMap instance from the Bukkit class, which provides access to all registered help topics on the server.

```APIDOC
## Bukkit.getHelpMap()

### Description
Gets the `HelpMap` providing help topics for this server.

### Method
`static HelpMap`

### Endpoint
N/A (Static method call)

### Parameters
None

### Response
#### Success Response
- **HelpMap** (HelpMap) - The HelpMap instance for the server.
```

--------------------------------

### getBuffer

Source: https://hub.spigotmc.org/javadocs/bukkit/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.

### Returns
- The buffer in X and Z direction (int)
```

--------------------------------

### Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/file/FileConfigurationOptions.html

Initializes FileConfigurationOptions with a given MemoryConfiguration.

```APIDOC
## Constructor FileConfigurationOptions

### Description
Initializes a new instance of the `FileConfigurationOptions` class.

### Parameters
* `configuration` (@NotNull MemoryConfiguration) - The configuration this options object is associated with.
```

--------------------------------

### getServer()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the current Server singleton instance.

```APIDOC
## getServer()

### Description
Gets the current `Server` singleton.

### Method
Static Method (Bukkit) / Method (CommandSender, Entity, JavaPlugin, Plugin)

### Endpoint
N/A (Java Method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **Server** (Server) - The current Server instance.

### Response Example
N/A
```

--------------------------------

### get

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/ConfigurationSection.html

Gets the requested Object by path.

```APIDOC
## get

### Description
Gets the requested Object by path.

### Method Signature
`Object get(String path)`

### Overloads
`Object get(String path, Object def)`
```

--------------------------------

### Get Worlds

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Bukkit.html

Gets a list of all worlds on this server.

```APIDOC
## getWorlds

### Description
Gets a list of all worlds on this server.

### Returns
- a list of worlds
```

--------------------------------

### Constructor

Source: https://hub.spigotmc.org/javadocs/bukkit/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 Command Description

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/command/Command.html

Gets a brief description of this command.

```APIDOC
## getDescription

### Description
Gets a brief description of this command.

### Returns
Description of this command
```

--------------------------------

### getPrompt()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Interface org.bukkit.packs.ResourcePack. Gets the prompt to show of the resource pack.

```APIDOC
## getPrompt()

### Description
Gets the prompt to show of the resource pack.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get World by Name

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Bukkit.html

Gets the world with the given name.

```APIDOC
## getWorld

### Description
Gets the world with the given name.

### Parameters
- `name` (String) - the name of the world to retrieve

### Returns
- a world with the given name, or null if none exists
```

--------------------------------

### getProvides()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Class org.bukkit.plugin.PluginDescriptionFile. Gives the list of other plugin APIs which this plugin provides.

```APIDOC
## getProvides()

### Description
Gives the list of other plugin APIs which this plugin provides.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get Handler List

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/entity/VillagerReputationChangeEvent.html

Gets the static handler list for VillagerReputationChangeEvent.

```APIDOC
## getHandlerList

### Description
Gets the static handler list for VillagerReputationChangeEvent.

### Returns
- **HandlerList** - The handler list for VillagerReputationChangeEvent.
```

--------------------------------

### Get All Passengers

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Entity.html

Gets a list of all entities that are passengers of this vehicle entity.

```java
List<Entity> getPassengers()
```

--------------------------------

### getLoad

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/PluginDescriptionFile.html

Gets the server startup phase at which the plugin should be loaded. This allows control over the order in which plugins are initialized.

```APIDOC
## Method Details
### 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. 
```

--------------------------------

### getModZ()

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/BlockFace.html

Get the amount of Z-coordinates to modify to get the represented block.

```APIDOC
public int getModZ()
Get the amount of Z-coordinates to modify to get the represented block

Returns:
    Amount of Z-coordinates to modify
```

--------------------------------

### getFullText(CommandSender) - IndexHelpTopic

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Returns the full description of this help topic.

```APIDOC
## getFullText(CommandSender)

### Description
Returns the full description of this help topic.

### Method
Method

### Endpoint
N/A

### Parameters
- **sender** (CommandSender) - The sender requesting the help topic details.

### Request Example
None

### Response
#### Success Response (200)
- **fullText** (String) - The full description of the help topic.

### Response Example
None
```

--------------------------------

### getModY()

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/BlockFace.html

Get the amount of Y-coordinates to modify to get the represented block.

```APIDOC
public int getModY()
Get the amount of Y-coordinates to modify to get the represented block

Returns:
    Amount of Y-coordinates to modify
```

--------------------------------

### Load Configuration from String

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/file/FileConfiguration.html

Loads the entire configuration from a string, replacing existing values. Throws exceptions for invalid input or null content.

```APIDOC
## loadFromString

### Description
Loads this `FileConfiguration` from the specified string, as opposed to from file. All the values contained within this configuration will be removed, leaving only settings and defaults, and the new values will be loaded from the given string. If the string is invalid in any way, an exception will be thrown.

### Parameters
- `contents` (String) - Contents of a Configuration to load.

### Throws
- `InvalidConfigurationException` - Thrown if the specified string is invalid.
- `IllegalArgumentException` - Thrown if contents is null.
```

--------------------------------

### getModX()

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/BlockFace.html

Get the amount of X-coordinates to modify to get the represented block.

```APIDOC
public int getModX()
Get the amount of X-coordinates to modify to get the represented block

Returns:
    Amount of X-coordinates to modify
```

--------------------------------

### startTrackingPlayer

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Force this spawner to start tracking the provided player. This is used in trial spawners to manage player tracking.

```APIDOC
## startTrackingPlayer(Player)

### Description
Force this spawner to start tracking the provided player.

### Method
`startTrackingPlayer(Player)`

### Parameters
- **player** (Player) - The player to track.

### Response
None
```

--------------------------------

### Get Center

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/WorldBorder.html

Gets the current center coordinates of the world border.

```APIDOC
## getCenter

### Description
Gets the current border center.

### Returns
- `Location`: The current border center.
```

--------------------------------

### Creating a WorldBorder

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/class-use/WorldBorder.html

Demonstrates how to create a new virtual WorldBorder using static methods available in the Bukkit API.

```APIDOC
## Creating a WorldBorder

### Description
Creates a new virtual `WorldBorder` instance.

### Methods
- `Bukkit.createWorldBorder()`
- `Server.createWorldBorder()`
```

--------------------------------

### Set Command Usage

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/command/Command.html

Sets the example usage for this command.

```APIDOC
## setUsage

### Description
Sets the example usage of this command.

### Parameters
* `usage` - new example usage

### Returns
this command object, for chaining
```

--------------------------------

### Get Size

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/WorldBorder.html

Gets the current side length of the world border.

```APIDOC
## getSize

### Description
Gets the current side length of the border.

### Returns
- `double`: The current side length of the border.
```

--------------------------------

### Get Plugin Command

Source: https://hub.spigotmc.org/javadocs/bukkit/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
- `name` (String) - the name of the command to retrieve

### Returns
- a `PluginCommand` with the given name, or null if none exists
```

--------------------------------

### ArmorTrim Constructor and Getter

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/trim/class-use/TrimMaterial.html

Demonstrates how to create an ArmorTrim using a TrimMaterial and how to retrieve the TrimMaterial from an existing ArmorTrim.

```APIDOC
## ArmorTrim Creation and Retrieval

### Description
This section covers the creation of an `ArmorTrim` object using a `TrimMaterial` and `TrimPattern`, and how to access the `TrimMaterial` from an existing `ArmorTrim`.

### Constructor
#### `ArmorTrim(TrimMaterial material, TrimPattern pattern)`
Creates a new `ArmorTrim` instance with the specified `TrimMaterial` and `TrimPattern`.

### Method
#### `TrimMaterial getMaterial()`
Retrieves the `TrimMaterial` associated with this `ArmorTrim`.
```

--------------------------------

### Get World by UUID

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Bukkit.html

Gets the world from the given Unique ID.

```APIDOC
## getWorld

### Description
Gets the world from the given Unique ID.

### Parameters
- `uid` (UUID) - a unique-id of the world to retrieve

### Returns
- a world with the given Unique ID, or null if none exists
```

--------------------------------

### ConfigurationOptions Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/class-use/ConfigurationOptions.html

Provides methods to configure options for Bukkit configurations.

```APIDOC
## copyDefaults(boolean value)

### Description
Sets if the `Configuration` should copy values from its default `Configuration` directly.

### Method
`ConfigurationOptions`

### Parameters
#### Path Parameters
- **value** (boolean) - Description: Whether to copy defaults.
```

```APIDOC
## options()

### Description
Gets the `ConfigurationOptions` for this `Configuration`.

### Method
`Configuration`

### Returns
`ConfigurationOptions` - The configuration options.
```

```APIDOC
## pathSeparator(char value)

### Description
Sets the char that will be used to separate `ConfigurationSection`s.

### Method
`ConfigurationOptions`

### Parameters
#### Path Parameters
- **value** (char) - Description: The character to use as a path separator.
```

--------------------------------

### HelpTopicFactory.createTopic

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/help/class-use/HelpTopic.html

This method accepts a command and constructs a custom HelpTopic for it, allowing for custom help topic generation.

```APIDOC
## createTopic

### Description
Creates a custom HelpTopic for a given command.

### Method Signature
`HelpTopic createTopic(TCommand command)`

### Parameters
* **command** (TCommand) - The command for which to create a HelpTopic.
```

--------------------------------

### Custom PersistentDataType Example

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/persistence/PersistentDataType.html

Example of implementing a custom PersistentDataType for UUID.

```APIDOC
## Custom Implementation Example

This example demonstrates how to create a custom `PersistentDataType` for `UUID`.

```java
public class UUIDTagType implements PersistentDataType<byte[], UUID> {

    @Override
    public Class<byte[]> getPrimitiveType() {
        return byte[].class;
    }

    @Override
    public Class<UUID> 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);
    }
}
```
```

--------------------------------

### TextDisplay and Server GameMode Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Methods for setting default background for TextDisplay and default game mode for new players.

```APIDOC
## setDefaultBackground(boolean)

### Description
Sets if the text has its default background.

### Method
Method

### Endpoint
org.bukkit.entity.TextDisplay

## setDefaultGameMode(GameMode)

### Description
Sets the default `GameMode` for new players.

### Method
Method

### Endpoint
org.bukkit.Bukkit

## setDefaultGameMode(GameMode)

### Description
Sets the default `GameMode` for new players.

### Method
Method

### Endpoint
org.bukkit.Server
```

--------------------------------

### isDancing()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets if the allay is dancing. Gets whether a parrot is dancing.

```APIDOC
## isDancing()

### Description
Gets if the allay is dancing. Gets whether a parrot is dancing.

### Method
Method in interface org.bukkit.entity.Allay

### Method
Method in interface org.bukkit.entity.Parrot
```

--------------------------------

### getFullText(CommandSender) - HelpTopic

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Returns the full description of this help topic.

```APIDOC
## getFullText(CommandSender)

### Description
Returns the full description of this help topic that is displayed when the user requests this topic's details.

### Method
Method

### Endpoint
N/A

### Parameters
- **sender** (CommandSender) - The sender requesting the help topic details.

### Request Example
None

### Response
#### Success Response (200)
- **fullText** (String) - The full description of the help topic.

### Response Example
None
```

--------------------------------

### getVehicle

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Get the vehicle that this entity is inside or get the vehicle from a VehicleEvent.

```APIDOC
## getVehicle

### Description
Get the vehicle that this entity is inside or get the vehicle from a VehicleEvent.

### Method
Method in interface org.bukkit.entity.Entity

### Method
Method in class org.bukkit.event.vehicle.VehicleEvent
```

--------------------------------

### Get Configuration Options

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/file/FileConfiguration.html

Gets the `ConfigurationOptions` 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.
```

--------------------------------

### BossBar Creation with Flags

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/boss/class-use/BarFlag.html

Demonstrates how to create a boss bar with specific flags using static methods available in the Bukkit and Server classes.

```APIDOC
## Bukkit.createBossBar

### Description
Creates a boss bar instance to display to players with specified title, color, style, and optional flags.

### Method Signature
`static BossBar Bukkit.createBossBar(String title, BarColor color, BarStyle style, BarFlag... flags)`

### Parameters
- `title` (String) - The title of the boss bar.
- `color` (BarColor) - The color of the boss bar.
- `style` (BarStyle) - The style of the boss bar.
- `flags` (BarFlag...) - An array of optional flags to apply to the boss bar.

## Bukkit.createBossBar (NamespacedKey)

### Description
Creates a boss bar instance with a unique key to display to players, including title, color, style, and optional flags.

### Method Signature
`static KeyedBossBar Bukkit.createBossBar(NamespacedKey key, String title, BarColor color, BarStyle style, BarFlag... flags)`

### Parameters
- `key` (NamespacedKey) - The unique key for the boss bar.
- `title` (String) - The title of the boss bar.
- `color` (BarColor) - The color of the boss bar.
- `style` (BarStyle) - The style of the boss bar.
- `flags` (BarFlag...) - An array of optional flags to apply to the boss bar.

## Server.createBossBar

### Description
Creates a boss bar instance to display to players using the server's implementation, with specified title, color, style, and optional flags.

### Method Signature
`BossBar Server.createBossBar(String title, BarColor color, BarStyle style, BarFlag... flags)`

### Parameters
- `title` (String) - The title of the boss bar.
- `color` (BarColor) - The color of the boss bar.
- `style` (BarStyle) - The style of the boss bar.
- `flags` (BarFlag...) - An array of optional flags to apply to the boss bar.

## Server.createBossBar (NamespacedKey)

### Description
Creates a boss bar instance with a unique key using the server's implementation, including title, color, style, and optional flags.

### Method Signature
`KeyedBossBar Server.createBossBar(NamespacedKey key, String title, BarColor color, BarStyle style, BarFlag... flags)`

### Parameters
- `key` (NamespacedKey) - The unique key for the boss bar.
- `title` (String) - The title of the boss bar.
- `color` (BarColor) - The color of the boss bar.
- `style` (BarStyle) - The style of the boss bar.
- `flags` (BarFlag...) - An array of optional flags to apply to the boss bar.
```

--------------------------------

### Get Idle Timeout

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Server.html

Gets the current idle kick timeout value in minutes.

```APIDOC
## getIdleTimeout

### Description
Gets the idle kick timeout.

### Returns
- `int`: the idle timeout in minutes
```

--------------------------------

### Compare Help Topics

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/help/HelpTopicComparator.html

Compares two HelpTopic objects for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

```APIDOC
## compare

### Description
Compares two HelpTopic objects for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

### Method
`int compare(HelpTopic lhs, HelpTopic rhs)`

### Parameters
*   **lhs** (`HelpTopic`) - The left-hand side `HelpTopic` to compare.
*   **rhs** (`HelpTopic`) - The right-hand side `HelpTopic` to compare.

### Returns
An `int` representing the comparison result.
```

--------------------------------

### Server.getHelpMap()

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/help/class-use/HelpMap.html

Retrieves the HelpMap instance from the Server object, allowing access to help topics specific to the server instance.

```APIDOC
## Server.getHelpMap()

### Description
Gets the `HelpMap` providing help topics for this server.

### Method
`HelpMap`

### Endpoint
N/A (Instance method call on a Server object)

### Parameters
None

### Response
#### Success Response
- **HelpMap** (HelpMap) - The HelpMap instance for the server.
```

--------------------------------

### Get Map by ID

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Bukkit.html

Deprecated. Magic value. Gets the map from the given item ID.

```APIDOC
## getMap

### Description
Deprecated. Magic value. Gets the map from the given item ID.

### Parameters
- `id` (int) - the id of the map to get

### Returns
- a map view if it exists, or null otherwise
```

--------------------------------

### PlayerInventory Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Method for setting boots in the player's inventory.

```APIDOC
## setBoots(ItemStack)

### Description
Put the given ItemStack into the boots slot.

### Method
N/A (Java Method Signature)

### Endpoint
N/A
```

--------------------------------

### EntityEquipment Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Methods for setting boots and their drop chance.

```APIDOC
## setBoots(ItemStack)

### Description
Sets the boots worn by the entity.

### Method
N/A (Java Method Signature)

### Endpoint
N/A

## setBoots(ItemStack, boolean)

### Description
Sets the boots worn by the entity.

### Method
N/A (Java Method Signature)

### Endpoint
N/A

## setBootsDropChance(float)

### Description
Sets the chance of the boots being dropped upon this creature's death.

### Method
N/A (Java Method Signature)

### Endpoint
N/A
```

--------------------------------

### Helper and Configuration Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/generator/ChunkGenerator.html

Utility methods for getting base height, default biome providers, and default populators.

```APIDOC
## Helper and Configuration Methods

### Description
Provides utility methods for retrieving specific world generation configurations and information.

### Methods
- `getBaseHeight(WorldInfo worldInfo, Random random, int x, int z, HeightMap heightMap)`: Returns the base height at a given coordinate, similar to `World.getHighestBlockAt`.
- `getDefaultBiomeProvider(WorldInfo worldInfo)`: Gets the default `BiomeProvider` when none is explicitly set.
- `getDefaultPopulators(World world)`: Gets a list of default `BlockPopulator`s to be applied to a world.
```

--------------------------------

### Get Boots Drop Chance

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/EntityEquipment.html

Gets the chance of the boots being dropped upon this creature's death.

```APIDOC
## getBootsDropChance

### Description
Gets the chance of the boots being dropped upon this creature's death.

### Method
`float`

### Returns
- `float` - the chance of the boots being dropped (1 for non-Mob)
```

--------------------------------

### Get Leggings Drop Chance

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/EntityEquipment.html

Gets the chance of the leggings being dropped upon this creature's death.

```APIDOC
## getLeggingsDropChance

### Description
Gets the chance of the leggings being dropped upon this creature's death.

### Method
`float`

### Returns
- `float` - the chance of the leggings being dropped (1 for non-Mob)
```

--------------------------------

### BrewingStand Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Methods for setting bottle presence and brewing time.

```APIDOC
## setBottle(int, boolean)

### Description
Set whether the stand has this bottle present.

### Method
N/A (Java Method Signature)

### Endpoint
N/A

## setBrewingTime(int)

### Description
Set the time left before brewing completes.

### Method
N/A (Java Method Signature)

### Endpoint
N/A
```

--------------------------------

### MerchantRecipe.getIngredients()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the ingredients for this recipe.

```APIDOC
## MerchantRecipe.getIngredients()

### Description
Gets the ingredients for this recipe.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **ingredients** (List<ItemStack>) - The list of ingredients for the merchant recipe.

### Response Example
None
```

--------------------------------

### Get Chestplate Drop Chance

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/EntityEquipment.html

Gets the chance of the chestplate being dropped upon this creature's death.

```APIDOC
## getChestplateDropChance

### Description
Gets the chance of the chest plate being dropped upon this creature's death.

### Method
`float`

### Returns
- `float` - the chance of the chest plate being dropped (1 for non-Mob)
```

--------------------------------

### showDemoScreen()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Shows the demo screen to the player. This screen is normally only seen in the demo version of the game. This method is part of the Player interface.

```APIDOC
## showDemoScreen()

### Description
Shows the demo screen to the player, this screen is normally only seen in the demo version of the game.

### Method
Method from org.bukkit.entity.Player interface.

### Parameters
None

### Response
None
```

--------------------------------

### ExperienceOrb Methods

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/ExperienceOrb.html

This section details the methods available for interacting with ExperienceOrbs.

```APIDOC
## getExperience

### Description
Gets how much experience is contained within this orb.

### Method
GET

### Endpoint
ExperienceOrb#getExperience

### Returns
- **int** - Amount of experience

## setExperience

### Description
Sets how much experience is contained within this orb.

### Method
SET

### Endpoint
ExperienceOrb#setExperience

### Parameters
#### Path Parameters
- **value** (int) - Required - Amount of experience
```

--------------------------------

### Get Helmet Drop Chance

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/EntityEquipment.html

Gets the chance of the helmet being dropped upon this creature's death.

```APIDOC
## getHelmetDropChance

### Description
Gets the chance of the helmet being dropped upon this creature's death.

### Method
`float`

### Returns
- `float` - the chance of the helmet being dropped (1 for non-Mob)
```

--------------------------------

### Get Entity Location

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Entity.html

Gets the current precise location of the entity in the world, including its coordinates and rotation.

```java
Location getLocation()
```

--------------------------------

### Constructors

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/configuration/file/FileConfiguration.html

Provides methods to create a FileConfiguration instance, either empty or with default values.

```APIDOC
## Constructor Details
### FileConfiguration 
public FileConfiguration()
Creates an empty `FileConfiguration` with no default values.

### FileConfiguration 
public FileConfiguration(@Nullable Configuration defaults)
Creates an empty `FileConfiguration` using the specified `Configuration` as a source for all default values.

Parameters:
    `defaults` - Default value provider
```

--------------------------------

### Get Metadata (Deprecated)

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/Block.html

Gets the metadata for this block. This method is deprecated and should not be used in modern Bukkit development.

```java
byte getData()
```

--------------------------------

### Bukkit.getRecipesFor

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/class-use/ItemStack.html

Get a list of all recipes for a given item.

```APIDOC
## Bukkit.getRecipesFor(ItemStack result)

### Description
Get a list of all recipes for a given item.

### Parameters
#### Path Parameters
- `result` (ItemStack) - The resulting ItemStack for which to find recipes.
```

--------------------------------

### getDefaults()

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Gets the source `Configuration` for this configuration.

```APIDOC
## getDefaults()

### Description
Gets the source `Configuration` for this configuration.

### Method
GET

### Endpoint
N/A (Java Method)

### Parameters
None

### Response
#### Success Response (200)
- **defaults** (Configuration) - The source configuration.
```

--------------------------------

### HelpCommand.execute Method

Source: https://hub.spigotmc.org/javadocs/bukkit/index-all.html

Executes the help command.

```APIDOC
## execute(CommandSender, String, String[]) - Method in class org.bukkit.command.defaults.HelpCommand

### Description
Executes the help command.
```

--------------------------------

### Getting and Setting Fox Type

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/class-use/Fox.Type.html

Demonstrates how to get the current type of a Fox entity and how to set a new type for it.

```APIDOC
## Fox Entity Type Manipulation

### Methods
#### `Fox.Type getFoxType()`
Gets the current type of this fox.

#### `void setFoxType(Fox.Type type)`
Sets the current type of this fox.
```

--------------------------------

### Server Access

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Bukkit.html

Methods for getting and setting the server instance.

```APIDOC
## getServer

### Description
Gets the current `Server` singleton.

### Method
`public static Server getServer()`

### Returns
Server instance being ran
```

```APIDOC
## setServer

### Description
Attempts to set the `Server` singleton. This cannot be done if the Server is already set.

### Method
`public static void setServer(@NotNull Server server)`

### Parameters
- `server` (Server) - Server instance
```

--------------------------------

### Get Entity Bounding Box

Source: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Entity.html

Gets the current bounding box of the entity, which defines its physical boundaries in the world.

```java
BoundingBox getBoundingBox()
```