Paper

https://jd.papermc.io/paper/1.21.9/
Admin
Paper is a high-performance Minecraft server implementation that provides a plugin development...
Tokens:655,303
Snippets:8,170
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Placement Material Examples

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/data/BlockData.html

Examples of mapping specific block materials to their corresponding placement materials.

```text
 Material.REDSTONE_WIRE -> Material.REDSTONE
 Material.CARROTS -> Material.CARROT
```

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

### Example plugin.yml configuration

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/PluginDescriptionFile.html

A basic example of a plugin.yml file structure defining the plugin name, provided APIs, version, and description.

```yaml
name: Inferno
provides: [Hell]
version: 1.4.1
description: This plugin is so 31337. You can set yourself on fire.
```

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

### WorldInfo.vanillaBiomeProvider()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/generator/class-use/BiomeProvider.html

Get the vanilla BiomeProvider for this world.

```APIDOC
## WorldInfo.vanillaBiomeProvider()

### Description
Get the vanilla BiomeProvider for this world.

### Returns
- **@NotNull BiomeProvider** - The vanilla biome provider.
```

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

### startPlaying()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/Jukebox.html

Starts playback if a record is present.

```APIDOC
## boolean startPlaying()

### Description
Attempts to start playback. Returns true if successful, false if already playing or no record is present.

### Returns
- **boolean** - Success status of starting playback.
```

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

### startTiming()

Source: https://jd.papermc.io/paper/1.21.9/org/spigotmc/CustomTimingsHandler.html

Starts the timing measurement for this handler.

```APIDOC
### Method: startTiming()

Begins recording the duration for the associated timing task.
```

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

### getLimitedLifetimeTicks()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Vex.html

Gets the remaining ticks until the Vex starts taking damage.

```APIDOC
## int getLimitedLifetimeTicks()

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

### Returns
- **int** - The number of ticks.
```

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

### PluginDescriptionFile.getLoad()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/class-use/PluginLoadOrder.html

Gives the phase of server startup that the plugin should be loaded.

```APIDOC
### Method
PluginDescriptionFile.getLoad()

### Description
Gives the phase of server startup that the plugin should be loaded.

### Returns
- **@NotNull PluginLoadOrder** - The load order phase.
```

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

### getLimitedLifetimeTicks

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Vex.html

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

```APIDOC
## int getLimitedLifetimeTicks()

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

### Returns
- **int** - ticks until the vex will start to take damage
```

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

### startUsingItem(EquipmentSlot hand)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/LivingEntity.html

Starts using the item in the specified hand, making it the currently active item.

```APIDOC
### default void startUsingItem(EquipmentSlot hand)

Starts using the item in the specified hand, making it the currently active item.
```

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

### hasLimitedLifetime

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Vex.html

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

```APIDOC
## boolean hasLimitedLifetime()

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

### Returns
- **boolean** - will take damage
```

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

### completeReconfiguration()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/connection/PlayerConfigurationConnection.html

Finalizes the configuration process and returns the player to the game.

```APIDOC
### Method
`void completeReconfiguration()`

### Description
Completes the configuration for this player, which will cause this player to reenter the game. Note, this should only be called if you are reconfiguring the player.
```

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

### getDeathAnimationTicks

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/EnderDragon.html

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

```APIDOC
### Method
int getDeathAnimationTicks()

### Description
Get the current time in ticks relative to the start of this dragon's death animation. If this dragon is alive, 0 will be returned. This value will never exceed 200.

### Returns
- **int** - this dragon's death animation ticks
```

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

### PluginMeta.getLoadOrder()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/class-use/PluginLoadOrder.html

Retrieves the phase of the server startup logic that the plugin should be loaded.

```APIDOC
### Method
PluginMeta.getLoadOrder()

### Description
Returns the phase of the server startup logic that the plugin should be loaded.

### Returns
- **PluginLoadOrder** - The load order phase.
```

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

### get(String path)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/configuration/ConfigurationSection.html

Gets the requested Object by path.

```APIDOC
## Object get(String path)

### Description
Gets the requested Object by path. If the Object does not exist but a default value has been specified, this will return the default value. If the Object does not exist and no default value was specified, this will return null.

### Parameters
- **path** (String) - Path to get the object from.

### Returns
- **Object** - The requested object or null if not found.
```

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

### options()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/configuration/Configuration.html

Retrieves the configuration options for this instance.

```APIDOC
## @NotNull ConfigurationOptions options()

### Description
Gets the ConfigurationOptions for this Configuration. All setters through this method are chainable.

### Returns
- **ConfigurationOptions** - Options for this configuration.
```

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

### Create and Start a Timing Handler

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

Creates and immediately starts a Timing object, suitable for use with Java 7 try-with-resources blocks.

```java
try (Timing ignored = Timings.ofStart(plugin, someName)) { // timed section }
```

```java
try (Timing ignored = Timings.ofStart(plugin, someName, groupHandler)) { // timed section }
```

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

### Create a JarLibrary instance

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

Instantiate a JarLibrary by providing the Path to the local jar file.

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

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

### getSize

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/scoreboard/Team.html

Gets the size of the team.

```APIDOC
### getSize()

Returns the number of entries on the team.

**Returns:** `int` - number of entries on the team
**Throws:** `IllegalStateException` - if this team has been unregistered
```

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

### begin()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/conversations/Conversation.html

Displays the first prompt of the conversation and begins redirecting the user's chat responses.

```APIDOC
## void begin()

### Description
Displays the first prompt of this conversation and begins redirecting the user's chat responses.
```

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

### getRarity

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/ItemMeta.html

Gets the item rarity.

```APIDOC
ItemRarity getRarity()
```

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

### setUp(boolean up)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/data/type/Wall.html

Sets the value of the 'up' property, determining if the wall has a center post.

```APIDOC
### void setUp(boolean up)

Sets the value of the 'up' property.

**Parameters:**
- **up** (boolean) - the new 'up' value
```

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

### getPages()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/WritableBookMeta.html

Gets all the pages in the book.

```APIDOC
## List<String> getPages()

### Description
Gets all the pages in the book.

### Returns
- **List<String>** - List of all the pages in the book
```

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

### showDemoScreen()

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

Shows the demo screen to the player.

```APIDOC
## void showDemoScreen()

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

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

### Initialize FixedSetPrompt

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/conversations/FixedSetPrompt.html

Example of creating a new FixedSetPrompt instance with a specific set of allowed string responses.

```java
foo = new FixedSetPrompt("bar", "cheese", "panda");
```

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

### getPages()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/WritableBookMeta.html

Gets all the pages in the book.

```APIDOC
@NotNull List<String> getPages()
```

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

### startTrackingPlayer(Player)

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

Force a TrialSpawner to start tracking the provided player.

```APIDOC
## void startTrackingPlayer(Player player)

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

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

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

### getGeneration

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/BookMeta.html

Gets the generation of the book.

```APIDOC
## @Nullable BookMeta.Generation getGeneration()

### Description
Gets the generation of the book. Plugins should check that hasGeneration() returns true before calling this method.

### Returns
- **BookMeta.Generation** - the generation of the book
```

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

### getInventory()

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

Get the player's inventory.

```APIDOC
## PlayerInventory getInventory()

### Description
Get the player's inventory. This also contains the armor slots.

### Returns
- **PlayerInventory** - The inventory of the player
```

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

### getAuthor

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/BookMeta.html

Gets the author of the book.

```APIDOC
## @Nullable String getAuthor()

### Description
Gets the author of the book. Plugins should check that hasAuthor() returns true before calling this method.

### Returns
- **String** - the author of the book
```

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

### getFullText(CommandSender forWho)

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

Returns the full description of the help topic, paginated for the user.

```APIDOC
## String getFullText(CommandSender forWho)

### Description
Returns the full description of this help topic that is displayed when the user requests this topic's details. The result is paginated to fit the user's client.

### Parameters
- **forWho** (CommandSender) - Required - The player or console requesting the full text.

### Returns
- **String** - A full topic description.
```

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

### getTitle

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/BookMeta.html

Gets the title of the book.

```APIDOC
## @Nullable String getTitle()

### Description
Gets the title of the book. Plugins should check that hasTitle() returns true before calling this method.

### Returns
- **String** - the title of the book
```

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

### allow()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/player/AsyncPlayerPreLoginEvent.html

Allows the player to log in to the server.

```APIDOC
### void allow()

Allows the player to log in.
```

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

### startTrackingPlayer

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/TrialSpawner.html

Force this spawner to start tracking the provided player.

```APIDOC
### void startTrackingPlayer(Player player)

Forces the spawner to track the specified player. Note that the spawner may decide to stop tracking this player at any given time.
```

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

### getType

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/ItemStack.html

Gets the type of this item.

```APIDOC
## getType

### Description
Gets the type of this item.

### Returns
- **Material** - Type of the items in this stack.
```

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

### Example Skin URL

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/profile/PlayerTextures.html

A valid URL pointing to the Minecraft texture server for skin assignment.

```text
 http://textures.minecraft.net/texture/b3fbd454b599df593f57101bfca34e67d292a8861213d2202bb575da7fd091ac
```

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

### getClick()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/inventory/InventoryClickEvent.html

Gets the ClickType for this event.

```APIDOC
### ClickType getClick()

Returns the type of inventory click.
```

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

### Tool Instance Methods

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/datacomponent/item/Tool.html

Methods for retrieving configuration details from a Tool instance.

```APIDOC
### float defaultMiningSpeed()
Returns the default mining speed used if no specific rules match.

### int damagePerBlock()
Returns the amount of durability removed each time a block is mined.

### List<Tool.Rule> rules()
Returns an unmodifiable list of defined mining rules.

### boolean canDestroyBlocksInCreative()
Returns whether this tool is capable of destroying blocks while in creative mode.
```

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

### getCause()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/entity/EntityDamageEvent.html

Gets the cause of the damage.

```APIDOC
### Method
@NotNull public EntityDamageEvent.DamageCause getCause()

### Description
Gets the cause of the damage.

### Returns
- (EntityDamageEvent.DamageCause) A value detailing the cause of the damage.
```

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

### getVariant

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Wolf.html

Gets the variant of the wolf.

```APIDOC
## Wolf.Variant getVariant()

### Description
Get the variant of this wolf.

### Returns
- **Wolf.Variant** - The wolf variant.
```

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

### isClimbing()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/LivingEntity.html

Gets if the entity is climbing.

```APIDOC
## boolean isClimbing()

### Description
Gets if the entity is climbing.

### Returns
- **boolean** - if the entity is climbing
```

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

### MavenLibraryResolver()

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

Creates a new instance of the MavenLibraryResolver. The resolver starts without any pre-configured repositories.

```APIDOC
## MavenLibraryResolver()

### Description
Creates a new maven library resolver instance. The resolver is initialized without any repositories, requiring the user to register them manually.

### Constructor
`public MavenLibraryResolver()`
```

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

### getServer()

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

Retrieves the current Server singleton instance.

```APIDOC
## static Server getServer()

### Description
Gets the current Server singleton.

### Returns
- **Server** - The server instance.
```

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

### getInventory

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Llama.html

Gets the inventory of the llama.

```APIDOC
## Llama.getInventory()

### Description
Get the object's inventory.

### Returns
- **LlamaInventory** - The inventory of the llama.
```

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

### IndexHelpTopic Constructor

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/help/IndexHelpTopic.html

Initializes a new IndexHelpTopic with a name, short description, permission, and a collection of topics.

```APIDOC
## Constructor: IndexHelpTopic

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

### Description
Creates an index topic that aggregates multiple help topics. The optional preamble allows for custom text to be displayed at the top of the index.
```

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

### isHeadUp()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Cat.html

Gets if the cat has its head up.

```APIDOC
### Method
boolean isHeadUp()

### Description
Gets if the cat has its head up.

### Returns
- **boolean** - Head is up.
```

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

### isLyingDown()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Cat.html

Gets if the cat is lying down.

```APIDOC
### Method
boolean isLyingDown()

### Description
Gets if the cat is lying down.

### Returns
- **boolean** - Whether the cat is lying down.
```

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

### showWinScreen()

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

Shows the player the win screen.

```APIDOC
## void showWinScreen()

### Description
Shows the player the win screen that normally is only displayed after one kills the ender dragon and exits the end for the first time.
```

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

### getColor()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Arrow.html

Gets the color of the arrow.

```APIDOC
### Color getColor()

Gets the color of this arrow.

#### Returns
- **Color** - The arrow Color, or null if no color is set.
```

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

### reenterConfiguration()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/connection/PlayerGameConnection.html

Transitions the player to the configuration stage.

```APIDOC
### Method
void reenterConfiguration()

### Description
Bumps the player to the configuration stage. By default, this causes the player to stay until their connection is released by PlayerConfigurationConnection.completeReconfiguration().
```

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

### getColor

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Arrow.html

Gets the color of the arrow.

```APIDOC
## @Nullable Color getColor()

### Description
Gets the color of this arrow.
```

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

### getExperience() / setExperience(int)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/entity/ExpBottleEvent.html

Methods to get or set the total amount of experience to be created by the bottle.

```APIDOC
### Method
`int getExperience()`
`void setExperience(int exp)`

### Description
Retrieves or sets the total amount of experience to be created, which will be divided into orbs.

### Parameters
- **exp** (int) - The total amount of experience to be created.
```

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

### getInventory()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/AbstractHorse.html

Gets the inventory of the horse.

```APIDOC
## AbstractHorseInventory getInventory()

### Description
Retrieves the inventory associated with this horse.

### Returns
- **AbstractHorseInventory** - The horse's inventory.
```

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

### startCooking

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/Campfire.html

Re-enables cooking in all slots or a specific slot.

```APIDOC
## void startCooking()
## boolean startCooking(int index)

### Description
Re-enable cooking in all slots or the specified slot index.

### Parameters
- **index** (int, optional) - item slot index.

### Returns
- **boolean** (if index provided) - whether the slot couldn't cook before this call.
```

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

### getRarity()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/enchantments/EnchantmentWrapper.html

Gets the rarity of this enchantment.

```APIDOC
## EnchantmentRarity getRarity()

### Description
Gets the rarity of this enchantment.

### Returns
- **EnchantmentRarity** - The rarity.
```

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

### startTrackingEntity(Entity)

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

Force a TrialSpawner to start tracking the provided entity.

```APIDOC
## void startTrackingEntity(Entity entity)

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

### Parameters
- **entity** (Entity) - Required - The entity to track.
```

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

### getPlugin

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/command/PluginCommand.html

Gets the owner of this PluginCommand.

```APIDOC
## Plugin getPlugin()

### Description
Gets the owner of this PluginCommand.

### Returns
- **Plugin** - Plugin that owns this command
```

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

### getServerTickManager

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

Get the ServerTick Manager.

```APIDOC
### @NotNull ServerTickManager getServerTickManager()

Get the ServerTick Manager.

**Returns:** the manager.
```

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

### register(PluginMeta, String, String, Collection, BasicCommand)

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

Registers a command with a label, description, aliases, and a basic command instance.

```APIDOC
## register(PluginMeta, String, String, Collection, BasicCommand)

### Description
Registers a command under the same logic as the literal command node registration. This method allows plugins to define a command label, provide a help description, and specify aliases.

### Parameters
- **pluginMeta** (PluginMeta) - Required - The owning plugin's meta.
- **label** (String) - Required - The label of the to-be-registered command.
- **description** (String) - Optional - The help description for the root literal node.
- **aliases** (Collection<String>) - Required - A collection of aliases to register the basic command under.
- **basicCommand** (BasicCommand) - Required - The basic command instance to register.

### Returns
- **Set<String>** - Successfully registered root command labels (including aliases and namespaced variants).
```

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

### getInventory()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/Jukebox.html

Gets the inventory of the jukebox.

```APIDOC
## JukeboxInventory getInventory()

### Description
Returns the inventory associated with the jukebox block.

### Returns
- **JukeboxInventory** - The inventory instance.
```

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

### Timings.ofStart

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

Creates and immediately starts a Timing object, useful for try-with-resources blocks.

```APIDOC
## Timing ofStart(Plugin plugin, String name, [Timing groupHandler])

### Description
Returns a Timing object after starting it, useful for Java7 try-with-resources.

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

### Returns
- **Timing** - Timing Handler
```

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

### getX

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/Location.html

Gets the x-coordinate of the location.

```APIDOC
## Method: getX()

### Description
Gets the x-coordinate of this location.

### Returns
- **double** - x-coordinate
```

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

### TooltipDisplay.tooltipDisplay()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/datacomponent/item/TooltipDisplay.html

Creates a new builder instance for constructing a TooltipDisplay object.

```APIDOC
## static TooltipDisplay.Builder tooltipDisplay()

### Description
Returns a new builder for creating a TooltipDisplay instance.

### Returns
- **TooltipDisplay.Builder** - A new builder instance.
```

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

### size()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/Registry.html

Gets the size of the registry.

```APIDOC
### size()

Gets the size of the registry.

#### Returns
- **int** - The size of the registry.
```

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

### FurnaceStartSmeltEvent Methods

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/inventory/FurnaceStartSmeltEvent.html

Methods available for interacting with the FurnaceStartSmeltEvent instance.

```APIDOC
## getRecipe()

### Description
Gets the CookingRecipe associated with this event.

### Returns
- **CookingRecipe<?>** - The recipe being cooked.

## getTotalCookTime()

### Description
Gets the total cook time associated with this event.

### Returns
- **int** - The total cook time.

## setTotalCookTime(int cookTime)

### Description
Sets the total cook time for this event.

### Parameters
- **cookTime** (int) - The new total cook time.
```

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

### getTags()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/Registry.html

Gets all the tags in this registry.

```APIDOC
### getTags()

Gets all the tags in this registry.

#### Returns
- **Collection<Tag<T>>** - A stream of all tags in this registry.

#### Throws
- **UnsupportedOperationException** - If this registry doesn't have or support tags.
```

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

### GoalKey Instance Methods

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/entity/ai/GoalKey.html

Methods for retrieving information from a GoalKey instance.

```APIDOC
### Class<T> getEntityClass()

#### Description
Retrieves the mob class associated with this GoalKey.

### NamespacedKey getNamespacedKey()

#### Description
Retrieves the NamespacedKey associated with this GoalKey.
```

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

### getHeight()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/BlockChangeDelegate.html

Gets the height of the world.

```APIDOC
### getHeight()

#### Description
Gets the height of the world.

#### Returns
- **int** - Height of the world
```

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

### TooltipContext.create()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/inventory/tooltip/class-use/TooltipContext.html

Creates a new context with specified settings.

```APIDOC
## TooltipContext.create()

### Description
Creates a new context. Overloads exist for default settings or specifying advanced and creative boolean flags.
```

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

### startTrackingEntity

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/block/TrialSpawner.html

Force this spawner to start tracking the provided entity.

```APIDOC
### void startTrackingEntity(Entity entity)

Forces the spawner to track the specified entity. Note that the spawner may decide to stop tracking this entity at any given time.
```

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

### key

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/registry/data/dialog/input/DialogInput.html

Gets the key for this input.

```APIDOC
## String key()

### Description
Gets the key for this input. Used in dialog actions to identify this dialog input's value.

### Returns
- **String** - The key
```

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

### SignedMessageResolver.content()

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

Gets the string content of the message.

```APIDOC
## String content()

### Description
Gets the string content of the message.
```

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

### HelpTopic Methods

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

Methods available for interacting with and customizing HelpTopic instances.

```APIDOC
## void amendCanSee(String amendedPermission)

### Description
Allows the server administrator to override the permission required to see a help topic.

## void amendTopic(String amendedShortText, String amendedFullText)

### Description
Allows the server admin or another plugin to add or replace the contents of a help topic.

## boolean canSee(CommandSender player)

### Description
Determines if a CommandSender is allowed to see this help topic.

## String getFullText(CommandSender forWho)

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

## String getName()

### Description
Returns the name of this help topic.

## String getShortText()

### Description
Returns a brief description that will be displayed in the topic index.
```

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

### getEntries

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/scoreboard/Team.html

Gets the Set of entries on the team.

```APIDOC
### getEntries()

Returns the Set of entries currently on the team.

**Returns:** `Set<String>` - entries on the team
**Throws:** `IllegalStateException` - if this team has been unregistered
```

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

### Define full command hierarchy

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/PluginDescriptionFile.html

Example of a complete commands section structure in plugin.yml.

```yaml
commands:
  flagrate:
    description: Set yourself on fire.
    aliases: [combust_me, combustMe]
    permission: inferno.flagrate
    permission-message: You do not have /<permission>
    usage: Syntax error! Perhaps you meant /<command> PlayerName?
  burningdeaths:
    description: List how many times you have died by fire.
    aliases:
    - burning_deaths
    - burningDeaths
    permission: inferno.burningdeaths
    usage: |
      /<command> [player]
      Example: /<command> - see how many times you have burned to death
      Example: /<command> CaptainIce - see how many times CaptainIce has burned to death
```

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

### getRenderType()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/scoreboard/Objective.html

Gets the current render type.

```APIDOC
### getRenderType()

Returns the current RenderType.
```

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

### create(Consumer<RegistryBuilderFactory<MusicInstrument,? extends InstrumentRegistryEntry.Builder>> value)

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

Creates an inlined music instrument using a builder factory.

```APIDOC
## create

### Description
Creates an inlined music instrument.

### Parameters
- **value** (Consumer<RegistryBuilderFactory<MusicInstrument,? extends InstrumentRegistryEntry.Builder>>) - Required - a consumer for the builder factory

### Returns
- **MusicInstrument** - the created music instrument
```

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

### getEntry()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/scoreboard/Score.html

Gets the entry being tracked by this Score.

```APIDOC
### Method
`@NotNull String getEntry()`

### Description
Gets the entry being tracked by this Score.

### Returns
- `String` - the entry being tracked
```

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

### Bukkit.getServerConfig()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/configuration/class-use/ServerConfiguration.html

Retrieves the global server configuration instance.

```APIDOC
## static @NotNull ServerConfiguration Bukkit.getServerConfig()

### Description
Retrieves the server configuration.

### Returns
- **ServerConfiguration** - The current server configuration instance.
```

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

### hasPermission

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/permissions/Permissible.html

Gets the value of a specified permission.

```APIDOC
## boolean hasPermission(String name)
## boolean hasPermission(Permission perm)

### Description
Gets the value of the specified permission. If an override is not set, the default value of the permission is returned.

### Parameters
- **name** (String) - The name of the permission.
- **perm** (Permission) - The Permission object.

### Returns
- **boolean** - The value of the permission.
```

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

### PluginInformation(String name, String version)

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/event/server/GS4QueryEvent.QueryResponse.PluginInformation.html

Constructs a new PluginInformation instance with the specified name and version.

```APIDOC
### Constructor: PluginInformation(String name, String version)

Creates a new instance of PluginInformation.

#### Parameters
- **name** (String) - The name of the plugin.
- **version** (String) - The version of the plugin.
```

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

### getFacing

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/material/Door.html

Gets the direction that this door is facing.

```APIDOC
## BlockFace getFacing()

### Description
Get the direction that this door is facing. Undefined if isTopHalf() is true.

### Returns
- **BlockFace** - The direction.
```

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

### Bukkit.restart()

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

Restarts the server instance.

```APIDOC
## static void restart()

### Description
Restarts the server.

### Method
Static method in org.bukkit.Bukkit
```

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

### getPageCount()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/WritableBookMeta.html

Gets the number of pages in the book.

```APIDOC
## int getPageCount()

### Description
Gets the number of pages in the book.

### Returns
- **int** - The number of pages in the book
```

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

### registerAll(String fallbackPrefix, List<Command> commands)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/command/CommandMap.html

Registers a list of commands belonging to a plugin, using a fallback prefix to ensure uniqueness.

```APIDOC
### void registerAll(String fallbackPrefix, List<Command> commands)

Registers all the commands belonging to a certain plugin.

#### Parameters
- **fallbackPrefix** (String) - A prefix which is prepended to each command with a ':' one or more times to make the command unique.
- **commands** (List<Command>) - A list of commands to register.
```

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

### setUsage(String usage)

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

Sets the example usage string for the command.

```APIDOC
## Command setUsage(String usage)

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

### Parameters
- **usage** (String) - new example usage

### Returns
- **Command** - this command object, for chaining
```

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

### getPageCount()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/WritableBookMeta.html

Gets the number of pages in the book.

```APIDOC
int getPageCount()
```

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

### getOwningPlayer

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/SkullMeta.html

Gets the OfflinePlayer who owns the skull.

```APIDOC
## OfflinePlayer getOwningPlayer()

### Description
Gets the owner of the skull.

### Returns
- **OfflinePlayer** - The owner of the skull.
```

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

### getPower

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/FireworkMeta.html

Gets the flight power of the firework.

```APIDOC
## int getPower()

### Description
Gets the approximate height the firework will fly. Plugins should check that hasPower() returns true before calling this method.

### Returns
- **int** - Approximate flight height of the firework.
```

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

### completion(String suggestion, Component tooltip)

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/event/server/AsyncTabCompleteEvent.Completion.html

Creates a new completion instance with a suggestion string and an optional tooltip component.

```APIDOC
## static Completion completion(String suggestion, @Nullable Component tooltip)

### Description
Creates a new AsyncTabCompleteEvent.Completion from a suggestion string and a tooltip Component. If the provided component is null, the suggestion will not have a tooltip.

### Parameters
- **suggestion** (String) - The suggestion string to display.
- **tooltip** (Component) - The tooltip component, or null.

### Returns
- **Completion** - A new completion instance.
```

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

### Server Configuration and Info

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

Methods to retrieve server metadata and configure global settings.

```APIDOC
## getServer()
### Description
Gets the current Server singleton.

## getVersionMessage()
### Description
Gets message describing the version server is running.

## getName()
### Description
Gets the name of this server implementation.

## getVersion()
### Description
Gets the version string of this server implementation.

## setWhitelist(boolean value)
### Description
Sets if the server is whitelisted.

## setMaxPlayers(int maxPlayers)
### Description
Set the maximum amount of players allowed to be logged in at once.
```

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

### getMaxDamage()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/meta/Damageable.html

Gets the maximum amount of damage.

```APIDOC
## int getMaxDamage()

### Description
Gets the maximum amount of damage. Plugins should check `hasMaxDamage()` before calling this method.

### Returns
- **int** - the maximum amount of damage
```

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

### autoEnableOnServerStart(boolean autoEnableOnServerStart)

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

Sets whether the datapack should be automatically enabled when the server starts.

```APIDOC
## DatapackRegistrar.Configurer.autoEnableOnServerStart(boolean 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) - Required - true to ensure the pack is enabled on server starts.

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

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

### getAmount

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/ItemStack.html

Gets the amount of items in this stack.

```APIDOC
## getAmount

### Description
Gets the amount of items in this stack.

### Returns
- **int** - Amount of items in this stack.
```

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

### startsWithIgnoreCase

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/util/StringUtil.html

Checks if a string starts with a specified prefix, ignoring case sensitivity.

```APIDOC
## static boolean startsWithIgnoreCase(@NotNull String string, @NotNull String prefix)

### Description
Checks if the provided string starts with the given prefix, ignoring case. This method is optimized to avoid unnecessary string copying.

### Parameters
- **string** (String) - The string to check.
- **prefix** (String) - The prefix to compare against.

### Returns
- **boolean** - True if the string starts with the prefix (case-insensitive), false otherwise.

### Throws
- **NullPointerException** - If prefix is null.
- **IllegalArgumentException** - If string is null.
```

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

### getHolder()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/EntityEquipment.html

Get the entity this EntityEquipment belongs to.

```APIDOC
### Entity getHolder()

Get the entity this EntityEquipment belongs to.

**Returns:** the entity this EntityEquipment belongs to.
```

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

### getArmorContents()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/EntityEquipment.html

Gets all ItemStacks from the armor slots.

```APIDOC
## ItemStack[] getArmorContents()

### Description
Gets all ItemStacks from the armor slots. Returns an array of copies for non-players and an array of mirrors for players.

### Returns
- **ItemStack[]** - Array of armor items
```

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

### TrialSpawnerConfiguration Methods

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/spawner/TrialSpawnerConfiguration.html

Methods for managing rewards and spawn configurations for a trial spawner.

```APIDOC
## void addPossibleReward(LootTable table, int weight)
Adds a LootTable to the spawner's reward list with a specific weight.

## float getAdditionalSimultaneousEntities()
Gets the additional number of entities tracked per player.

## float getAdditionalSpawnsBeforeCooldown()
Gets the additional number of entities spawned per player before cooldown.

## float getBaseSimultaneousEntities()
Gets the base number of entities tracked by the spawner.

## float getBaseSpawnsBeforeCooldown()
Gets the base number of entities spawned before cooldown.

## Map<LootTable,Integer> getPossibleRewards()
Returns the map of LootTables and their associated weights.

## void removePossibleReward(LootTable table)
Removes a specific LootTable from the reward list.

## void setAdditionalSimultaneousEntities(float amount)
Sets the additional number of entities tracked per player.

## void setAdditionalSpawnsBeforeCooldown(float amount)
Sets the additional number of entities spawned per player before cooldown.

## void setBaseSimultaneousEntities(float amount)
Sets the base number of entities tracked by the spawner.

## void setBaseSpawnsBeforeCooldown(float amount)
Sets the base number of entities spawned before cooldown.

## void setPossibleRewards(Map<LootTable,Integer> rewards)
Sets the complete list of LootTables and their weights for the spawner.
```

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

### configuration()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/configuration/file/FileConfigurationOptions.html

Returns the FileConfiguration instance that this options object is responsible for.

```APIDOC
### Method
`@NotNull FileConfiguration configuration()`

### Description
Returns the Configuration that this object is responsible for.

### Returns
- **FileConfiguration** - The parent configuration instance.
```

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

### World.getBiomeProvider()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/generator/class-use/BiomeProvider.html

Gets the biome provider for this world.

```APIDOC
## World.getBiomeProvider()

### Description
Gets the biome provider for this world.

### Returns
- **@Nullable BiomeProvider** - The biome provider for the world.
```

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

### create

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/registry/data/dialog/input/TextDialogInput.MultilineOptions.html

Creates a new instance of MultilineOptions with specified line and height constraints.

```APIDOC
## static TextDialogInput.MultilineOptions create(@Nullable Integer maxLines, @Nullable Integer height)

### Description
Creates a new multiline options instance for a text dialog input.

### Parameters
- **maxLines** (Integer) - Optional - The maximum number of lines allowed.
- **height** (Integer) - Optional - The height of the input (range 1-512).

### Returns
- **MultilineOptions** - A new instance configured with the provided parameters.
```

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

### getAction()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/inventory/InventoryClickEvent.html

Gets the InventoryAction that triggered this event.

```APIDOC
### InventoryAction getAction()

Returns the InventoryAction that triggered this event.
```

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

### getServer()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/Plugin.html

Returns the Server instance currently running this plugin.

```APIDOC
## Server getServer()

### Description
Returns the Server instance currently running this plugin.
```

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

### of(String name, String version)

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/event/server/GS4QueryEvent.QueryResponse.PluginInformation.html

Static factory method to create a new PluginInformation instance.

```APIDOC
### Method: of(String name, String version)
Creates and returns a new PluginInformation instance.

#### Parameters
- **name** (String) - The name of the plugin.
- **version** (String) - The version of the plugin.
```

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

### getSlot()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/inventory/InventoryClickEvent.html

Gets the slot number that was clicked.

```APIDOC
### int getSlot()

Returns the slot number.
```

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

### startFollowing

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

Forces this fish to follow the specified leader fish.

```APIDOC
### void startFollowing(SchoolableFish leader)

Forces this fish to follow the given fish.

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

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

### getPotion()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/entity/PotionSplashEvent.html

Gets the potion which caused this event.

```APIDOC
### Method
public ThrownPotion getPotion()

### Description
Gets the potion which caused this event.

### Returns
- **ThrownPotion** - The thrown potion entity.
```

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

### getConversionPlayer

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/ZombieVillager.html

Gets the player who initiated the conversion.

```APIDOC
## @Nullable OfflinePlayer getConversionPlayer()

### Description
Gets the player who initiated the conversion.

### Returns
- (OfflinePlayer) - The player, or null if unknown or not converting.
```

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

### void applySkinToPlayerHeadContents(Builder builder)

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/profile/PlayerProfile.html

Applies the skin source to a player head contents builder.

```APIDOC
## applySkinToPlayerHeadContents(Builder builder)

### Description
Applies this skin source to the given player head contents builder. The name, id, and properties will be cleared prior to calling by the builder.

### Parameters
- **builder** (net.kyori.adventure.text.object.PlayerHeadObjectContents.Builder) - Required - The builder to apply the skin source to.
```

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

### getSoundVariant

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Wolf.html

Gets the sound variant of the wolf.

```APIDOC
## Wolf.SoundVariant getSoundVariant()

### Description
Get the sound variant of this wolf.

### Returns
- **Wolf.SoundVariant** - The wolf sound variant.
```

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

### build()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/registry/data/dialog/input/SingleOptionDialogInput.Builder.html

Constructs the final SingleOptionDialogInput instance.

```APIDOC
### build()

Builds the SingleOptionDialogInput.

**Returns:**
- **SingleOptionDialogInput** - The built dialog input.
```

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

### init(JavaPlugin plugin)

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/plugin/java/PluginClassLoader.html

Initializes both this configured plugin class loader and the java plugin passed to link to each other.

```APIDOC
## init

### Description
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** (JavaPlugin) - The JavaPlugin that should be interlinked with this class loader.
```

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

### getSummoner

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Vex.html

Get the Mob that summoned this vex.

```APIDOC
## @Nullable Mob getSummoner()

### Description
Get the Mob that summoned this vex.

### Returns
- **Mob** - Mob that summoned this vex
```

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

### CookingRecipe Constructor

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/inventory/CookingRecipe.html

Creates a new cooking recipe with a unique key, result item, input material or choice, experience reward, and cooking time.

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

### Description
Creates a cooking recipe to craft the specified ItemStack using a single material as input.

### Parameters
- **key** (NamespacedKey) - The unique recipe key
- **result** (ItemStack) - The item to create
- **source** (Material) - The input material
- **experience** (float) - Experience given by the recipe
- **cookingTime** (int) - Cooking time in ticks

## Constructor: CookingRecipe(NamespacedKey key, ItemStack result, RecipeChoice input, float experience, int cookingTime)

### Description
Creates a cooking recipe to craft the specified ItemStack using a RecipeChoice as input.

### Parameters
- **key** (NamespacedKey) - The unique recipe key
- **result** (ItemStack) - The item to create
- **input** (RecipeChoice) - The input choices
- **experience** (float) - Experience given by the recipe
- **cookingTime** (int) - Cooking time in ticks
```

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

### hasEgg

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Turtle.html

Gets whether the turtle has an egg.

```APIDOC
### boolean hasEgg()

Gets whether the turtle has an egg.

**Returns:**
- boolean: Whether the turtle has an egg
```

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

### getRaid()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Raider.html

Gets the Raid that this raider is participating in, if any.

```APIDOC
## @Nullable Raid getRaid()

### Description
Gets the Raid that this raider is participating in, if any.

### Returns
- **Raid** - The raid, or null if not participating in a raid.
```

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

### giveExp

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

Gives the player the specified amount of experience.

```APIDOC
## void giveExp(int amount, boolean applyMending)

### Description
Gives the player the amount of experience specified, with an option to apply mending to items.

### Parameters
- **amount** (int) - Exp amount to give
- **applyMending** (boolean) - Mend players items with mending, with same behavior as picking up orbs.
```

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

### Note Creation Methods

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/class-use/Note.html

Static methods to create new Note instances with specific tones and octaves.

```APIDOC
## Note.flat(int octave, Note.Tone tone)
Creates a new note for a flat tone.

## Note.natural(int octave, Note.Tone tone)
Creates a new note for a natural tone.

## Note.sharp(int octave, Note.Tone tone)
Creates a new note for a sharp tone.
```

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

### Bukkit.loadServerIcon()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/util/class-use/CachedServerIcon.html

Loads a server icon from a file or BufferedImage.

```APIDOC
### Method
static @NotNull CachedServerIcon loadServerIcon(@NotNull BufferedImage image)
static @NotNull CachedServerIcon loadServerIcon(@NotNull File file)

### Description
Creates or loads a cached server-icon from the provided image or file.
```

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

### isDancing

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Piglin.html

Gets if the piglin is currently dancing.

```APIDOC
## boolean isDancing()

### Description
Gets if the piglin is currently dancing.

### Returns
- **boolean** - True if dancing, false otherwise.
```

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

### configuration()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/configuration/ConfigurationOptions.html

Returns the Configuration instance that this options object is associated with.

```APIDOC
### Method
Configuration configuration()

### Description
Returns the Configuration that this object is responsible for.

### Returns
- **Configuration** - The parent configuration.
```

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

### getMainHand

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Mannequin.html

Gets the main hand of this mannequin.

```APIDOC
### MainHand getMainHand()

Gets the main hand of this mannequin.
```

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

### PotionMix(NamespacedKey, ItemStack, RecipeChoice, RecipeChoice)

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/potion/PotionMix.html

Creates a new PotionMix instance. This object should be added to the server using PotionBrewer.addPotionMix(PotionMix).

```APIDOC
### Constructor: PotionMix(NamespacedKey key, ItemStack result, RecipeChoice input, RecipeChoice ingredient)

Creates a new potion mix for use in a brewing stand.

#### Parameters
- **key** (NamespacedKey) - A unique key for the mix.
- **result** (ItemStack) - The resulting itemstack that will appear in the 3 bottom slots.
- **input** (RecipeChoice) - The input placed into the bottom 3 slots.
- **ingredient** (RecipeChoice) - The ingredient placed into the top slot.
```

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

### getDescription

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Mannequin.html

Gets the description text for this mannequin.

```APIDOC
### @Nullable net.kyori.adventure.text.Component getDescription()

Gets the description text for this mannequin (appears below the name).
```

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

### getHelpTopic

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/help/HelpMap.html

Retrieves a specific help topic by its name.

```APIDOC
### @Nullable HelpTopic getHelpTopic(@NotNull String topicName)

Returns a help topic for a given topic name.

#### Parameters
- **topicName** (String) - The help topic name to look up.

#### Returns
- **HelpTopic** - A HelpTopic object matching the topic name or null if none can be found.
```

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

### getCaravanTail

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Llama.html

Gets the llama that is following this llama.

```APIDOC
## Llama.getCaravanTail()

### Description
Gets the llama that is currently following behind this llama.

### Returns
- **Llama** - The llama following this llama, or null if none is following.
```

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

### getProfile

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Mannequin.html

Gets the resolvable profile for this mannequin.

```APIDOC
### ResolvableProfile getProfile()

Gets the resolvable profile for this mannequin.
```

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

### AsyncTabCompleteEvent.Completion.completion(String suggestion, Component tooltip)

Source: https://jd.papermc.io/paper/1.21.9/com/destroystokyo/paper/event/server/class-use/AsyncTabCompleteEvent.Completion.html

Creates a new completion instance with an optional tooltip.

```APIDOC
## static AsyncTabCompleteEvent.Completion completion(String suggestion, @Nullable Component tooltip)

### Description
Creates a new AsyncTabCompleteEvent.Completion object using the provided suggestion string and an optional tooltip component.

### Parameters
- **suggestion** (String) - The suggestion text to be offered to the sender.
- **tooltip** (Component) - An optional tooltip to display alongside the suggestion.
```

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

### getServer()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/command/CommandSender.html

Retrieves the server instance associated with the command sender.

```APIDOC
## Server getServer()

### Description
Returns the server instance that this command is running on.

### Returns
- **Server** - The server instance.
```

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

### getIgniter

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Creeper.html

Gets the entity that ignited the Creeper.

```APIDOC
## Entity getIgniter()

### Description
Gets the entity which ignited the creeper, if available.

### Returns
- **Entity** - the entity which ignited the creeper (if available) or null
```

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

### Configure plugin load order

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/event/world/WorldInitEvent.html

Set the load order to STARTUP in plugin.yml to ensure the plugin is active during world initialization.

```yaml
load: STARTUP
```

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

### getExplosionRadius

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Creeper.html

Gets the explosion radius for the Creeper.

```APIDOC
## int getExplosionRadius()

### Description
Get the explosion radius in which this Creeper's explosion will affect.

### Returns
- **int** - the explosion radius
```

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

### getCollarColor()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Cat.html

Get the collar color of this cat.

```APIDOC
### Method
DyeColor getCollarColor()

### Description
Get the collar color of this cat.

### Returns
- **DyeColor** (DyeColor) - The color of the collar.
```

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

### TextDialogInput.Builder Configuration Methods

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/registry/data/dialog/input/class-use/TextDialogInput.Builder.html

Methods to configure the properties of a TextDialogInput.

```APIDOC
## TextDialogInput.Builder Configuration

### initial(String initial)
Sets the initial value of the input.

### labelVisible(boolean labelVisible)
Sets whether the label should be visible.

### maxLength(int maxLength)
Sets the maximum length of the input.

### multiline(TextDialogInput.MultilineOptions multiline)
Sets the multiline options for the input.

### width(int width)
Sets the width of the input (Range: 1 to 1024).
```

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

### getCatType()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/Cat.html

Gets the current type of this cat.

```APIDOC
### Method
Cat.Type getCatType()

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

### Returns
- **Type** (Cat.Type) - The type of the cat.
```

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

### getExperience()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/ExperienceOrb.html

Gets how much experience is contained within this orb.

```APIDOC
### int getExperience()

Gets how much experience is contained within this orb.

**Returns:**
- Amount of experience (int)
```

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

### getWeapon()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/AbstractArrow.html

Gets the ItemStack which fired this arrow.

```APIDOC
### ItemStack getWeapon()

Gets the ItemStack which fired this arrow.

**Returns:** The firing ItemStack
```

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

### Server State and Configuration

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

Methods to check server status, whitelist settings, and configuration properties.

```APIDOC
## Server State Methods

### Description
Methods to query the current state of the server, including whitelist status, hardcore mode, and shutdown status.

### Methods
- `static boolean hasWhitelist()`: Gets whether this server has a whitelist.
- `static boolean isHardcore()`: Gets whether the server is in hardcore mode.
- `static boolean isStopping()`: Checks if the server is in the process of being shutdown.
- `static boolean isWhitelistEnforced()`: Gets whether the server whitelist is enforced.
```

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

### isCritical()

Source: https://jd.papermc.io/paper/1.21.9/org/bukkit/entity/AbstractArrow.html

Gets whether this arrow is critical.

```APIDOC
### boolean isCritical()

Gets whether this arrow is critical. Critical arrows have increased damage and cause particle effects.

**Returns:** true if it is critical
```

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

### TooltipContext.create()

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/inventory/tooltip/TooltipContext.html

Creates a default TooltipContext instance.

```APIDOC
### Method
static TooltipContext create()

### Description
Creates a new context that is neither advanced nor creative.

### Returns
- **TooltipContext** - A new context instance.
```

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

### void register(LibraryStore store)

Source: https://jd.papermc.io/paper/1.21.9/io/papermc/paper/plugin/loader/library/ClassPathLibrary.html

Registers the library represented by this instance into the provided LibraryStore.

```APIDOC
## void register(LibraryStore store)

### Description
Registers the library this class path library represents into the passed library store. This method can be implemented by plugins requiring complex logic or by using existing API implementations.

### Parameters
- **store** (LibraryStore) - Required - The library store instance to register this library into.

### Throws
- **LibraryLoadingException** - Thrown if library loading fails for this classpath library.
```
Tokens:
Raw