Folia API

https://jd.papermc.io/folia/1.21
Admin
Folia API is a Java-based plugin development framework for Minecraft servers, extending the Bukkit...
Tokens:4,000,401
Snippets:27,967
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get and Set Command Usage

Source: https://jd.papermc.io/folia/1.21/org/bukkit/command/Command

Methods for retrieving and setting the usage string for a command. The usage string provides an example of how to correctly format and use the command, including its arguments.

```java
@NotNull public @NotNull String getUsage()
Gets an example usage of this command 

Returns:
    One or more example usages
```

```java
@NotNull public @NotNull Command setUsage(@NotNull @NotNull String usage)
Sets the example usage of this command 

Parameters:
    `usage` - new example usage 

Returns:
    this command object, for chaining
```

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

### Get Enchantment Start Level - PaperMC API

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/Enchantment

Gets the starting level for an enchantment. This defines the base level at which the enchantment can first be obtained.

```Java
abstract int
getStartLevel()
```

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

### HelpTopic Methods: buildPreamble

Source: https://jd.papermc.io/folia/1.21/org/bukkit/help/IndexHelpTopic

Constructs the introductory text (preamble) for a help topic. This method is protected and can be overridden to customize the appearance of the preamble.

```java
@NotNull protected @NotNull String buildPreamble(@NotNull @NotNull CommandSender sender)
Builds the topic preamble. Override this method to change how the index preamble looks. 
Parameters:
    sender - The command sender requesting the preamble. 
Returns:
    The topic preamble.
```

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

### Create Explorer Map with All Options

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Creates a new explorer map with all available options.

```APIDOC
## POST /maps/create/explore/all

### Description
Create a new explorer map targeting the closest nearby structure of a given `StructureType`.

### Method
POST

### Endpoint
/maps/create/explore/all

#### Request Body
- **world** (World) - Required - the world the map will belong to
- **location** (Location) - Required - the origin location to find the nearest structure
- **structureType** (StructureType) - Required - the type of structure to find
- **mapIcon** (MapCursor.Type) - Required - the map icon to use on the map
- **radius** (int) - Required - radius to search
- **findUnexplored** (boolean) - Required - whether to find unexplored structures

### Request Example
{
  "world": "world_object",
  "location": "location_object",
  "structureType": "FORTRESS",
  "mapIcon": "BLUE_CROSS",
  "radius": 150,
  "findUnexplored": true
}

### Response
#### Success Response (200)
- **itemStack** (ItemStack) - a newly created item stack or null if it can't find a location

#### Response Example
{
  "itemStack": "explorer_map_with_all_options_item"
}
```

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

### Raid Interface Methods - Java

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Raid

Provides Java code examples for various methods of the `Raid` interface, such as checking if a raid has started, getting active ticks, retrieving the Bad Omen level, setting the Bad Omen level, getting the raid location, status, spawned groups, total groups, total waves, total health, heroes, raiders, ID, and boss bar.

```java
public interface Raid extends PersistentDataHolder {
    /**
     * Gets the amount of ticks this raid has existed.
     *
     * @return active ticks
     */
    long getActiveTicks();

    /**
     * Gets the Bad Omen level of this raid.
     *
     * @return Bad Omen level (between 0 and 5)
     */
    int getBadOmenLevel();

    /**
     * Get the boss bar to be displayed for this raid.
     *
     * @return the boss bar
     */
    @NotNull BossBar getBossBar();

    /**
     * Get the UUID of all heroes in this raid.
     *
     * @return a set of unique ids
     */
    @NotNull Set<UUID> getHeroes();

    /**
     * Deprecated, for removal: This API element is subject to removal in a future version.
     * Raid identifiers are magic internal values and may or may not be present.
     * Gets the id of this raid.
     *
     * @return the raid id
     */
    @Deprecated(forRemoval=true, since="1.21.5")
    int getId();

    /**
     * Gets the center location where the raid occurs.
     *
     * @return location
     */
    @NotNull Location getLocation();

    /**
     * Gets all remaining `Raider` in the present wave.
     *
     * @return a list of current raiders
     */
    @NotNull List<Raider> getRaiders();

    /**
     * Gets the number of raider groups which have spawned.
     *
     * @return total spawned groups
     */
    int getSpawnedGroups();

    /**
     * Gets the current status of the raid.
     * Do not use this method to check if the raid has been started, call `isStarted()` instead.
     *
     * @return Raids status
     */
    @NotNull Raid.RaidStatus getStatus();

    /**
     * Gets the number of raider groups which would spawn.
     * This also includes the group which spawns in the additional wave (if present).
     *
     * @return total groups
     */
    int getTotalGroups();

    /**
     * Gets the sum of all raider's health.
     *
     * @return total raiders health
     */
    float getTotalHealth();

    /**
     * Gets the number of waves in this raid (exclude the additional wave).
     *
     * @return number of waves
     */
    int getTotalWaves();

    /**
     * Get whether this raid started.
     *
     * @return whether raid is started
     */
    boolean isStarted();

    /**
     * Sets the Bad Omen level.
     * If the level is higher than 1, there will be an additional wave that as strong as the final wave.
     *
     * @param badOmenLevel new Bad Omen level (from 0-5)
     * @throws IllegalArgumentException if invalid Bad Omen level
     */
    void setBadOmenLevel(int badOmenLevel);
}
```

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

### Get Inventory Iterator Starting at Index (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/inventory/Inventory

Returns an iterator that starts at a specified index. If the index is positive, iteration begins at that index. If negative, it starts from the end of the inventory.

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

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

### buildPreamble Method

Source: https://jd.papermc.io/folia/1.21/org/bukkit/help/IndexHelpTopic

Constructs the topic's preamble.

```APIDOC
## Method: buildPreamble

### Description
Builds the topic preamble. Override to customize the preamble's appearance.

### Method
@NotNull protected String

### Parameters
- **sender** (CommandSender) - Required - The command sender requesting the preamble.

### Returns
The topic preamble.
```

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

### Get Enchantment Start Level - Folia 1.21

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/Enchantment

Retrieves the starting level for an enchantment. This indicates the base level at which the enchantment becomes effective.

```java
/**
 * Gets the level that this Enchantment should start at 
 *
 * @return Starting level of the Enchantment
 */
public abstract int getStartLevel()
```

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

### BukkitCommand Constructor (String name, String description, String usageMessage, List<String> aliases)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/command/defaults/BukkitCommand

Protected constructor for BukkitCommand, allowing initialization with a name, description, usage message, and a list of aliases. This provides comprehensive setup for a command.

```java
protected BukkitCommand(@NotNull String name, @NotNull String description, @NotNull String usageMessage, @NotNull List<String> aliases)
```

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

### HelpTopic Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/help/IndexHelpTopic

Constructors for creating HelpTopic instances.

```APIDOC
## Constructors

### IndexHelpTopic
public IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics)

### IndexHelpTopic
public IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics, @Nullable String preamble)
```

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

### Get Enchantment Display Name - Folia 1.21

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/Enchantment

Gets the display name of an enchantment, including its applied level. The formatting of the level may vary if it falls outside the enchantment's start and max levels.

```java
/**
 * Get the name of the enchantment with its applied level. 
 * If the given `level` is either less than the `getStartLevel()` or greater than the `getMaxLevel()`, the level may not be shown in the numeral format one may otherwise expect.  
 *
 * @param level the level of the enchantment to show 
 * @return the name of the enchantment with `level` applied
 */
public abstract @NotNull Component displayName(int level)
```

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

### Get PlayerFailMoveEvent From Location (Java)

Source: https://jd.papermc.io/folia/1.21/io/papermc/paper/event/player/PlayerFailMoveEvent

Retrieves the starting location of the player's attempted movement.

```java
public Location getFrom()
Gets the location this player moved from

Returns:
    Location the player moved from
```

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

### PrepareSmithingEvent API Documentation

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/inventory/PrepareSmithingEvent

Details of the PrepareSmithingEvent, including its constructor and methods.

```APIDOC
## PrepareSmithingEvent

### Description
Called when an item is put in a slot for upgrade by a Smithing Table.

### Method
N/A (This is an event class)

### Endpoint
N/A (This is an event class)

### Constructor Summary
- **PrepareSmithingEvent** (`@NotNull InventoryView` inventory, `@Nullable ItemStack` result)
  Constructor for PrepareSmithingEvent.

### Method Summary
- `@NotNull SmithingInventory` **getInventory** ()
  Gets the primary Inventory involved in this transaction.

### Inherited Methods
- From `PrepareResultEvent`: `getResult`, `setResult`
- From `PrepareInventoryResultEvent`: `getHandlerList`, `getHandlers`
- From `InventoryEvent`: `getView`, `getViewers`
- From `Event`: `callEvent`, `getEventName`, `isAsynchronous`
- From `Object`: `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`

### Constructor Details
#### PrepareSmithingEvent
`@Internal public PrepareSmithingEvent(@NotNull @NotNull InventoryView inventory, @Nullable @Nullable ItemStack result)`

### Method Details
#### getInventory
`@NotNull public @NotNull SmithingInventory getInventory()`
Description copied from class: `InventoryEvent`
Gets the primary Inventory involved in this transaction 

Overrides:
    `getInventory` in class `InventoryEvent` 

Returns:
    The upper inventory.
```

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

### Get Time Until Bite (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/entity/FishHook

Gets the remaining ticks for a fish to bite the hook. This timer starts only when `getWaitTime()` is zero or less. A value of 1 means the fish bites next tick; 0 means it has already bitten.

```Java
@org.jetbrains.annotations.Range(from=0L, to=2147483647L)
int getTimeUntilBite()
```

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

### PlayerBucketEvent Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/player/PlayerBucketEvent

Details on the different constructors available for PlayerBucketEvent.

```APIDOC
## PlayerBucketEvent Constructor (Deprecated)

### Description
Represents a player interacting with a bucket, with deprecated parameters. Subject to removal in future versions.

### Parameters
- **player** (Player) - Required - The player involved in the event.
- **blockClicked** (Block) - Required - The block that was clicked.
- **blockFace** (BlockFace) - Required - The face of the block that was clicked.
- **bucket** (Material) - Required - The type of bucket used.
- **itemInHand** (ItemStack) - Required - The item held in the player's hand.
```

```APIDOC
## PlayerBucketEvent Constructor (Deprecated)

### Description
Represents a player interacting with a bucket, with deprecated parameters. Subject to removal in future versions.

### Parameters
- **player** (Player) - Required - The player involved in the event.
- **block** (Block) - Required - The block involved in the event.
- **blockClicked** (Block) - Required - The block that was clicked.
- **blockFace** (BlockFace) - Required - The face of the block that was clicked.
- **bucket** (Material) - Required - The type of bucket used.
- **itemInHand** (ItemStack) - Required - The item held in the player's hand.
```

```APIDOC
## PlayerBucketEvent Constructor

### Description
Represents a player interacting with a bucket.

### Parameters
- **player** (Player) - Required - The player involved in the event.
- **block** (Block) - Required - The block involved in the event.
- **blockClicked** (Block) - Required - The block that was clicked.
- **blockFace** (BlockFace) - Required - The face of the block that was clicked.
- **bucket** (Material) - Required - The type of bucket used.
- **itemInHand** (ItemStack) - Required - The item held in the player's hand.
- **hand** (EquipmentSlot) - Required - The hand used for the event.
```

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

### Enchantment Cost and Level API

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/Enchantment

Get the modified costs of an enchantment at different levels and its starting level.

```APIDOC
## GET /enchantments/cost-level

### Description
Retrieves the minimum and maximum modified costs for an enchantment at a given level, as well as its starting level.

### Method
GET

### Endpoint
/enchantments/cost-level

### Parameters
#### Query Parameters
- **enchantmentId** (string) - Required - The unique identifier for the enchantment.
- **level** (int) - Required - The level of the enchantment for which to calculate the cost.

### Request Example
```json
{
  "enchantmentId": "minecraft:protection",
  "level": 3
}
```

### Response
#### Success Response (200)
- **minModifiedCost** (int) - The minimum modified cost at the specified level.
- **maxModifiedCost** (int) - The maximum modified cost at the specified level.
- **startLevel** (int) - The starting level of the enchantment.

#### Response Example
```json
{
  "minModifiedCost": 10,
  "maxModifiedCost": 15,
  "startLevel": 1
}
```
```

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

### Configuration and Settings

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Accessing and modifying server configurations.

```APIDOC
## GET /server/disabled-packs

### Description
Gets the list of initially disabled datapacks.

### Method
GET

### Endpoint
/server/disabled-packs

### Response
#### Success Response (200)
- **packs** (List<String>) - A list of initially disabled datapack IDs.

#### Response Example
{
  "packs": ["disabled_pack_1", "disabled_pack_2"]
}

## GET /server/enabled-packs

### Description
Gets the list of initially enabled datapacks.

### Method
GET

### Endpoint
/server/enabled-packs

### Response
#### Success Response (200)
- **packs** (List<String>) - A list of initially enabled datapack IDs.

#### Response Example
{
  "packs": ["enabled_pack_1", "enabled_pack_2"]
}

## GET /server/ipbans

### Description
Gets a set containing all current IPs that are banned.

### Method
GET

### Endpoint
/server/ipbans

### Response
#### Success Response (200)
- **ips** (Set<String>) - A set of banned IP addresses.

#### Response Example
{
  "ips": ["192.168.1.100", "10.0.0.5"]
}

## GET /server/max-chained-neighbor-updates

### Description
Gets the amount of consecutive neighbor updates before skipping additional ones.

### Method
GET

### Endpoint
/server/max-chained-neighbor-updates

### Response
#### Success Response (200)
- **maxUpdates** (int) - The maximum number of consecutive neighbor updates.

#### Response Example
{
  "maxUpdates": 1000
}

## GET /server/pause-when-empty-time

### Description
Gets the pause when empty threshold in seconds.

### Method
GET

### Endpoint
/server/pause-when-empty-time

### Response
#### Success Response (200)
- **pauseTime** (int) - The pause when empty threshold in seconds.

#### Response Example
{
  "pauseTime": 60
}

## GET /server/monster-spawn-limit

### Description
Gets the monster spawn limit. Deprecated in favor of `getSpawnLimit(SpawnCategory)`.

### Method
GET

### Endpoint
/server/monster-spawn-limit

### Response
#### Success Response (200)
- **limit** (int) - The monster spawn limit.

#### Response Example
{
  "limit": 70
}

```

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

### Get Origin Location

Source: https://jd.papermc.io/folia/1.21/io/papermc/paper/event/world/StructuresLocateEvent

Retrieves the starting Location for the structure search. This method returns the Location object from which the search is conducted.

```java
public Location getOrigin()
Gets the `Location` from which the search is to be conducted.
```

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

### SimpleCommandMap Constructor Summary (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/command/SimpleCommandMap

Details the constructors for the SimpleCommandMap class, specifically the one that accepts a server instance and a backing map. This constructor is used to initialize the command map.

```java
SimpleCommandMap(@NotNull Server server,
Map<String,Command> backing)
```

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

### Get Server Tick Number

Source: https://jd.papermc.io/folia/1.21/com/destroystokyo/paper/event/server/ServerTickStartEvent

Retrieves the current tick number since the server started. The first tick is numbered 1.

```java
public int getTickNumber()
```

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

### init Method Details

Source: https://jd.papermc.io/folia/1.21/io/papermc/paper/plugin/provider/classloader/ConfiguredPluginClassLoader

Details for the init method of ConfiguredPluginClassLoader. This method initializes the classloader and links it with the provided JavaPlugin instance, intended for a single-time setup call.

```Java
void init(JavaPlugin plugin)
/*
Initializes both this configured plugin class loader and the java plugin passed to link to each other. This logic is to be called exactly once when the initial setup between the class loader and the instantiated `JavaPlugin` is loaded.

Parameters:
    `plugin` - the `JavaPlugin` that should be interlinked with this class loader.
*/
```

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

### Get Plugin Manager - Java

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Obtains the PluginManager instance, which allows interaction with installed plugins. Returns a non-null PluginManager.

```java
PluginManager pluginManager = Server.getPluginManager();
```

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

### AsyncPlayerPreLoginEvent Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/player/AsyncPlayerPreLoginEvent

Provides details on the various constructors available for the AsyncPlayerPreLoginEvent, allowing for different levels of initialization based on player data.

```APIDOC
## AsyncPlayerPreLoginEvent Constructors

### Constructor 1
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with player name and IP address.
**@Internal**
**@Deprecated(since="1.7.5", forRemoval=true)**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.

### Constructor 2
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with player name, IP address, and unique ID.
**@Internal**
**@Deprecated(since="1.20.5", forRemoval=true)**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.
- `uniqueId` (UUID) - Required - The unique identifier of the player.

### Constructor 3
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with player name, IP address, unique ID, and transfer status.
**@Internal**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.
- `uniqueId` (UUID) - Required - The unique identifier of the player.
- `transferred` (boolean) - Required - Indicates if the player is being transferred.

### Constructor 4
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with player name, IP address, unique ID, transfer status, and player profile.
**@Internal**
**@Deprecated(forRemoval=true)**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.
- `uniqueId` (UUID) - Required - The unique identifier of the player.
- `transferred` (boolean) - Required - Indicates if the player is being transferred.
- `profile` (PlayerProfile) - Required - The profile of the player.

### Constructor 5
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with player name, IP addresses, unique ID, transfer status, and player profile.
**@Internal**
**@Deprecated(forRemoval=true)**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.
- `rawAddress` (InetAddress) - Required - The raw IP address of the player.
- `uniqueId` (UUID) - Required - The unique identifier of the player.
- `transferred` (boolean) - Required - Indicates if the player is being transferred.
- `profile` (PlayerProfile) - Required - The profile of the player.

### Constructor 6
**Description**: Initializes a new instance of the `AsyncPlayerPreLoginEvent` class with all relevant player login details.
**@Internal**
**Parameters**:
- `name` (String) - Required - The name of the player.
- `ipAddress` (InetAddress) - Required - The IP address of the player.
- `rawAddress` (InetAddress) - Required - The raw IP address of the player.
- `uniqueId` (UUID) - Required - The unique identifier of the player.
- `transferred` (boolean) - Required - Indicates if the player is being transferred.
- `profile` (PlayerProfile) - Required - The profile of the player.
- `hostname` (String) - Required - The hostname of the player's connection.
```

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

### Bukkit API: Getting Chunks by Location and Coordinates

Source: https://jd.papermc.io/folia/1.21/org/bukkit/class-use/Chunk

Provides Java examples for retrieving Chunk objects using various methods within the Bukkit API. This includes getting chunks by Location, integer coordinates (with and without generation), and chunk keys.

```Java
Location.getChunk()
World.getChunkAt(int x, int z)
World.getChunkAt(int x, int z, boolean generate)
World.getChunkAt(long chunkKey)
World.getChunkAt(long chunkKey, boolean generate)
World.getChunkAt(Location location)
World.getChunkAt(Block block)
```

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

### HelpTopic Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/help/IndexHelpTopic

Provides constructors for initializing HelpTopic objects. The constructors allow setting the name, short text, permission, topics collection, and an optional preamble.

```java
public IndexHelpTopic(@NotNull @NotNull String name, @Nullable @Nullable String shortText, @Nullable @Nullable String permission, @NotNull @NotNull Collection<HelpTopic> topics)
public IndexHelpTopic(@NotNull @NotNull String name, @Nullable @Nullable String shortText, @Nullable @Nullable String permission, @NotNull @NotNull Collection<HelpTopic> topics, @Nullable @Nullable String preamble)
```

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

### RegexPrompt Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/conversations/RegexPrompt

Details on how to instantiate a RegexPrompt.

```APIDOC
## POST /RegexPrompt/Constructors

### Description
Constructors for the RegexPrompt class.

### Method
POST

### Endpoint
/RegexPrompt/Constructors

### Parameters
#### Request Body
- **regex** (String) - Required - The regular expression pattern.
- **pattern** (Pattern) - Required - The compiled regular expression pattern.

### Request Example
```json
{
  "regex": "^[a-zA-Z]+$"
}
```
```json
{
  "pattern": "java.util.regex.Pattern@12345678"
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation of constructor usage.

#### Response Example
```json
{
  "message": "RegexPrompt created successfully."
}
```
```

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

### Accessing Player and Drops (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/entity/PlayerDeathEvent

Examples of how to get the Player entity involved in the event and access the list of items the player dropped.

```java
@NotNull Player player = event.getPlayer();
```

```java
@NotNull List<ItemStack> drops = event.getDrops();
```

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

### Get Furnace Start Smelt Event Recipe (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/inventory/class-use/CookingRecipe

Retrieves the FurnaceRecipe associated with a FurnaceStartSmeltEvent. This method is part of the org.bukkit.event.inventory package.

```java
@NotNull CookingRecipe<?> FurnaceStartSmeltEvent.getRecipe()
```

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

### Initialize Plugin

Source: https://jd.papermc.io/folia/1.21/org/bukkit/plugin/java/JavaPlugin

Initializes the plugin with its `PluginLoader`, `Server` instance, `PluginDescriptionFile`, data folder, plugin file, and `ClassLoader`. This method is part of the plugin lifecycle management.

```java
public final void init(PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader)
```

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

### Command Constructor Summary

Source: https://jd.papermc.io/folia/1.21/org/bukkit/command/Command

Details the constructors available for the Command class, used for initializing command objects.

```APIDOC
## Command Constructors

### Constructor Summary

- `protected Command(@NotNull String name)` - Creates a new Command with a given name.
- `protected Command(@NotNull String name, @NotNull String description, @NotNull String usageMessage, @NotNull List<String> aliases)` - Creates a new Command with a name, description, usage message, and aliases.
```

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

### Accessing Target BlockType Key

Source: https://jd.papermc.io/folia/1.21/org/bukkit/block/class-use/BlockType

Provides an example of how to get the BlockType key for a target block. This demonstrates the use of the `BlockTypeKeys` enum for block identification.

```java
static final TypedKey<BlockType>
BlockTypeKeys.`TARGET`
`minecraft:target`
```

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

### Get Spigot Configuration (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/configuration/file/class-use/YamlConfiguration

Provides an example of fetching the Spigot-specific configuration. This method is marked for deprecation and potential removal in subsequent versions.

```Java
YamlConfiguration spigotConfig = Server.Spigot.getSpigotConfig();
```

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

### getFullText Method

Source: https://jd.papermc.io/folia/1.21/org/bukkit/help/IndexHelpTopic

Retrieves the full, paginated description of the help topic.

```APIDOC
## Method: getFullText

### Description
Returns the full description of this help topic, paginated for the user's client.

### Method
@NotNull public String

### Parameters
- **sender** (CommandSender) - Required - The player or console requesting the text, used for potential sub-permission security trimming.

### Returns
A full topic description.
```

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

### Get Player Movement From Location

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/player/PlayerMoveEvent

Retrieves the location from which the player initiated their movement. This is a core method for understanding the starting point of a move event.

```java
@NotNull public @NotNull Location getFrom()
Gets the location this player moved from
```

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

### SmithingTransformRecipe Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/inventory/SmithingTransformRecipe

Details on how to create a SmithingTransformRecipe.

```APIDOC
## SmithingTransformRecipe Constructors

### Description
Provides methods to create a smithing transform recipe.

### Constructor 1: SmithingTransformRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition)

#### Description
Create a smithing recipe to produce the specified result ItemStack.

#### Parameters
- **key** (NamespacedKey) - Required - The unique recipe key
- **result** (ItemStack) - Required - The item you want the recipe to create.
- **template** (RecipeChoice) - Required - The template item (`RecipeChoice.empty()` can be used)
- **base** (RecipeChoice) - Required - The base ingredient (`RecipeChoice.empty()` can be used)
- **addition** (RecipeChoice) - Required - The addition ingredient (`RecipeChoice.empty()` can be used)

### Constructor 2: SmithingTransformRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result, @NotNull RecipeChoice template, @NotNull RecipeChoice base, @NotNull RecipeChoice addition, boolean copyDataComponents)

#### Description
Create a smithing recipe to produce the specified result ItemStack, with an option to copy data components.

#### Parameters
- **key** (NamespacedKey) - Required - The unique recipe key
- **result** (ItemStack) - Required - The item you want the recipe to create.
- **template** (RecipeChoice) - Required - The template item (`RecipeChoice.empty()` can be used)
- **base** (RecipeChoice) - Required - The base ingredient (`RecipeChoice.empty()` can be used)
- **addition** (RecipeChoice) - Required - The addition ingredient (`RecipeChoice.empty()` can be used)
- **copyDataComponents** (boolean) - Required - Whether to copy the data components from the input base item to the output.
```

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

### EntityTeleportEvent - Get From Location - PaperMC Folia 1.21

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/entity/EntityTeleportEvent

Retrieves the starting location from which the entity was teleported. This method is part of the EntityTeleportEvent and returns a non-null Location object.

```java
@NotNull public @NotNull Location getFrom()
Gets the location that this entity moved from
```

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

### Create SimpleCommandMap

Source: https://jd.papermc.io/folia/1.21/org/bukkit/class-use/Server

Constructs a SimpleCommandMap with a given server instance.

```APIDOC
## POST SimpleCommandMap(...)

### Description
Constructs a `SimpleCommandMap` with a given server instance.

### Method
POST

### Endpoint
SimpleCommandMap(org.bukkit.Server server, Map<String,Command> backing)

### Parameters
#### Request Body
- **server** (org.bukkit.Server) - Required - The server instance.
- **backing** (Map<String, org.bukkit.command.Command>) - Required - The backing map of commands.

### Request Example
{
  "server": "org.bukkit.Server",
  "backing": {
    "commandName": "org.bukkit.command.Command"
  }
}

### Response
#### Success Response (200)
- **SimpleCommandMap** (org.bukkit.command.SimpleCommandMap) - The created SimpleCommandMap.

#### Response Example
{
  "example": "org.bukkit.command.SimpleCommandMap"
}
```

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

### Get Initial Enabled Packs - Java

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Fetches a list of datapack names that are initially enabled when the server starts. Returns a non-null list of strings.

```java
List<String> enabledPacks = Server.getInitialEnabledPacks();
```

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

### SpawnerEntry Constructors (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/block/spawner/SpawnerEntry

Provides the constructors for the SpawnerEntry class. The first constructor initializes with an entity snapshot, spawn weight, and spawn rule. The second constructor additionally allows setting equipment.

```java
public SpawnerEntry(@NotNull @NotNull EntitySnapshot snapshot, int spawnWeight, @Nullable @Nullable SpawnRule spawnRule)
```

```java
public SpawnerEntry(@NotNull @NotNull EntitySnapshot snapshot, int spawnWeight, @Nullable @Nullable SpawnRule spawnRule, @Nullable @Nullable SpawnerEntry.Equipment equipment)
```

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

### Get Initial Disabled Packs - Java

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Fetches a list of datapack names that are initially disabled when the server starts. Returns a non-null list of strings.

```java
List<String> disabledPacks = Server.getInitialDisabledPacks();
```

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

### AsyncPlayerPreLoginEvent Overview

Source: https://jd.papermc.io/folia/1.21/org/bukkit/event/player/AsyncPlayerPreLoginEvent

Details and methods for handling player pre-login events asynchronously.

```APIDOC
## AsyncPlayerPreLoginEvent

### Description
Stores details for players attempting to log in. This event is asynchronous and not run on the main thread. When this event is fired, the player's locale is not available. Therefore, any translatable component will be rendered with the default locale, `Locale.US`. Consider rendering any translatable yourself with `GlobalTranslator.render(net.kyori.adventure.text.Component, java.util.Locale)` if the client's language is known.

### Nested Class Summary
- **AsyncPlayerPreLoginEvent.Result**: Basic kick reasons for communicating to plugins.

### Constructor Summary
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress)`: Deprecated, for removal.
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull InetAddress rawAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile)`: Deprecated, for removal.
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull InetAddress rawAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile, @NotNull String hostname)`
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId)`: Deprecated, for removal.
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId, boolean transferred)`
- `AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile)`: Deprecated, for removal.

### Method Summary
- **allow()**: Allows the player to log in.
- **disallow(@NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull String message)**: Deprecated, in favour of `disallow(AsyncPlayerPreLoginEvent.Result, Component)`.
- **disallow(@NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull Component message)**: Disallows the player from logging in, with the given reason.
- **disallow(PlayerPreLoginEvent.Result result, @NotNull String message)**: Deprecated. Uses a deprecated enum from `PlayerPreLoginEvent`.
- **disallow(PlayerPreLoginEvent.Result result, Component message)**: Deprecated. Uses a deprecated enum from `PlayerPreLoginEvent`.
- **getAddress()**: Gets the player IP address.
- **getHostname()**: Gets the hostname that the player used to connect to the server, or blank if unknown.
- **getKickMessage()**: Deprecated, in favour of `kickMessage()`.
- **getLoginResult()**: Gets the current result of the login, as an enum.
- **getName()**: Gets the player's name.
- **getPlayerProfile()**: Gets the PlayerProfile of the player logging in.
- **getRawAddress()**: Gets the raw address of the player logging in.
- **getResult()**: Deprecated. Uses a deprecated enum from `PlayerPreLoginEvent`.
- **getUniqueId()**: Gets the player's unique ID.
- **isTransferred()**: Gets if this connection has been transferred from another server.
- **kickMessage()**: Gets the current kick message that will be used when the outcome is not allowed.
- **kickMessage(@NotNull Component message)**: Sets the kick message to display when the outcome is not allowed.
- **setKickMessage(@NotNull String message)**: Deprecated, in favour of `kickMessage(Component)`.
- **setLoginResult(@NotNull AsyncPlayerPreLoginEvent.Result result)**: Sets the new result of the login, as an enum.
- **setPlayerProfile(PlayerProfile profile)**: Changes the PlayerProfile the player will login as.
- **setResult(PlayerPreLoginEvent.Result result)**: Deprecated. Uses a deprecated enum from `PlayerPreLoginEvent`.

### Methods inherited from class org.bukkit.event.Event
`callEvent, getEventName, isAsynchronous`
```

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

### Get Enchantment Description (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/Enchantment

Provides the description of this enchantment entry as displayed to the client. For example, "Sharpness" for the sharpness enchantment.

```java
public abstract @NotNull Component description()
```

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

### Command Method Summary

Source: https://jd.papermc.io/folia/1.21/org/bukkit/command/Command

An exhaustive list of methods available in the Command class for managing and executing commands.

```APIDOC
## Command Methods

### Method Summary

**Execution:**
- `abstract boolean execute(@NotNull CommandSender sender, @NotNull String commandLabel, @NotNull String[] args)` - Executes the command logic.

**Information Retrieval:**
- `@NotNull List<String> getAliases()` - Gets the list of aliases for the command.
- `@NotNull String getDescription()` - Gets the description of the command.
- `@NotNull String getLabel()` - Gets the label of the command.
- `@NotNull String getName()` - Gets the name of the command.
- `@Nullable String getPermission()` - Gets the permission required for the command.
- `@NotNull String getUsage()` - Gets the usage example for the command.

**Tab Completion:**
- `@NotNull List<String> tabComplete(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args)` - Provides tab completion suggestions.
- `@NotNull List<String> tabComplete(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args, @Nullable Location location)` - Provides tab completion suggestions with location context.

**Permission Management:**
- `boolean canBeOverriden()` - Checks if the command can be overridden.
- `boolean testPermission(@NotNull CommandSender target)` - Tests if a sender has permission.
- `boolean testPermissionSilent(@NotNull CommandSender target)` - Tests if a sender has permission silently.
- `void setPermission(@Nullable String permission)` - Sets the permission for the command.

**Registration & State:**
- `boolean isRegistered()` - Checks if the command is registered.
- `boolean register(@NotNull CommandMap commandMap)` - Registers the command to a CommandMap.

**Utility:**
- `static void broadcastCommandMessage(...)` - Broadcasts a message related to command execution.
- `@NotNull Command setAliases(@NotNull List<String> aliases)` - Sets the aliases for the command.
- `@NotNull Command setDescription(@NotNull String description)` - Sets the description for the command.
- `boolean setLabel(@NotNull String name)` - Sets the label for the command.
- `boolean setName(@NotNull String name)` - Sets the name for the command.
- `@NotNull Command setUsage(@NotNull String usage)` - Sets the usage message for the command.

*Note: Several methods related to permission messages and timings are deprecated.*
```

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

### Get Enchantments from Item Component (Java)

Source: https://jd.papermc.io/folia/1.21/org/bukkit/enchantments/class-use/Enchantment

Provides an example of retrieving all enchantments currently present on an item's enchantment component.

```java
ItemEnchantments itemEnchantments = ...; // Get the ItemEnchantments component
Map<Enchantment, Integer> currentEnchantments = itemEnchantments.enchantments();
```

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

### BoundingBox Constructors

Source: https://jd.papermc.io/folia/1.21/org/bukkit/util/BoundingBox

Provides details on how to create new BoundingBox instances.

```APIDOC
## Constructors

### BoundingBox()

Creates a new (degenerate) bounding box with all corner coordinates at `0`.

### BoundingBox(double x1, double y1, double z1, double x2, double y2, double z2)

Creates a new bounding box from the given corner coordinates.

**Parameters**:
- `x1` (double) - the first corner's x value
- `y1` (double) - the first corner's y value
- `z1` (double) - the first corner's z value
- `x2` (double) - the second corner's x value
- `y2` (double) - the second corner's y value
- `z2` (double) - the second corner's z value
```

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

### Accessing Sugar Cane BlockType Key

Source: https://jd.papermc.io/folia/1.21/org/bukkit/block/class-use/BlockType

Provides an example of how to get the BlockType key for sugar cane. This demonstrates the use of the `BlockTypeKeys` enum for block identification.

```java
static final TypedKey<BlockType>
BlockTypeKeys.`SUGAR_CANE`
`minecraft:sugar_cane`
```

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

### Accessing Stone Slab BlockType Key

Source: https://jd.papermc.io/folia/1.21/org/bukkit/block/class-use/BlockType

Provides an example of how to get the BlockType key for a stone slab. This demonstrates the use of the `BlockTypeKeys` enum for block identification.

```java
static final TypedKey<BlockType>
BlockTypeKeys.`STONE_SLAB`
`minecraft:stone_slab`
```

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

### Server Configuration

Source: https://jd.papermc.io/folia/1.21/org/bukkit/Bukkit

Retrieves various server configuration settings.

```APIDOC
## GET /api/server/config

### Description
Retrieves server configuration settings.

### Method
GET

### Endpoint
/api/server/config

### Parameters
#### None

### Response
#### Success Response (200)
- **defaultGameModeEnforced** (boolean) - Whether the default gamemode is enforced.
- **allowEnd** (boolean) - Whether the End dimension is allowed.
- **allowFlight** (boolean) - Whether flying is allowed.
- **allowNether** (boolean) - Whether the Nether dimension is allowed.
- **ambientSpawnLimit** (int) - The ambient spawn limit.
- **animalSpawnLimit** (int) - The animal spawn limit.
- **bukkitVersion** (String) - The Bukkit version.
- **commandAliases** (Map<String, String[]>) - Command aliases.

#### Response Example
```json
{
  "defaultGameModeEnforced": false,
  "allowEnd": true,
  "allowFlight": true,
  "allowNether": true,
  "ambientSpawnLimit": 15,
  "animalSpawnLimit": 10,
  "bukkitVersion": "1.20.4",
  "commandAliases": {
    "test": ["t", "tst"]
  }
}
```
```

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

### Get Plugin Dependencies

Source: https://jd.papermc.io/folia/1.21/org/bukkit/plugin/PluginDescriptionFile

Returns a list of unique identifiers for plugins that are required for this plugin to load. If any listed dependencies are not installed, the plugin will fail to load.

```java
@NotNull public @NotNull List<String> getPluginDependencies()
Description copied from interface: `PluginMeta`
Provides a list of dependencies that are required for this plugin to load. The list holds the unique identifiers, following the constraints laid out in `PluginMeta.getName()`, of the dependencies. 
If any of the dependencies defined by this list are not installed on the server, this plugin will fail to load. 

Specified by:
    `getPluginDependencies` in interface `PluginMeta` 

Returns:
    an immutable list of required dependency names
```
Tokens:
Raw