Paper

https://jd.papermc.io/paper/26.1.2
Admin
Paper is a high-performance Minecraft server implementation that provides the Bukkit/Spigot plugin...
Tokens:4,971,339
Snippets:72,810
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### getExample()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/inventory/EquipmentSlotGroup.html

Gets an EquipmentSlot which is an example of a slot in this group. This method is deprecated and intended for internal compatibility use only.

```APIDOC
## getExample()

### Description
Gets an EquipmentSlot which is an example of a slot in this group.

### Method
`public @NotNull EquipmentSlot getExample()`

### Returns
- **EquipmentSlot** - An example slot.

### Deprecation
- Deprecated since 1.20.5. For internal compatibility use only.

### Notes
- This method is annotated with `@Internal`.
```

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

### get(String) - Method in interface org.bukkit.configuration.ConfigurationSection

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

Gets the requested Object by path.

```APIDOC
## [GET] get(String)

### Description
Gets the requested Object by path.

### Method
GET

### Endpoint
get(String)

### Parameters
#### Path Parameters
- **path** (String) - Required - The path to the object.

### Response
#### Success Response (200)
- **return** (Object) - The requested object, or null if not found.

#### Response Example
{
  "return": "<object>"
}
```

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

### getRelative(BlockFace, int) example: placing water two blocks above

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/block/Block.html

This example shows how to use getRelative(BlockFace, int) to get a block two blocks above a given block and set its type to Material.WATER. It is used to place water at 100,102,100 when starting from 100,100,100.

```java
Block block = world.getBlockAt(100, 100, 100);
Block shower = block.getRelative(BlockFace.UP, 2);
shower.setType(Material.WATER);

```

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

### init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/plugin/java/JavaPlugin.html

Initializes the plugin with the given server, description, data folder, file, class loader, configuration, and logger.

```APIDOC
## init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger)

### Description
Initializes the plugin with the given server, description, data folder, file, class loader, configuration, and logger.

### Method
Instance method

### Signature
`final void init(Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader, @Nullable PluginMeta configuration, Logger logger)`

### Parameters
- **server** (Server) - The server instance.
- **description** (PluginDescriptionFile) - The plugin description.
- **dataFolder** (File) - The data folder.
- **file** (File) - The plugin file.
- **classLoader** (ClassLoader) - The class loader.
- **configuration** (PluginMeta) - The plugin configuration, or null.
- **logger** (Logger) - The logger.

### Returns
void

### Exceptions
None documented.
```

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

### getStartLevel()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/enchantments/Enchantment.html

Gets the level that this Enchantment should start at.

```APIDOC
## getStartLevel()

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

### Method
`abstract int getStartLevel()`

### Returns
- `int` - The start level.
```

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

### getTreasureLocation()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Dolphin.html

Gets the location of the treasure that this dolphin is currently guiding players to.

```APIDOC
## getTreasureLocation()

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

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

### Returns
- **@Nullable Location** - The treasure location, or null if none is set.

```

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

### ofStart(Plugin, String)

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

Static factory method to create and start a Timing handler.

```APIDOC
## ofStart(Plugin plugin, String name)

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

### Method
Static method

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

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

### Returns
Timing Handler

### Deprecation
Deprecated, for removal: This API element is subject to removal in a future version.
```

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

### IndexHelpTopic.buildPreamble(CommandSender)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/command/class-use/CommandSender.html

Builds the topic preamble.

```APIDOC
## IndexHelpTopic.buildPreamble(CommandSender)

### Description
Builds the topic preamble.

### Method Signature
`protected @NotNull String buildPreamble(@NotNull CommandSender sender)`

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

### Returns
- **String** - The built preamble.
```

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

### getLimitedLifetimeTicks

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

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

```APIDOC
## getLimitedLifetimeTicks()

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

### Method
int getLimitedLifetimeTicks()

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

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

### void startCooking()

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

Re-enables cooking in all slots.

```APIDOC
## void startCooking()

### Description
Re-enables cooking in all slots.

### Method
`void startCooking()`
```

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

### getLimitedLifetimeTicks()

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

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

```APIDOC
## getLimitedLifetimeTicks()

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

### Method
`int getLimitedLifetimeTicks()`

### Returns
- **int** - The number of ticks remaining until the vex will start to take damage.

```

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

### hasLimitedLifetime

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

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

```APIDOC
## hasLimitedLifetime()

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

### Method
boolean hasLimitedLifetime()

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

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

### PluginDescriptionFile.getLoad()

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

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

```APIDOC
## PluginDescriptionFile.getLoad()

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

### Method
`@NotNull PluginLoadOrder getLoad()`

### Returns
`@NotNull PluginLoadOrder` - the load order phase
```

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

### buildPreamble(CommandSender) - Method in class org.bukkit.help.IndexHelpTopic

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

Builds the topic preamble.

```APIDOC
## [METHOD] buildPreamble(CommandSender)

### Description
Builds the topic preamble.

### Method
METHOD

### Endpoint
buildPreamble(CommandSender)

### Parameters
#### Path Parameters
- **CommandSender** (CommandSender) - Required - The command sender.

### Response
#### Success Response (200)
- **void** - No return value.

#### Response Example
```

```

```

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

### getLifeTicks()

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

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

```APIDOC
## getLifeTicks()

### Description
Deprecated. This API duplicates existing API which uses the more preferable name due to mirroring internals better. Gets the number of ticks remaining until the vex will start to take damage.

### Method
`int getLifeTicks()`

### Returns
- **int** - The number of ticks remaining until the vex will start to take damage.

```

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

### startWobble(DecoratedPot.WobbleStyle)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/block/DecoratedPot.html

Runs the specified animation on the decorated pot.

```APIDOC
## startWobble(DecoratedPot.WobbleStyle)

### Description
Runs the specified animation on the decorated pot.

### Method
startWobble

### Signature
void startWobble(@NotNull DecoratedPot.WobbleStyle style)

### Parameters
- **style** (DecoratedPot.WobbleStyle) - Required - The animation style.

### Throws
- **IllegalStateException** - if this block state is not placed.
```

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

### ofStart(Plugin, String, Timing)

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

Static factory method to create and start a Timing handler with a parent group handler.

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

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

### Method
Static method

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

### 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 Handler

### Deprecation
Deprecated, for removal: This API element is subject to removal in a future version.
```

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

### getTo

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/event/player/PlayerPortalEvent.html

Gets the destination location. For NETHER_PORTAL cause, this is initially just the starting point for the search for a portal to teleport to.

```APIDOC
## getTo

### Description
Gets the destination location. For NETHER_PORTAL cause, this is initially just the starting point for the search for a portal to teleport to.

### Method Signature
```java
@NotNull
public Location getTo()
```

### Returns
- **Location** - The destination location.
```

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

### startUsingItem(EquipmentSlot hand)

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

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

```APIDOC
## startUsingItem(EquipmentSlot hand)

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

### Method
startUsingItem

### Parameters
- **hand** (EquipmentSlot) - Required - The hand to start using.

### Return Type
void
```

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

### getGatewayCount

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/boss/DragonBattle.html

Gets the number of gateways tracked by this DragonBattle. The count starts at 0 and increases to 20 with each EnderDragon kill.

```APIDOC
## getGatewayCount

### Description
Gets the number of gateways tracked by this DragonBattle. This starts out at 0 and will increase to 20, once for each kill of the EnderDragon.

### Method
int getGatewayCount()

### Parameters
None

### Returns
int - the number of gateways around the end island tracked by this
```

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

### getTo

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/event/player/PlayerPortalEvent.html

Gets the destination location for the portal teleport. For NETHER_PORTAL, this is the starting point for the portal search; for END_PORTAL, it is the exact destination.

```APIDOC
## getTo

### Description
Gets the destination location for the portal teleport. For NETHER_PORTAL, this is the starting point for the portal search; for END_PORTAL, it is the exact destination.

### Method
GET

### Endpoint
PlayerPortalEvent.getTo()

### Parameters
None

### Response
#### Success Response
- **Location** - The destination location.

#### Response Example
```java
Location to = event.getTo();
```
```

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

### IndexHelpTopic.getFullText(CommandSender)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/command/class-use/CommandSender.html

Returns the full description of this help topic.

```APIDOC
## IndexHelpTopic.getFullText(CommandSender)

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

### Method Signature
`@NotNull String getFullText(@NotNull CommandSender sender)`

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

### Returns
- **String** - The full description text.
```

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

### getExample() - EquipmentSlotGroup

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

Deprecated. for internal compatibility use only

```APIDOC
## [GET] getExample()

### Description
Deprecated. for internal compatibility use only

### Method
GET

### Endpoint
getExample()

### Parameters
None

### Response
#### Success Response (200)
- **Object** - The example

#### Response Example
```json
{
  "example": null
}
```
```

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

### getTreasureLocation()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/entity/Dolphin.html

Gets the treasure location the dolphin tries to guide players to. This value is calculated when the dolphin has been fed a fish and is attempting the DOLPHIN_SWIM_TO_TREASURE goal.

```APIDOC
## getTreasureLocation()

### Description
Gets the treasure location this dolphin tries to guide players to. This value is calculated if the player has fed the dolphin a fish, and it tries to start the `VanillaGoal.DOLPHIN_SWIM_TO_TREASURE` goal.

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

### Returns
- **Location** - The calculated closest treasure location, or null if not available.
```

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

### getDeathAnimationTicks()

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

Get the current time in ticks relative to the start of this dragon's death animation. Returns 0 if the dragon is alive, and never exceeds 200.

```APIDOC
## getDeathAnimationTicks()

### Description
Get the current time in ticks relative to the start of this dragon's death animation. Returns 0 if the dragon is alive, and never exceeds 200.

### Method
`int getDeathAnimationTicks()`

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

```

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

### getServer()

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

Gets the current Server singleton.

```APIDOC
## getServer()

### Description
Gets the current `Server` singleton

### Method
static @NotNull Server getServer()

### Returns
- **Server** - The current server singleton.

```

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

### getServer()

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

Gets the current Server singleton.

```APIDOC
## getServer()

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

### Method
`static Server getServer()`

### Returns
- `Server` - Server instance being ran

```

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

### Resolve profile asynchronously and process on main thread

Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/datacomponent/item/ResolvableProfile.html

Shows how to use resolve() to get an updated PlayerProfile and then run a task on the server's main thread using Bukkit's scheduler. The example is from the documentation for the resolve() method, which warns not to block the main thread while waiting for the CompletableFuture.

```java
profile.resolve().thenAcceptAsync(updatedProfile -> {
    // Do something with the updated profile:
    // ...
}, runnable -> Bukkit.getScheduler().runTask(plugin, runnable));
```

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

### reason()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/event/player/PlayerKickEvent.html

Gets the reason why the player is getting kicked.

```APIDOC
## Method: reason()

### Description
Gets the reason why the player is getting kicked.

### Returns
- **Component** - The reason for the kick.

```

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

### JavaPlugin.init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger)

Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/plugin/configuration/class-use/PluginMeta.html

Initializes the JavaPlugin with the given parameters.

```APIDOC
## JavaPlugin.init(Server, PluginDescriptionFile, File, File, ClassLoader, PluginMeta, Logger)

### Description
Initializes the JavaPlugin with the given parameters.

### Method
final void init(Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader, @Nullable PluginMeta configuration, Logger logger)

### Parameters
- **server** (Server) - Required - The server instance.
- **description** (PluginDescriptionFile) - Required - The plugin description file.
- **dataFolder** (File) - Required - The data folder.
- **file** (File) - Required - The plugin file.
- **classLoader** (ClassLoader) - Required - The class loader.
- **configuration** (PluginMeta) - Optional - The plugin configuration.
- **logger** (Logger) - Required - The logger.
```

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

### width()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/configuration/file/YamlConfigurationOptions.html

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

```APIDOC
## YamlConfigurationOptions.width()

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

### Returns
Width value

```

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

### JavaPlugin.init(PluginLoader, Server, PluginDescriptionFile, File, File, ClassLoader)

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

Initializes the JavaPlugin with the given loader, server, description, data folder, file, and class loader.

```APIDOC
## JavaPlugin.init(PluginLoader, Server, PluginDescriptionFile, File, File, ClassLoader)

### Description
Initializes the JavaPlugin with the given parameters.

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

### Parameters
- **loader** (PluginLoader) - Required - The plugin loader.
- **server** (Server) - Required - The server instance.
- **description** (PluginDescriptionFile) - Required - The plugin description.
- **dataFolder** (File) - Required - The data folder.
- **file** (File) - Required - The plugin file.
- **classLoader** (ClassLoader) - Required - The class loader.

```

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

### FurnaceStartSmeltEvent constructor (2 args)

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

Constructs a new FurnaceStartSmeltEvent with the given furnace, source, and recipe.

```APIDOC
## Constructor: FurnaceStartSmeltEvent(Block, ItemStack, CookingRecipe<?>)

### Description
Creates a new FurnaceStartSmeltEvent.

### Parameters
- `furnace` (Block) - The furnace block.
- `source` (ItemStack) - The source item.
- `recipe` (CookingRecipe<?>) - The cooking recipe.

```

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

### get(String path)

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

Gets the requested Object by path.

```APIDOC
## get(String path)

### Description
Gets the requested Object by path.

### Method
@Nullable Object get(@NotNull String path)

### Parameters
- **path** (String) - Required - The path to get the value from.

### Returns
Object - The value at the path, or null if not found.
```

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

### FurnaceStartSmeltEvent constructor (3 args)

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

Constructs a new FurnaceStartSmeltEvent with the given furnace, source, recipe, and cooking time.

```APIDOC
## Constructor: FurnaceStartSmeltEvent(Block, ItemStack, CookingRecipe<?>, int)

### Description
Creates a new FurnaceStartSmeltEvent with a specified cooking time.

### Parameters
- `furnace` (Block) - The furnace block.
- `source` (ItemStack) - The source item.
- `recipe` (CookingRecipe<?>) - The cooking recipe.
- `cookingTime` (int) - The cooking time in ticks.

```

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

### get(RegistryKey, NamespacedKey)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/UnsafeValues.html

Gets a value from the given registry.

```APIDOC
## get(RegistryKey, NamespacedKey)

### Description
Gets a value from the given registry.

### Method
get

### Parameters
- `registry` (RegistryKey<B>) - Required - the registry
- `key` (NamespacedKey) - Required - the key

### Returns
- (B) - the value
```

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

### get(Class, String)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/UnsafeValues.html

Gets a value from the given class.

```APIDOC
## get(Class, String)

### Description
Gets a value from the given class.

### Method
get

### Parameters
- `aClass` (Class) - Required - the class
- `value` (String) - Required - the value

### Returns
- (String) - the value
```

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

### startPlaying()

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

Starts the jukebox playing if there is a record.

```APIDOC
## startPlaying()

### Description
Starts the jukebox playing if there is a record.

### Method
`boolean startPlaying()`

### Returns
- **boolean** - true if the jukebox had a record and was able to start playing, false if the jukebox was already playing or did not have a record.
```

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

### HelpTopicFactory.createTopic(TCommand)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/help/HelpTopicFactory.html

Documentation for the HelpTopicFactory interface and its createTopic method.

```APIDOC
## Interface HelpTopicFactory<TCommand extends Command>

### Description
A HelpTopicFactory is used to create custom HelpTopic objects from commands that inherit from a common base class or have executors that inherit from a common base class. It allows plugins to customize how their commands appear in the help system.

### Method
createTopic

### Signature
@Nullable HelpTopic createTopic(@NotNull TCommand command)

### Parameters
- **command** (TCommand) - Required - The custom command to build a help topic for.

### Returns
A new custom help topic or null to intentionally NOT create a topic.

### Usage
To automatically bind your plugin's commands to your custom HelpTopic implementation, first make sure all your commands or executors derive from a custom base class. Next implement a custom HelpTopicFactory that accepts your custom command base class and instantiates an instance of your custom HelpTopic from it. Finally, register your HelpTopicFactory against your command base class using the HelpMap.registerHelpTopicFactory(Class, HelpTopicFactory) method.
```

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

### get(NamespacedKey) - Method in interface org.bukkit.Registry

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

Get the object by its key.

```APIDOC
## [GET] get(NamespacedKey)

### Description
Get the object by its key.

### Method
GET

### Endpoint
get(NamespacedKey)

### Parameters
#### Path Parameters
- **key** (NamespacedKey) - Required - The namespaced key.

### Response
#### Success Response (200)
- **return** (Object) - The object associated with the key.

#### Response Example
{
  "return": "<object>"
}
```

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

### get(Key) - Method in interface org.bukkit.Registry

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

Get the object by its key.

```APIDOC
## [GET] get(Key)

### Description
Get the object by its key.

### Method
GET

### Endpoint
get(Key)

### Parameters
#### Path Parameters
- **key** (Key) - Required - The key.

### Response
#### Success Response (200)
- **return** (Object) - The object associated with the key.

#### Response Example
{
  "return": "<object>"
}
```

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

### HelpTopic.getFullText(CommandSender)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/command/class-use/CommandSender.html

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

```APIDOC
## HelpTopic.getFullText(CommandSender)

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

### Method Signature
`@NotNull String getFullText(@NotNull CommandSender forWho)`

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

### Returns
- **String** - The full description text.
```

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

### getReason()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/event/player/PlayerKickEvent.html

Gets the reason why the player is getting kicked. Deprecated in favour of reason().

```APIDOC
## Method: getReason()

### Description
Gets the reason why the player is getting kicked. Deprecated in favour of reason().

### Returns
- **String** - The reason for the kick.

```

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

### PluginBootstrap.createPlugin(PluginProviderContext)

Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/plugin/bootstrap/class-use/PluginProviderContext.html

Documentation for the PluginBootstrap.createPlugin method, which is called by the server to instantiate the plugin's main class.

```APIDOC
## PluginBootstrap.createPlugin(PluginProviderContext)

### Description
Called by the server to instantiate your main class. This method is part of the PluginBootstrap interface and receives a PluginProviderContext to provide necessary context during plugin instantiation.

### Method
createPlugin

### Signature
`default JavaPlugin createPlugin(PluginProviderContext context)`

### Parameters
- **context** (PluginProviderContext) - Required - The context provided to the plugin bootstrap, containing information needed to create the plugin instance.

### Returns
- **JavaPlugin** - The instantiated plugin main class.

### Usage
This method is called by the server during the plugin bootstrapping process. Implement it to return your plugin's main class instance.
```

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

### get(TypedKey) - Method in interface org.bukkit.Registry

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

Get the object by its typed key.

```APIDOC
## [GET] get(TypedKey)

### Description
Get the object by its typed key.

### Method
GET

### Endpoint
get(TypedKey)

### Parameters
#### Path Parameters
- **key** (TypedKey) - Required - The typed key.

### Response
#### Success Response (200)
- **return** (Object) - The object associated with the key.

#### Response Example
{
  "return": "<object>"
}
```

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

### Timings.ofStart(Plugin, String)

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

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

```APIDOC
## [STATIC METHOD] Timings.ofStart(Plugin, String)

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

### Method
Static method

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

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

### Returns
- **Timing** - The started Timing object
```

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

### getLoadOrder()

Source: https://jd.papermc.io/paper/26.1.2/io/papermc/paper/plugin/configuration/PluginMeta.html

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

```APIDOC
## getLoadOrder()

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

### Method
`PluginLoadOrder getLoadOrder()`

### Returns
- **PluginLoadOrder** - the plugin load order

### See Also
- For further details regards the available load orders.
```

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

### get(int, int) - Method in class org.bukkit.map.MapFont.CharacterSprite

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

Get the value of a pixel of the character.

```APIDOC
## [GET] get(int, int)

### Description
Get the value of a pixel of the character.

### Method
GET

### Endpoint
get(int, int)

### Parameters
#### Path Parameters
- **row** (int) - Required - The row of the pixel.
- **col** (int) - Required - The column of the pixel.

### Response
#### Success Response (200)
- **return** (boolean) - The value of the pixel (true if set, false otherwise).

#### Response Example
{
  "return": true
}
```

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

### startUsingItem

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

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

```APIDOC
## startUsingItem

### Description
Starts using the item in the specified hand, making it the currently active item. When, for example, called on a skeleton, this will cause it to start drawing its bow. Only HAND or OFF_HAND may be used for the hand parameter. When used on a player, the client will stop using the item if right click is held down. This method does not make any guarantees about the effect of this method as such depends on the entity and its state.

### Method
void

### Signature
@Experimental void startUsingItem(@NotNull EquipmentSlot hand)

### Parameters
- **hand** (EquipmentSlot) - Required - the hand that contains the item to be used

### Returns
void
```

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

### useBed()

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/event/player/PlayerBedEnterEvent.html

Returns the current action to take with the bed.

```APIDOC
## Method: useBed

### Description
This controls the action to take with the bed that was clicked on. In case of `Event.Result.DEFAULT`, the default outcome is described by `enterAction()`.

### Method Signature
```java
@NotNull
public @NotNull Event.Result useBed()
```

### Returns
- **Event.Result** - The action to take with the interacted bed.

### See Also
- `setUseBed(Result)`
```

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

### boolean get(int row, int col)

Source: https://jd.papermc.io/paper/26.1.2/org/bukkit/map/MapFont.CharacterSprite.html

Gets the value of a pixel of the character sprite.

```APIDOC
## boolean get(int row, int col)

### Description
Gets the value of a pixel of the character.

### Method
public boolean get(int row, int col)

### Parameters
- **row** (int) - Required - The row, in the range [0,8).
- **col** (int) - Required - The column, in the range [0,8).

### Returns
True if the pixel is solid, false if transparent.

```

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

### FurnaceStartSmeltEvent

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

Documentation for the FurnaceStartSmeltEvent class, including constructors and methods.

```APIDOC
## FurnaceStartSmeltEvent

### Description
Called when any of the furnace-like blocks start smelting. Furnace-like blocks are `Furnace`, `Smoker`, and `BlastFurnace`.

### Constructor

#### `FurnaceStartSmeltEvent(Block furnace, ItemStack source, CookingRecipe<?> recipe)`
- Deprecated, for removal: This API element is subject to removal in a future version.
- Parameters:
  - `furnace` (Block) - The furnace block.
  - `source` (ItemStack) - The source item.
  - `recipe` (CookingRecipe<?>) - The cooking recipe.

#### `FurnaceStartSmeltEvent(Block furnace, ItemStack source, CookingRecipe<?> recipe, int cookingTime)`
- Parameters:
  - `furnace` (Block) - The furnace block.
  - `source` (ItemStack) - The source item.
  - `recipe` (CookingRecipe<?>) - The cooking recipe.
  - `cookingTime` (int) - The total cooking time.

### Methods

#### `getRecipe()`
- Returns: `CookingRecipe<?>` - The FurnaceRecipe being cooked.

#### `getTotalCookTime()`
- Returns: `int` - The total cook time.

#### `setTotalCookTime(int cookTime)`
- Parameters:
  - `cookTime` (int) - The new total cook time.
```
Tokens:
Raw