Paper API

https://jd.papermc.io/paper/1.21.10
Admin
Paper API is a plugin development framework based on Bukkit, providing tools and interfaces for...
Tokens:3,675,516
Snippets:34,118
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure and Register MavenLibraryResolver

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/plugin/loader/library/impl/MavenLibraryResolver.html

Example of creating a MavenLibraryResolver, adding a dependency, and configuring a repository. This setup is necessary before registering the resolver with the plugin classpath builder.

```java
MavenLibraryResolver resolver = new MavenLibraryResolver();
resolver.addDependency(new Dependency(new DefaultArtifact("org.jooq:jooq:3.17.7"), null));
resolver.addRepository(new RemoteRepository.Builder(
    "central", "default", MavenLibraryResolver.MAVEN_CENTRAL_DEFAULT_MIRROR
).build());
```

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

### start Method

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/raytracing/PositionedRayTraceConfigurationBuilder.html

Sets the starting location for the raytrace.

```APIDOC
## start

Sets the starting location.

### Method Signature
`PositionedRayTraceConfigurationBuilder start(Location start)`

### Parameters
* `start` (Location) - The new starting location.

### Returns
* `PositionedRayTraceConfigurationBuilder` - A reference to this object.
```

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

### getUsage() - Command

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets an example usage of this command.

```APIDOC
## getUsage()

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

### Method
Method

### Class
org.bukkit.command.Command
```

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

### Example Usage of PreFlattenTagRegistrar

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/tag/PreFlattenTagRegistrar.html

An example demonstrating how to use the PreFlattenTagRegistrar within a plugin's bootstrap process.

```APIDOC
```java
 class YourBootstrapClass implements PluginBootstrap {

     public static final TagKey<ItemType> AXE_PICKAXE = ItemTypeTagKeys.create(Key.key("papermc:axe_pickaxe"));

     @Override
     public void bootstrap(BootstrapContext context) {
         final LifecycleEventManager<BootstrapContext> manager = context.getLifecycleManager();
         manager.registerEventHandler(LifecycleEvents.TAGS.preFlatten(RegistryKey.ITEM), event -> {
             final PreFlattenTagRegistrar<ItemType> registrar = event.registrar();
             registrar.setTag(AXE_PICKAXE, Set.of(
                 TagEntry.tagEntry(ItemTypeTagKeys.PICKAXES),
                 TagEntry.tagEntry(ItemTypeTagKeys.AXES)
             ));
         });
     }
 }
 ```
```

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

### Enchantment.getStartLevel

Source: https://jd.papermc.io/paper/1.21.10/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

### Endpoint
N/A (Method within Enchantment class)

### Parameters
None

### Response
#### Success Response (200)
- **startLevel** (int) - The starting level of the enchantment.
```

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

### JavaPlugin.init() (overload 2)

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/class-use/Server.html

Initializes a JavaPlugin with server, description, data folder, file, class loader, configuration, and logger.

```APIDOC
## JavaPlugin.init(Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader, @Nullable PluginMeta configuration, Logger logger)

### Description
Initializes the JavaPlugin with the provided server instance, description file, data folder, file, class loader, plugin meta configuration, and logger.

### Method
`final void`

### Endpoint
N/A (Java Method Call)

### Parameters
- **server** (`Server`) - The server instance.
- **description** (`PluginDescriptionFile`) - The plugin's description file.
- **dataFolder** (`File`) - The plugin's data folder.
- **file** (`File`) - The plugin's JAR file.
- **classLoader** (`ClassLoader`) - The class loader for the plugin.
- **configuration** (`@Nullable PluginMeta`) - The plugin's meta configuration (can be null).
- **logger** (`Logger`) - The logger for the plugin.

### Response
None

### Request Example
```java
// This method is typically called internally by the PluginLoader.
```
```

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

### isStarted()

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Get whether this raid has started.

```APIDOC
## isStarted()

### Description
Get whether this raid started.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (boolean)
- Returns `true` if the raid has started, `false` otherwise.

### Response Example
N/A
```

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

### Auto Enable on Server Start Configuration

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/datapack/DatapackRegistrar.Configurer.html

Sets whether the datapack should be automatically enabled when the server starts, even if it was previously disabled.

```APIDOC
## Method: autoEnableOnServerStart

### Description
Sets whether this pack is going to be automatically enabled on server starts even if previously disabled. Defaults to false.

### Parameters
* `autoEnableOnServerStart` (boolean) - `true` to ensure the pack is enabled on server starts.

### Returns
DatapackRegistrar.Configurer - The configurer instance for chaining.
```

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

### Timing Creation and Start

Source: https://jd.papermc.io/paper/1.21.10/co/aikar/timings/Timings.html

Methods for creating and immediately starting Timing objects, useful for try-with-resources statements in Java. These methods are deprecated and subject to removal.

```APIDOC
## ofStart

### Description
Returns a Timing object after starting it, useful for Java7 try-with-resources. `try (Timing ignored = Timings.ofStart(plugin, someName)) { // timed section }`

### Method
`public static Timing ofStart(@NotNull Plugin plugin, @NotNull String name)`

### Parameters
* `plugin` (Plugin) - Plugin to own the Timing
* `name` (String) - Name of Timing

### Returns
Timing Handler
```

```APIDOC
## ofStart

### Description
Returns a Timing object after starting it, useful for Java7 try-with-resources. `try (Timing ignored = Timings.ofStart(plugin, someName, groupHandler)) { // timed section }`

### Method
`public static Timing ofStart(@NotNull Plugin plugin, @NotNull String name, @Nullable Timing groupHandler)`

### Parameters
* `plugin` (Plugin) - Plugin to own the Timing
* `name` (String) - Name of Timing
* `groupHandler` (Timing) - Parent handler to mirror .start/stop calls to

### Returns
Timing Handler
```

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

### Dolphin.getTreasureLocation

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/class-use/Location.html

Gets the treasure Location this dolphin tries to guide players to.

```APIDOC
## Dolphin.getTreasureLocation

### Description
Gets the treasure location this dolphin tries to guide players to.

### Method Signature
`@Nullable Location getTreasureLocation()`
```

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

### HelpTopic Constructor

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/help/HelpTopic.html

Initializes a new HelpTopic instance. This is typically used by subclasses or internal Bukkit mechanisms.

```APIDOC
## HelpTopic()

### Description
Initializes a new HelpTopic instance.

### Constructor
`public HelpTopic()`
```

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

### options

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets the ConfigurationOptions for this Configuration.

```APIDOC
## options()

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

### Method
`options`

### Endpoint
`org.bukkit.configuration.Configuration`
```

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

### Getting ItemStack from Block Events

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/inventory/class-use/ItemStack.html

Examples of methods that retrieve an ItemStack from a block event.

```APIDOC
## VaultDisplayItemEvent.getDisplayItem()

### Description
Gets the item that will be displayed inside the vault.

### Method
`@Nullable ItemStack`

### Endpoint
VaultDisplayItemEvent
```

```APIDOC
## BlockDispenseEvent.getItem()

### Description
Gets the item that is being dispensed.

### Method
`@NotNull ItemStack`

### Endpoint
BlockDispenseEvent
```

```APIDOC
## BlockDamageAbortEvent.getItemInHand()

### Description
Gets the ItemStack for the item currently in the player's hand.

### Method
`@NotNull ItemStack`

### Endpoint
BlockDamageAbortEvent
```

```APIDOC
## BlockDamageEvent.getItemInHand()

### Description
Gets the ItemStack for the item currently in the player's hand.

### Method
`@NotNull ItemStack`

### Endpoint
BlockDamageEvent
```

```APIDOC
## BlockPlaceEvent.getItemInHand()

### Description
Gets the item in the player's hand when they placed the block.

### Method
`@NotNull ItemStack`

### Endpoint
BlockPlaceEvent
```

```APIDOC
## BlockCookEvent.getResult()

### Description
Gets the resultant ItemStack for this event.

### Method
`@NotNull ItemStack`

### Endpoint
BlockCookEvent
```

```APIDOC
## CrafterCraftEvent.getResult()

### Description
Gets the result for the craft.

### Method
`@NotNull ItemStack`

### Endpoint
CrafterCraftEvent
```

```APIDOC
## BlockCookEvent.getSource()

### Description
Gets the smelted ItemStack for this event.

### Method
`@NotNull ItemStack`

### Endpoint
BlockCookEvent
```

```APIDOC
## InventoryBlockStartEvent.getSource()

### Description
Gets the source ItemStack for this event.

### Method
`@NotNull ItemStack`

### Endpoint
InventoryBlockStartEvent
```

```APIDOC
## BlockShearEntityEvent.getTool()

### Description
Gets the item used to shear this entity.

### Method
`@NotNull ItemStack`

### Endpoint
BlockShearEntityEvent
```

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

### PlayerConnectionInitialConfigureEvent

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Indicates that this player is being configured for the first time.

```APIDOC
## PlayerConnectionInitialConfigureEvent

### Description
Indicates that this player is being configured for the first time, meaning that the connection will start being configured automatically.

### Constructor
`PlayerConnectionInitialConfigureEvent(PlayerConfigurationConnection)`
```

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

### Recipe Creation with Material

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/class-use/Material.html

Examples of creating different types of recipes using Material as a parameter.

```APIDOC
## Recipe Creation with Material

### Description
Methods for creating various recipe types that utilize `Material` to define their components or results.

### Methods

- `SmokingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime)`
  Creates a smoking recipe.

- `StonecuttingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source)`
  Create a Stonecutting recipe to craft the specified ItemStack.

- `TransmuteRecipe(@NotNull NamespacedKey key, @NotNull Material result, @NotNull RecipeChoice input, @NotNull RecipeChoice material)`
  Create a transmute recipe to produce a result of the specified type.
```

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

### getLimitedLifetimeTicks() - Vex

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets the number of ticks remaining until the vex will start to take damage.

```APIDOC
## getLimitedLifetimeTicks()

### Description
Gets the number of ticks remaining until the vex will start to take damage.

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

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

### HelpCommand Constructor

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/command/defaults/HelpCommand.html

Initializes a new instance of the HelpCommand class.

```APIDOC
## HelpCommand

### Description
Constructs a new HelpCommand.

### Method
`public HelpCommand()`
```

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

### Vex.hasLimitedLifetime()

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets if this vex should start to take damage once `Vex.getLimitedLifetimeTicks()` is less than or equal to 0.

```APIDOC
## Vex.hasLimitedLifetime()

### Description
Gets if this vex should start to take damage once `Vex.getLimitedLifetimeTicks()` is less than or equal to 0.

### Method
`hasLimitedLifetime()`

### Parameters
None

### Response
- **hasLimitedLifetime** (boolean) - True if the vex has a limited lifetime, false otherwise.
```

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

### Getting Lists of ItemStacks from Block Events

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/inventory/class-use/ItemStack.html

Examples of methods that return a list of ItemStacks from a block event.

```APIDOC
## BlockDispenseLootEvent.getDispensedLoot()

### Description
Gets the loot that will be dispensed.

### Method
`@NotNull List<ItemStack>`

### Endpoint
BlockDispenseLootEvent
```

```APIDOC
## BlockShearEntityEvent.getDrops()

### Description
Get an immutable list of drops for this shearing.

### Method
`@NotNull @Unmodifiable List<ItemStack>`

### Endpoint
BlockShearEntityEvent
```

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

### getExample

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Deprecated. for internal compatibility use only.

```APIDOC
## getExample()

### Description
Deprecated. for internal compatibility use only.

### Method
Method

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

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

### SimpleCommandMap.fallbackCommands

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Sets up fallback commands.

```APIDOC
## SimpleCommandMap.fallbackCommands

### Description
Sets up fallback commands.

### Method
```java
void fallbackCommands()
```
```

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

### Brewing Start Event Recipe Time

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Method to set the recipe time for a brewing start event.

```APIDOC
## BrewingStartEvent

### setRecipeBrewTime(int)

Sets the recipe time for the brewing process.
```

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

### Creating FoodProperties

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/datacomponent/item/class-use/FoodProperties.Builder.html

Static method to start building FoodProperties.

```APIDOC
## static FoodProperties.Builder food()

### Description
Creates a new FoodProperties.Builder instance to define food properties.

### Method
`FoodProperties.food`

### Returns
`FoodProperties.Builder` - A new builder instance.
```

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

### Get Iterator from Index

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/inventory/Inventory.html

Returns an iterator starting at the given index. If the index is positive, then the first call to next() will return the item at that index; if it is negative, the first call to previous will return the item at index (getSize() + index).

```APIDOC
## iterator
@NotNull @NotNull ListIterator<ItemStack> iterator(int index)

### Description
Returns an iterator starting at the given index. If the index is positive, then the first call to next() will return the item at that index; if it is negative, the first call to previous will return the item at index (getSize() + index).

### Parameters
* `index` - The index.

### Returns
An iterator.
```

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

### InventoryBlockStartEvent

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/event/block/InventoryBlockStartEvent.html

Represents an event that is called when a block with an inventory starts an operation. This includes furnaces starting to smelt, brewing stands starting to brew, and campfires starting to cook.

```APIDOC
## Class: InventoryBlockStartEvent

### Description
This event is used when a block with an inventory begins an operation. It extends `BlockEvent` and has subclasses like `BrewingStartEvent`, `CampfireStartEvent`, and `FurnaceStartSmeltEvent`.

### Methods
#### `getSource()`
- **Description**: Gets the source ItemStack that initiated the event.
- **Return Type**: `@NotNull ItemStack`

#### `getHandlers()`
- **Description**: Returns the handler list for this event.
- **Return Type**: `@NotNull HandlerList`

#### `getHandlerList()`
- **Description**: Gets the handler list for all events of this type.
- **Return Type**: `@NotNull HandlerList`

### Constructor
#### `InventoryBlockStartEvent(Block block, ItemStack source)`
- **Description**: Constructs a new InventoryBlockStartEvent.
- **Parameters**:
  - `block` (`@NotNull Block`): The block that triggered the event.
  - `source` (`@NotNull ItemStack`): The ItemStack that initiated the operation.
```

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

### getExamples

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Cannot be controlled by the server.

```APIDOC
## getExamples()

### Description
Cannot be controlled by the server.

### Method
Method

### Response
#### Success Response (List<String>)
- **List<String>** (List) - A list of examples.
```

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

### Create a JarLibrary Instance

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/plugin/loader/library/impl/JarLibrary.html

Instantiate a JarLibrary by providing the path to the JAR file. The file must exist at the specified path relative to the JVM's start directory.

```java
final JarLibrary customLibrary = new JarLibrary(Path.of("libs/custom-library-1.24.jar"));
```

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

### Get Villager Level

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Gets the level of this villager.

```APIDOC
## Method: getVillagerLevel

### Description
Gets the level of this villager.

### Method Signature
`int getVillagerLevel()`
```

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

### Creating PluginInformation

Source: https://jd.papermc.io/paper/1.21.10/com/destroystokyo/paper/event/server/class-use/GS4QueryEvent.QueryResponse.PluginInformation.html

Demonstrates how to create a new instance of PluginInformation.

```APIDOC
## static GS4QueryEvent.QueryResponse.PluginInformation of(String name, String version)

### Description
Creates a new PluginInformation instance with the specified name and version.

### Method
`static GS4QueryEvent.QueryResponse.PluginInformation of(String name, String version)`

### Parameters
#### Path Parameters
- **name** (String) - Description of the plugin.
- **version** (String) - Version of the plugin.
```

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

### Get Profession

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Gets the current profession of this villager.

```APIDOC
## Method: getProfession

### Description
Gets the current profession of this villager.

### Method Signature
`@NotNull Villager.Profession getProfession()`
```

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

### Creating and Populating BundleContents

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/datacomponent/item/class-use/BundleContents.Builder.html

Demonstrates how to create a new BundleContents builder and add individual items or a list of items to it.

```APIDOC
## static BundleContents.Builder bundleContents()

### Description
Creates a new instance of the BundleContents.Builder.

### Method
`static BundleContents.Builder`

### Code Example
```java
BundleContents.Builder builder = BundleContents.bundleContents();
```

## BundleContents.Builder add(ItemStack stack)

### Description
Adds a single item stack to the bundle contents being built.

### Method
`BundleContents.Builder`

### Parameters
- **stack** (ItemStack) - The item stack to add.

### Code Example
```java
builder.add(someItemStack);
```

## BundleContents.Builder addAll(List<ItemStack> stacks)

### Description
Adds a list of item stacks to the bundle contents being built.

### Method
`BundleContents.Builder`

### Parameters
- **stacks** (List<ItemStack>) - The list of item stacks to add.

### Code Example
```java
builder.addAll(listOfItemStacks);
```
```

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

### getServer

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/Bukkit.html

Gets the current Server singleton instance.

```APIDOC
## getServer

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

### Returns
Server instance being ran
```

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

### width()

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/configuration/file/YamlConfigurationOptions.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
GET

### Endpoint
/width

### Returns
How the max line width
```

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

### FallingBlock.getBlockState()

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Get the data of the falling block represented as a `BlockState` which includes potential NBT data that gets applied when the block gets placed on landing.

```APIDOC
## FallingBlock.getBlockState()

### Description
Get the data of the falling block represented as a `BlockState` which includes potential NBT data that gets applied when the block gets placed on landing.

### Method
GET

### Endpoint
/FallingBlock/getBlockState
```

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

### Registering a Command Lifecycle Event Handler with Handler Configuration

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/plugin/lifecycle/event/LifecycleEventManager.html

This shows the equivalent of the previous example but explicitly uses the newHandler method for creating the handler configuration.

```java
LifecycleEventHandler<RegistrarEvent<Commands>> handler = new Handler();
manager.registerEventHandler(LifecycleEvents.COMMANDS.newHandler(handler));
```

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

### Get Villager Type

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Gets the current type of this villager.

```APIDOC
## Method: getVillagerType

### Description
Gets the current type of this villager.

### Method Signature
`@NotNull Villager.Type getVillagerType()`
```

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

### Bukkit.getHelpMap()

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/help/class-use/HelpMap.html

Retrieves the HelpMap instance from the Bukkit class. This map contains all registered help topics for the server.

```APIDOC
## Bukkit.getHelpMap()

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

### Method
`static @NotNull HelpMap`

### Endpoint
N/A (Java Method Call)
```

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

### Server.Spigot Constructor

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/Server.Spigot.html

Initializes a new instance of the Server.Spigot class.

```APIDOC
## Server.Spigot Constructor

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

### Method Signature
`public Spigot()`
```

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

### Get Villager Experience

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Gets the trading experience of this villager.

```APIDOC
## Method: getVillagerExperience

### Description
Gets the trading experience of this villager.

### Method Signature
`int getVillagerExperience()`
```

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

### Get Reputation

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Get the reputation for a specific player by UUID.

```APIDOC
## Method: getReputation

### Description
Get the `reputation` for a specific player by `UUID`.

### Method Signature
`Reputation getReputation(@NotNull UUID uniqueId)`
```

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

### Constructor

Source: https://jd.papermc.io/paper/1.21.10/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 Entity Count

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/structure/Structure.html

Gets the number of entities present in the structure.

```APIDOC
## getEntityCount

### Description
Gets the number of entities in this structure.

### Returns
- The number of entities in this structure.
```

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

### startFollowing

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/entity/SchoolableFish.html

Forces this fish to follow the given fish.

```APIDOC
## startFollowing

### Description
Forces this fish to follow the given fish.

### Method
`startFollowing(SchoolableFish leader)`

### Parameters
#### Path Parameters
- **leader** (SchoolableFish) - Required - The fish to follow.
```

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

### build

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/registry/data/dialog/input/TextDialogInput.Builder.html

Finalizes the configuration and creates the TextDialogInput object.

```APIDOC
## build
@Contract(value="-> new", pure=true) TextDialogInput build()

### Description
Builds the text dialog input.

### Returns
the text dialog input
```

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

### Get Palette Count

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/structure/Structure.html

Gets the number of palettes available in this structure.

```APIDOC
## getPaletteCount

### Description
Gets the number of palettes in this structure.

### Returns
- The number of palettes in this structure.
```

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

### HelpTopic Class Overview

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/help/HelpTopic.html

HelpTopic implementations are displayed to the user when they use the /help command. Custom implementations can be simple, by setting name, shortText, and fullText, or complex by overriding all methods.

```APIDOC
## Class: HelpTopic

### Description
Abstract base class for help topics displayed via the /help command. Custom implementations can be simple or complex.

### Known Subclasses
- `GenericCommandHelpTopic`
- `IndexHelpTopic`

### Fields
- `amendedPermission` (String, protected)
- `fullText` (String, protected)
- `name` (String, protected)
- `shortText` (String, protected)

### Constructors
- `HelpTopic()`: Creates a new HelpTopic instance.
```

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

### Get Reputations

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Get all reputations for all players mapped by their unique IDs.

```APIDOC
## Method: getReputations

### Description
Get all `reputations` for all players mapped by their `unique IDs`.

### Method Signature
`@NotNull Map<UUID,Reputation> getReputations()`
```

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

### Get Translation Key

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/EntityType.html

Gets the translation key for the entity type.

```APIDOC
## translationKey

### Description
Gets the translation key.

### Returns
the translation key

### Throws
`IllegalArgumentException` - if the entity does not have a translation key (is probably a custom entity)
```

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

### Recipe Constructors with ItemStack

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/inventory/class-use/ItemStack.html

Demonstrates various recipe constructors that accept or produce ItemStacks.

```APIDOC
## Recipe Constructors Accepting ItemStack

### Description
These constructors are used to create different types of recipes, with the result often being an ItemStack.

### Constructors

**BlastingRecipe**
- `BlastingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime)`
- `BlastingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**CampfireRecipe**
- `CampfireRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime)`
- `CampfireRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**CookingRecipe**
- `CookingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime)`
- `CookingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**FurnaceRecipe**
- `FurnaceRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull Material source, float experience, int cookingTime)`
- `FurnaceRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**ShapedRecipe**
- `ShapedRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result)`

**ShapelessRecipe**
- `ShapelessRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result)`

**SmithingTransformRecipe**
- `SmithingTransformRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition)`
```

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

### create

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/registry/keys/PaintingVariantKeys.html

Creates a typed key for `Art` in the registry `minecraft:painting_variant`.

```APIDOC
## create
public static TypedKey<Art> create(Key key)

### Description
Creates a typed key for `Art` in the registry `minecraft:painting_variant`.

### Parameters
#### Path Parameters
- **key** (Key) - Required - the value's key in the registry

### Returns
- TypedKey<Art> - a new typed key
```

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

### Get Command Dispatcher

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/command/brigadier/Commands.html

Gets the underlying CommandDispatcher. Use with care.

```APIDOC
## getDispatcher
@Experimental com.mojang.brigadier.CommandDispatcher<CommandSourceStack> getDispatcher()

### Description
Gets the underlying `CommandDispatcher`. **Note:** This is a delicate API that must be used with care to ensure a consistent user experience. When registering commands, it should be preferred to use the `register methods` over directly registering to the dispatcher wherever possible. `Register methods` automatically handle command namespacing, command help, plugin association with commands, and more.

Example use cases for this method **may** include:
  * Implementing integration between an external command framework and Paper (although `register methods` should still be preferred where possible)
  * Registering new child nodes to an existing plugin command (for example an "addon" plugin to another plugin may want to do this)
  * Retrieving existing command nodes to build redirects

### Returns
the dispatcher instance
```

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

### BlockPopulator Constructor

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/generator/BlockPopulator.html

Initializes a new BlockPopulator instance.

```APIDOC
## BlockPopulator()

### Description
Initializes a new BlockPopulator.

### Constructor
`BlockPopulator()`
```

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

### Get Applicable Rail Shapes

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets all applicable shapes for a rail.

```APIDOC
## getShapes()

### Description
Gets the shapes which are applicable to this block.

### Method
Method in interface org.bukkit.block.data.Rail

### Signature
`getShapes() - Method in interface org.bukkit.block.data.Rail`
```

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

### getTo

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Get the next position.

```APIDOC
## getTo()

### Description
Get the next position.

### Method
N/A (Method Signature)

### Class
org.bukkit.event.vehicle.VehicleMoveEvent
```

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

### Get Stairs Shape

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets the value of the 'shape' property for stairs.

```APIDOC
## getShape()

### Description
Gets the value of the 'shape' property.

### Method
Method in interface org.bukkit.block.data.type.Stairs

### Signature
`getShape() - Method in interface org.bukkit.block.data.type.Stairs`
```

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

### JavaPlugin.init() (overload 1)

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/class-use/Server.html

Initializes a JavaPlugin with various server and plugin-related components.

```APIDOC
## JavaPlugin.init(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader)

### Description
Initializes the JavaPlugin with the provided loader, server instance, description file, data folder, file, and class loader.

### Method
`final void`

### Endpoint
N/A (Java Method Call)

### Parameters
- **loader** (`PluginLoader`) - The plugin loader.
- **server** (`Server`) - The server instance.
- **description** (`PluginDescriptionFile`) - The plugin's description file.
- **dataFolder** (`File`) - The plugin's data folder.
- **file** (`File`) - The plugin's JAR file.
- **classLoader** (`ClassLoader`) - The class loader for the plugin.

### Response
None

### Request Example
```java
// This method is typically called internally by the PluginLoader.
```
```

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

### Experience and Recipe Methods

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/HumanEntity.html

Methods related to player experience and recipe discovery.

```APIDOC
## getExpToLevel

### Description
Get the total amount of experience required for the player to level.

### Returns
Experience required to level up

## discoverRecipe

### Description
Discover a recipe for this player such that it has not already been discovered. This method will add the key's associated recipe to the player's recipe book.

### Parameters
- `recipe` (NamespacedKey) - the key of the recipe to discover

### Returns
whether or not the recipe was newly discovered

## discoverRecipes

### Description
Discover a collection of recipes for this player such that they have not already been discovered. This method will add the keys' associated recipes to the player's recipe book. If a recipe in the provided collection has already been discovered, it will be silently ignored.

### Parameters
- `recipes` (Collection<NamespacedKey>) - A collection of recipe keys to discover.

### Returns
The number of recipes that were newly discovered.
```

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

### Get Sign Side

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets which side of the sign was edited or clicked.

```APIDOC
## getSide()

### Description
Gets which side of the sign was edited.

### Method
Method in class io.papermc.paper.event.packet.UncheckedSignChangeEvent

### Signature
`getSide() - Method in class io.papermc.paper.event.packet.UncheckedSignChangeEvent`

---

### Description
Gets which side of the sign was clicked.

### Method
Method in class io.papermc.paper.event.player.PlayerOpenSignEvent

### Signature
`getSide() - Method in class io.papermc.paper.event.player.PlayerOpenSignEvent`

---

### Description
Gets the side of the sign that the command originated from.

### Method
Method in class io.papermc.paper.event.player.PlayerSignCommandPreprocessEvent

### Signature
`getSide() - Method in class io.papermc.paper.event.player.PlayerSignCommandPreprocessEvent`

---

### Description
Returns which side is changed.

### Method
Method in class org.bukkit.event.block.SignChangeEvent

### Signature
`getSide() - Method in class org.bukkit.event.block.SignChangeEvent`

---

### Description
Deprecated.
Gets side of the sign opened.

### Method
Method in class org.bukkit.event.player.PlayerSignOpenEvent

### Signature
`getSide() - Method in class org.bukkit.event.player.PlayerSignOpenEvent`

### Deprecated
Deprecated.
```

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

### Get Rail Shape

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Gets the value of the 'shape' property for a rail.

```APIDOC
## getShape()

### Description
Gets the value of the 'shape' property.

### Method
Method in interface org.bukkit.block.data.Rail

### Signature
`getShape() - Method in interface org.bukkit.block.data.Rail`
```

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

### ServerBuildInfo.asString Method

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/class-use/ServerBuildInfo.StringRepresentation.html

Creates a string representation of the server build information using a specified representation.

```APIDOC
## ServerBuildInfo.asString(ServerBuildInfo.StringRepresentation representation)

### Description
Creates a string representation of the server build information.

### Method
`String`

### Parameters
#### Path Parameters
- **representation** (ServerBuildInfo.StringRepresentation) - The representation to use for the server build information.
```

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

### Get Translation Key

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/GameRule.html

Gets the translation key for the GameRule, useful for localization.

```APIDOC
## translationKey

### Description
Gets the translation key.

### Method Signature
`@NotNull public @NotNull String translationKey()`

### Returns
- `String` - The translation key for this GameRule.
```

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

### Server Configuration and State

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/Bukkit.html

Methods for getting and setting server-wide configurations like Nether and whitelist status, and checking player IP logging.

```APIDOC
## getAllowEnd
### Description
Gets whether this server allows the End dimension.
### Method
public static boolean getAllowEnd()
### Returns
whether this server allows the End dimension
```

```APIDOC
## getAllowNether
### Description
Gets whether this server allows the Nether dimension.
### Method
public static boolean getAllowNether()
### Returns
whether this server allows the Nether dimension
```

```APIDOC
## isLoggingIPs
### Description
Gets whether the server is logging the IP addresses of players.
### Method
public static boolean isLoggingIPs()
### Returns
whether the server is logging the IP addresses of players
```

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

### Custom PersistentDataType Example

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/persistence/PersistentDataType.html

An example demonstrating how to implement a custom PersistentDataType for UUIDs.

```APIDOC
## Custom Implementation Example

```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);
    }
}
```
```

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

### RecipeChoice Creation and Usage

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/inventory/class-use/RecipeChoice.html

Demonstrates creating and using RecipeChoice instances for different recipe types.

```APIDOC
## RecipeChoice Methods

### `static RecipeChoice createPredicateChoice(Predicate<? super ItemStack> stackPredicate)`

**Description**: Creates a `RecipeChoice` based on a Predicate.

### `RecipeChoice getIngredient()`

**Description**: Gets the ingredient in the top slot of the brewing stand.

### `RecipeChoice getInput()`

**Description**: Gets the input for the bottom 3 slots in the brewing stand.

### `static RecipeChoice empty()`

**Description**: Creates an "empty" recipe choice.

### `RecipeChoice clone()`

**Description**: Creates a copy of the RecipeChoice.

### `RecipeChoice validate(boolean allowEmptyRecipes)`

**Description**: Validates the RecipeChoice.

## RecipeChoice Constructors and Usage in Recipes

### `ShapelessRecipe addIngredient(@NotNull RecipeChoice ingredient)`

**Description**: Adds an ingredient to a ShapelessRecipe.

### `ShapelessRecipe removeIngredient(@NotNull RecipeChoice ingredient)`

**Description**: Removes an ingredient from a ShapelessRecipe.

### `ShapedRecipe setIngredient(char key, @NotNull RecipeChoice ingredient)`

**Description**: Sets the `RecipeChoice` that a character in the recipe shape refers to.

### `CookingRecipe setInputChoice(@NotNull RecipeChoice input)`

**Description**: Sets the input of this cooking recipe.

### `FurnaceRecipe setInputChoice(@NotNull RecipeChoice input)`

**Description**: Sets the input choice for a FurnaceRecipe.

### `StonecuttingRecipe setInputChoice(@NotNull RecipeChoice input)`

**Description**: Sets the input of this Stonecutting recipe.

### `BlastingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**Description**: Constructor for BlastingRecipe.

### `CampfireRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**Description**: Constructor for CampfireRecipe.

### `CookingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**Description**: Creates a cooking recipe to craft the specified ItemStack.

### `FurnaceRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice input, float experience, int cookingTime)`

**Description**: Create a furnace recipe to craft the specified ItemStack.

### `SmithingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @Nullable RecipeChoice base, @Nullable RecipeChoice addition)`

**Description**: Deprecated constructor for SmithingRecipe.

### `SmithingRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @Nullable RecipeChoice base, @Nullable RecipeChoice addition, boolean copyDataComponents)`

**Description**: Deprecated constructor for SmithingRecipe.

## RecipeChoice Implementations

### `static class RecipeChoice.ExactChoice`

**Description**: Represents a choice that will be valid only if one of the stacks is exactly matched (aside from stack size).

### `static class RecipeChoice.MaterialChoice`

**Description**: Represents a choice of multiple matching Materials.

## RecipeChoice Usage in Other Recipes

### `SmithingRecipe getAddition()`

**Description**: Get the addition recipe item.

### `SmithingRecipe getBase()`

**Description**: Get the base recipe item.

### `TransmuteRecipe getInput()`

**Description**: Gets the input material, which will be transmuted.

### `CookingRecipe getInputChoice()`

**Description**: Get the input choice.

### `StonecuttingRecipe getInputChoice()`

**Description**: Get the input choice.

### `TransmuteRecipe getMaterial()`

**Description**: Gets the additional material required to cause the transmutation.

### `SmithingTransformRecipe getTemplate()`

**Description**: Get the template recipe item.

### `SmithingTrimRecipe getTemplate()`

**Description**: Get the template recipe item.

### `List<RecipeChoice> getChoiceList()`

**Description**: Get a list of RecipeChoices.

### `Map<Character, RecipeChoice> getChoiceMap()`

**Description**: Get a copy of the choice map.
```

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

### getModY

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

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

```APIDOC
## getModY

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

### Method
`BlockFace.getModY()`

### Returns
`int` - The Y-coordinate modification value.
```

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

### Bukkit and Server Methods

Source: https://jd.papermc.io/paper/1.21.10/index-all.html

Methods for setting the default game mode.

```APIDOC
## setDefaultGameMode

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

### Method
`setDefaultGameMode(GameMode)`

### Endpoint
`org.bukkit.Bukkit` (static method)
`org.bukkit.Server` (interface method)
```

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

### Server.getHelpMap()

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/help/class-use/HelpMap.html

Retrieves the HelpMap instance from the Server interface. This map contains all registered help topics for the server.

```APIDOC
## Server.getHelpMap()

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

### Method
`@NotNull HelpMap`

### Endpoint
N/A (Java Method Call)
```

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

### Deprecated Get Locale

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Player.html

Deprecated method to get the player's current locale.

```APIDOC
## getLocale

### Description
Deprecated. in favour of `locale()`
Gets the player's current locale. The value of the locale String is not defined properly. The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.

### Method
`getLocale()`

### Returns
- the player's locale
```

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

### Get Restocks Today

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/entity/Villager.html

Gets the amount of times a villager has restocked their trades today.

```APIDOC
## Method: getRestocksToday

### Description
Gets the amount of times a villager has restocked their trades today.

### Method Signature
`int getRestocksToday()`
```

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

### Constructors

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/command/Command.html

Constructors for creating new Command instances.

```APIDOC
## Command (name)

### Description
Protected constructor for creating a Command with a name.

### Method
`protected Command(@NotNull String name)`
```

```APIDOC
## Command (name, description, usageMessage, aliases)

### Description
Protected constructor for creating a Command with a name, description, usage message, and aliases.

### Method
`protected Command(@NotNull String name, @NotNull String description, @NotNull String usageMessage, @NotNull List<String> aliases)`
```

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

### Get Structures in Chunk

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/World.html

Gets all generated structures that intersect the chunk at the given coordinates.

```APIDOC
## getStructures

### Description
Gets all generated structures that intersect the chunk at the given coordinates.

### Parameters
* `x` (int) - X-coordinate of the chunk
* `z` (int) - Z-coordinate of the chunk

### Returns
* `Collection<GeneratedStructure>` - a collection of placed structures in the chunk at the given coordinates
```

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

### create

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/MusicInstrument.html

Creates an inlined music instrument.

```APIDOC
## create

Creates an inlined music instrument.

### Method
`static MusicInstrument`

### Parameters
- `value` (Consumer<RegistryBuilderFactory<MusicInstrument,? extends InstrumentRegistryEntry.Builder>>) - The consumer to build the instrument.

### Returns
A new `MusicInstrument` instance.
```

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

### setServer

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/Bukkit.html

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

```APIDOC
## setServer

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

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

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

### TypedKey Creation Examples

Source: https://jd.papermc.io/paper/1.21.10/io/papermc/paper/registry/class-use/TypedKey.html

Examples of creating TypedKey instances for different registry types.

```APIDOC
## GameEvent Key Creation
### Description
Creates a typed key for `GameEvent` in the registry `minecraft:game_event`.
### Method Signature
`static TypedKey<GameEvent> GameEventKeys.create(Key key)`
```

```APIDOC
## MusicInstrument Key Creation
### Description
Creates a typed key for `MusicInstrument` in the registry `minecraft:instrument`.
### Method Signature
`static TypedKey<MusicInstrument> InstrumentKeys.create(Key key)`
```

```APIDOC
## JukeboxSong Key Creation
### Description
Creates a typed key for `JukeboxSong` in the registry `minecraft:jukebox_song`.
### Method Signature
`static TypedKey<JukeboxSong> JukeboxSongKeys.create(Key key)`
```

```APIDOC
## Art Key Creation
### Description
Creates a typed key for `Art` in the registry `minecraft:painting_variant`.
### Method Signature
`static TypedKey<Art> PaintingVariantKeys.create(Key key)`
```

```APIDOC
## Pig.Variant Key Creation
### Description
Creates a typed key for `Pig.Variant` in the registry `minecraft:pig_variant`.
### Method Signature
`static TypedKey<Pig.Variant> PigVariantKeys.create(Key key)`
```

```APIDOC
## Structure Key Creation
### Description
Creates a typed key for `Structure` in the registry `minecraft:worldgen/structure`.
### Method Signature
`static TypedKey<Structure> StructureKeys.create(Key key)`
```

```APIDOC
## TrimMaterial Key Creation
### Description
Creates a typed key for `TrimMaterial` in the registry `minecraft:trim_material`.
### Method Signature
`static TypedKey<TrimMaterial> TrimMaterialKeys.create(Key key)`
```

```APIDOC
## TrimPattern Key Creation
### Description
Creates a typed key for `TrimPattern` in the registry `minecraft:trim_pattern`.
### Method Signature
`static TypedKey<TrimPattern> TrimPatternKeys.create(Key key)`
```

```APIDOC
## Wolf.SoundVariant Key Creation
### Description
Creates a typed key for `Wolf.SoundVariant` in the registry `minecraft:wolf_sound_variant`.
### Method Signature
`static TypedKey<Wolf.SoundVariant> WolfSoundVariantKeys.create(Key key)`
```

```APIDOC
## Wolf.Variant Key Creation
### Description
Creates a typed key for `Wolf.Variant` in the registry `minecraft:wolf_variant`.
### Method Signature
`static TypedKey<Wolf.Variant> WolfVariantKeys.create(Key key)`
```

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

### BoundingBox Creation and Manipulation with Location

Source: https://jd.papermc.io/paper/1.21.10/org/bukkit/class-use/Location.html

Demonstrates static methods for creating BoundingBox instances using Location objects and instance methods for shifting and expanding BoundingBox to include a Location.

```APIDOC
## BoundingBox.of(@NotNull Location center, double x, double y, double z)

### Description
Creates a new bounding box using the given center and extents.

### Method
`static @NotNull BoundingBox`

### Parameters
- **center** (`@NotNull Location`) - The center point of the bounding box.
- **x** (`double`) - The extent of the bounding box along the X-axis.
- **y** (`double`) - The extent of the bounding box along the Y-axis.
- **z** (`double`) - The extent of the bounding box along the Z-axis.

## BoundingBox.of(@NotNull Location corner1, @NotNull Location corner2)

### Description
Creates a new bounding box using the coordinates of the given locations as corners.

### Method
`static @NotNull BoundingBox`

### Parameters
- **corner1** (`@NotNull Location`) - The first corner of the bounding box.
- **corner2** (`@NotNull Location`) - The second corner of the bounding box.

## BoundingBox.shift(@NotNull Location shift)

### Description
Shifts this bounding box by the given amounts.

### Method
`@NotNull BoundingBox`

### Parameters
- **shift** (`@NotNull Location`) - The amounts to shift the bounding box by.

## BoundingBox.union(@NotNull Location position)

### Description
Expands this bounding box to contain (or border) the specified position.

### Method
`@NotNull BoundingBox`

### Parameters
- **position** (`@NotNull Location`) - The position to include in the bounding box.
```
Tokens:
Raw