Paper API

https://jd.papermc.io/paper/1.21.11
Admin
Paper API is a plugin development framework for Minecraft servers that provides comprehensive...
Tokens:5,491,143
Snippets:76,720
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### start()

Source: https://jd.papermc.io/paper/1.21.11/com/destroystokyo/paper/entity/ai/Goal.html

Called when this goal gets activated.

```APIDOC
## start()

### Description
Called when this goal gets activated.

### Method
default void start()
```

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

### start(Location start)

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

Sets the starting location for the raytrace.

```APIDOC
## start(Location start)

### Description
Sets the starting location for the raytrace.

### Method
start

### Signature
PositionedRayTraceConfigurationBuilder start(Location start)

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

### Returns
A reference to this object.
```

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

### Example

Source: https://jd.papermc.io/paper/1.21.11/org/bukkit/inventory/meta/AxolotlBucketMeta.html

Example

```APIDOC
## [METHOD] [ENDPOINT]

### Description
[Brief]
```

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

### Timings.ofStart(Plugin, String)

Source: https://jd.papermc.io/paper/1.21.11/co/aikar/timings/class-use/Timing.html

Returns a Timing object after starting it, useful for Java7 try-with-resources. This method starts the timing immediately.

```APIDOC
## Timings.ofStart(Plugin, String)

### Description
Returns a Timing object after starting it, useful for Java7 try-with-resources. This method starts the timing immediately.

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

### Parameters
- `plugin` (Plugin) - Required - The plugin for which the timing is created.
- `name` (String) - Required - The name of the timing.

### Returns
- `@NotNull Timing` - The Timing instance that has already been started.

### Deprecation
Deprecated, for removal: This API element is subject to removal in a future version. Timings will be removed in the future.
```

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

### getUsage()

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

Gets an example usage of this command.

```APIDOC
## getUsage()

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

### Method
`@NotNull public @NotNull String getUsage()`

### Returns
- **String** - One or more example usages

```

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

### getUsage()

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

Gets an example usage of this command.

```APIDOC
## getUsage()

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

### Method
`@NotNull String getUsage()`

### Returns
- **String** - The usage string.
```

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

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

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

Initializes the plugin with the given server, description, data folder, file, class loader, configuration, and logger. This method is final and called by the plugin loader.

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

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

### Method
init

### Signature
public 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 for the plugin.
- **file** (File) - Required - The plugin file.
- **classLoader** (ClassLoader) - Required - The class loader for the plugin.
- **configuration** (PluginMeta) - Optional - The plugin configuration metadata.
- **logger** (Logger) - Required - The logger for the plugin.

### Returns
void
```

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

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

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

Builds the topic preamble.

```APIDOC
## buildPreamble(CommandSender)

### Description
Builds the topic preamble.

### Method
Method

### Signature
`buildPreamble(CommandSender)`

### Parameters
- **CommandSender** - The command sender.
```

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

### org.bukkit.Raid.isStarted()

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

Get whether this raid started.

```APIDOC
## isStarted()

### Description
Get whether this raid started.

### Method
isStarted()

### Interface
org.bukkit.Raid

### Returns
boolean - true if started, false otherwise
```

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

### getLoad() - PluginDescriptionFile

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

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

```APIDOC
## getLoad() - Method in class org.bukkit.plugin.PluginDescriptionFile

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

### Method
GET

### Endpoint
org.bukkit.plugin.PluginDescriptionFile#getLoad()

### Returns
The load phase.
```

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

### startUsingItem(EquipmentSlot)

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

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

```APIDOC
## startUsingItem(EquipmentSlot)

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

### Method
startUsingItem

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

### Returns
void
```

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

### getUsage() - org.bukkit.command.Command

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

Gets an example usage of this command.

```APIDOC
## getUsage()

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

### Method
GET

### Endpoint
org.bukkit.command.Command#getUsage()

### Parameters
None

### Response
#### Success Response
- **return** (String) - An example usage of this command.

```

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

### plugin.yml load: STARTUP configuration

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

Add this to plugin.yml to ensure the plugin is loaded at server startup so WorldInitEvent is called for every world.

```yaml
load: STARTUP
```

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

### getStartLevel() - org.bukkit.enchantments.Enchantment

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

Gets the level that this Enchantment should start at.

```APIDOC
## getStartLevel()

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

### Method
`getStartLevel()`

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

```

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

### getTreasureLocation() - org.bukkit.entity.Dolphin

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

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

```APIDOC
## getTreasureLocation() - Method in interface org.bukkit.entity.Dolphin

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

### Method
getTreasureLocation()

### Return Type
Location (implied)
```

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

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

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

Initializes the plugin with the given parameters.

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

### Description
Initializes the plugin 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.
- **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.
```

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

### getLimitedLifetimeTicks() - org.bukkit.entity.Vex

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

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

```APIDOC
## getLimitedLifetimeTicks()

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

### Method
GET

### Endpoint
org.bukkit.entity.Vex#getLimitedLifetimeTicks()

### Parameters
None

### Response
#### Success Response (200)
- **int** - The limited lifetime ticks.

#### Response Example
```json
{
  "limitedLifetimeTicks": 100
}
```
```

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

### startCooking()

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

Re-enables cooking in all slots.

```APIDOC
## startCooking()

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

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

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

### hasLimitedLifetime()

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

Gets if this Vex should start to take damage once its limited lifetime ticks reach zero.

```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` - True if the Vex has a limited lifetime, false otherwise.
```

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

### DecoratedPot.startWobble(DecoratedPot.WobbleStyle style)

Source: https://jd.papermc.io/paper/1.21.11/org/bukkit/block/class-use/DecoratedPot.WobbleStyle.html

Run the specified animation on the decorated pot.

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

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

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

### Parameters
- **style** (DecoratedPot.WobbleStyle) - Required - The wobble style to run on the decorated pot.

### Returns
- **void** - This method does not return a value.
```

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

### getExample()

Source: https://jd.papermc.io/paper/1.21.11/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. Deprecated for internal compatibility use only.

### Method
`@NotNull @Deprecated(since="1.20.5") @Internal public @NotNull EquipmentSlot getExample()`

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

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

### begin()

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

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

```APIDOC
## Method: void begin()

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

### Return Type
void

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

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

### begin()

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

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

```APIDOC
## begin()

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

### Method
public void begin()

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

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

### getVoidDamageMinBuildHeightOffset() - org.bukkit.World

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

Gets the offset applied to `WorldInfo.getMinHeight()` to determine the height at which void damage starts to apply.

```APIDOC
## getVoidDamageMinBuildHeightOffset()

### Description
Gets the offset applied to `WorldInfo.getMinHeight()` to determine the height at which void damage starts to apply.

### Method
GET

### Interface
org.bukkit.World

### Returns
int - The offset.
```

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

### getDeathAnimationTicks() - org.bukkit.entity.EnderDragon

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

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

```APIDOC
## getDeathAnimationTicks() - Method in interface org.bukkit.entity.EnderDragon

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

### Method
GET

### Endpoint
org.bukkit.entity.EnderDragon#getDeathAnimationTicks()

### Parameters
None

### Response
#### Success Response (200)
- **int** - The death animation ticks

#### Response Example
```json
{
  "ticks": 0
}
```
```

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

### getLastToken()

Source: https://jd.papermc.io/paper/1.21.11/org/bukkit/event/player/PlayerChatTabCompleteEvent.html

Gets the last 'token' of the message being tab-completed. The token is the substring starting with the character after the last space in the message.

```APIDOC
## getLastToken()

### Description
Gets the last 'token' of the message being tab-completed. The token is the substring starting with the character after the last space in the message.

### Method
`@NotNull public @NotNull String getLastToken()`

### Returns
- **String** - The last token for the chat message

### Deprecated
This method is deprecated.
```

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

### PlayerConnectionInitialConfigureEvent Class

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

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

```APIDOC
## Class: PlayerConnectionInitialConfigureEvent

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

### Constructor
`PlayerConnectionInitialConfigureEvent(PlayerConfigurationConnection)`

### Parameters
- `PlayerConfigurationConnection` (PlayerConfigurationConnection) - The connection being configured.
```

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

### getTo()

Source: https://jd.papermc.io/paper/1.21.11/org/bukkit/event/entity/EntityPortalEvent.html

Gets the destination location for the portal event. For NETHER portals, this is the starting point for portal search; for ENDER portals, it is the exact destination.

```APIDOC
## getTo()

### Description
Gets the destination location for the portal event. For NETHER portals, this is the starting point for portal search; for ENDER portals, it is the exact destination.

### Method Signature
`@Nullable public @Nullable Location getTo()`

### Returns
- `Location` - The starting point for search or exact destination, or null if not set.

### Overrides
- `getTo` in class `EntityTeleportEvent`
```

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

### getServer()

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

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

### plugin.yml: awareness example

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

YAML snippet showing how to declare plugin awareness flags in plugin.yml. The awareness list must be in YAML list format, and each entry starts with !@.

```yaml
awareness:
- !@UTF8
```

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

### PositionedRayTraceConfigurationBuilder.start(Location)

Source: https://jd.papermc.io/paper/1.21.11/io/papermc/paper/raytracing/class-use/PositionedRayTraceConfigurationBuilder.html

Sets the starting location.

```APIDOC
## PositionedRayTraceConfigurationBuilder.start(Location)

### Description
Sets the starting location.

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

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

### Returns
`PositionedRayTraceConfigurationBuilder` - This builder instance for chaining.

```

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

### getHelpMap() - org.bukkit.Bukkit (static)

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

Gets the HelpMap providing help topics for this server.

```APIDOC
## getHelpMap()

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

### Method
GET

### Class
org.bukkit.Bukkit (static)

### Returns
HelpMap - The help map.
```

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

### width()

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

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

```APIDOC
## width()

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

### Method
width

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

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

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

Source: https://jd.papermc.io/paper/1.21.11/org/bukkit/command/defaults/BukkitCommand.html

Protected constructor that creates a BukkitCommand with the specified name, description, usage message, and aliases.

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

### Description
Protected constructor that creates a BukkitCommand with the specified name, description, usage message, and aliases.

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

### Parameters
- **name** (String) - Required - The command name.
- **description** (String) - Required - The command description.
- **usageMessage** (String) - Required - The usage message.
- **aliases** (List<String>) - Required - The list of aliases.
```

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

### width()

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

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

```APIDOC
## width()

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

### Method
width

### Returns
- `int` - The maximum line width.
```

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

### build()

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

Builds the BookMeta instance.

```APIDOC
## build()

### Description
Builds the BookMeta. Deprecated for removal: BookMeta is mutable, there is no need for a builder.

### Method
`@NotNull BookMeta build()`

### Returns
`@NotNull BookMeta` - the built BookMeta

### Deprecation
Deprecated for removal since 1.21.11.
```

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

### getBlockState() - FallingBlock

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

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

```APIDOC
## getBlockState()

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

### Method
GET

### Endpoint
org.bukkit.entity.FallingBlock#getBlockState()

### Returns
BlockState of the falling block.
```

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

### init(PluginLoader, Server, PluginDescriptionFile, File, File, ClassLoader) - Method in class org.bukkit.plugin.java.JavaPlugin

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

Initializes the JavaPlugin with the given parameters.

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

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

### Method
init

### Parameters
- **loader** (PluginLoader) - The plugin loader.
- **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.

### Containing Class
org.bukkit.plugin.java.JavaPlugin

```

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

### reason()

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

Gets the reason why the player is getting kicked as a Component.

```APIDOC
## Method: reason()

### Description
Gets the reason why the player is getting kicked as a Component.

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

### Example
```java
Component reason = event.reason();
```
```

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

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

Source: https://jd.papermc.io/paper/1.21.11/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 loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader)

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

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

### Usage Example
```java
javaPlugin.init(loader, server, description, dataFolder, file, classLoader);
```
```

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

### reason() - PlayerKickEvent

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

Gets the reason why the player is getting kicked.

```APIDOC
## reason()

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

### Method
reason

### Parameters
None

### Returns
Component
```

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

### startPlaying()

Source: https://jd.papermc.io/paper/1.21.11/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** - Whether the jukebox started playing.
```

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

### get(NamespacedKey)

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

Get the object by its key. Returns null if not found.

```APIDOC
## get(NamespacedKey)

### Description
Get the object by its key.

### Method
`@Nullable T get(NamespacedKey key)`

### Parameters
- **key** (NamespacedKey) - Required - The key of the object.

### Returns
- **T** (nullable) - The object associated with the key, or null if not found.

```

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

### get(Key)

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

Get the object by its key. Returns null if not found.

```APIDOC
## get(Key)

### Description
Get the object by its key.

### Method
`default @Nullable T get(Key key)`

### Parameters
- **key** (Key) - Required - The key of the object.

### Returns
- **T** (nullable) - The object associated with the key, or null if not found.

```

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

### getFullText(CommandSender) - org.bukkit.help.HelpTopic

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

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

```APIDOC
## getFullText(CommandSender)

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

### Method
GET

### Class
org.bukkit.help.HelpTopic

### Parameters
- **CommandSender** - The command sender requesting the full text.

### Returns
- **String** - The full description of the help topic.
```

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

### get (Class, String)

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

Deprecated. Internal method to get a value from a class.

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

### Description
Deprecated. Internal method to get a value from a class.

### Method
get

### Parameters
- `aClass` (Class<?>) - Required - The class
- `value` (String) - Required - The value

### Returns
- String
```

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

### Constructor: PluginDescriptionFile(String, String, String)

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

Creates a new PluginDescriptionFile with the given plugin name, version, and main class.

```APIDOC
## Constructor: PluginDescriptionFile(String, String, String)

### Description
Creates a new PluginDescriptionFile with the given detailed information.

### Signature
`public PluginDescriptionFile(@NotNull String pluginName, @NotNull String pluginVersion, @NotNull String mainClass)`

### Parameters
- **pluginName** (String) - The name of the plugin.
- **pluginVersion** (String) - The version of the plugin.
- **mainClass** (String) - The fully qualified name of the main class.
```

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

### getModZ() - org.bukkit.block.BlockFace

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

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

```APIDOC
## getModZ()

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

### Method
getModZ

### Returns
The Z-coordinate modifier.
```

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

### buildInfo()

Source: https://jd.papermc.io/paper/1.21.11/io/papermc/paper/ServerBuildInfo.html

Gets the ServerBuildInfo instance.

```APIDOC
## buildInfo()

### Description
Gets the `ServerBuildInfo`.

### Method
`static ServerBuildInfo buildInfo()`

### Returns
- `ServerBuildInfo` - the `ServerBuildInfo`

```

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

### startWobble(DecoratedPot.WobbleStyle)

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

Runs the specified wobble animation on the decorated pot. Throws IllegalStateException if the block state is not placed.

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

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

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

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

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

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

### getModY() - org.bukkit.block.BlockFace

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

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

```APIDOC
## getModY()

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

### Method
getModY

### Returns
The Y-coordinate modifier.
```

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

### getModX() - org.bukkit.block.BlockFace

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

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

```APIDOC
## getModX()

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

### Method
getModX

### Returns
The X-coordinate modifier.
```

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

### org.bukkit.block.Jukebox.startPlaying()

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

Starts the jukebox playing if there is a record.

```APIDOC
## startPlaying()

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

### Method
startPlaying()

### Return Type
void

### Parameters
None

```

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

### get(TypedKey<T>)

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

Get the object by its typed key. Returns null if not found.

```APIDOC
## get(TypedKey<T>)

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

### Method
`default @Nullable T get(TypedKey<T> typedKey)`

### Parameters
- **typedKey** (TypedKey<T>) - Required - The typed key of the object.

### Returns
- **T** (nullable) - The object associated with the key, or null if not found.

```

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

### Command(String, String, String, List<String>) - Constructor

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

Creates a new Command with the specified name, description, usage message, and aliases.

```APIDOC
## Command(String, String, String, List<String>)

### Description
Creates a new Command with the specified name, description, usage message, and aliases.

### Method
Constructor

### Signature
`Command(String name, String description, String usageMessage, List<String> aliases)`

### Parameters
- **name** (String) - Required - The command name.
- **description** (String) - Required - The command description.
- **usageMessage** (String) - Required - The usage message.
- **aliases** (List<String>) - Required - The list of aliases.
```

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

### get (RegistryKey, NamespacedKey)

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

Deprecated. Internal method to get a keyed value from a registry.

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

### Description
Deprecated. Internal method to get a keyed value from a registry.

### Method
get

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

### Returns
- B (nullable)
```

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

### SimpleCommandMap(Server server, Map<String,Command> backing)

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

Constructor for SimpleCommandMap that accepts a Server instance and a backing map of commands.

```APIDOC
## SimpleCommandMap(Server server, Map<String,Command> backing)

### Description
Constructor for SimpleCommandMap that accepts a Server instance and a backing map of commands.

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

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

### Usage Example
```java
SimpleCommandMap commandMap = new SimpleCommandMap(server, backingMap);
```
```

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

### get(Class<?> aClass, String value)

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

Deprecated. Gets a value from a class by string.

```APIDOC
## get(Class<?> aClass, String value)

### Description
Deprecated. Gets a value from a class by string.

### Method
get

### Parameters
- `aClass` (Class<?>) - Required - The class.
- `value` (String) - Required - The string value.

### Returns
String

```

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

### IndexHelpTopic.buildPreamble(CommandSender)

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

Builds the topic preamble for a given command sender.

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

### Description
Builds the topic preamble.

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

### Parameters
- **sender** (CommandSender) - Required - The command sender for whom the preamble is built.

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

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

### IndexHelpTopic.getFullText(CommandSender)

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

Returns the full description of this index help topic for a given sender.

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

### Description
Returns the full description of this index help topic for a given sender.

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

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

### Returns
- **String** - The full description of the help topic.
```

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

### getReason()

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

Deprecated. Gets the reason why the player is getting kicked as a String. Use reason() instead.

```APIDOC
## Method: getReason()

### Description
Deprecated. Gets the reason why the player is getting kicked as a String. Use reason() instead.

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

### Example
```java
String reason = event.getReason();
```
```

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

### get(RegistryKey<B> registry, NamespacedKey key)

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

Deprecated. Gets a value from a registry by key.

```APIDOC
## get(RegistryKey<B> registry, NamespacedKey key)

### Description
Deprecated. Gets a value from a registry by key.

### Method
get

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

### Returns
B

```

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

### getFullText(CommandSender) - org.bukkit.help.IndexHelpTopic

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

Returns the full description of this help topic.

```APIDOC
## getFullText(CommandSender)

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

### Method
GET

### Class
org.bukkit.help.IndexHelpTopic

### Parameters
- **CommandSender** - The command sender requesting the full text.

### Returns
- **String** - The full description of the help topic.
```

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

### get(int row, int col)

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

Gets the value of a pixel of the character at the specified row and column.

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

### Description
Gets the value of a pixel of the character at the specified row and column.

### 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
- `boolean` - True if the pixel is solid, false if transparent.
```

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

### IndexHelpTopic Constructor (with preamble)

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

Creates an IndexHelpTopic with a name, short text, permission, collection of topics, and an optional preamble. The preamble is displayed before the first item in the index.

```APIDOC
## IndexHelpTopic Constructor (with preamble)

### Description
Creates an IndexHelpTopic with a name, short text, permission, collection of topics, and an optional preamble. The preamble is displayed before the first item in the index.

### Method
Constructor

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

### Parameters
- **name** (String) - Required - The name of the help topic.
- **shortText** (String) - Optional - A short description of the topic.
- **permission** (String) - Optional - The permission required to see this topic.
- **topics** (Collection<HelpTopic>) - Required - The collection of help topics to include in the index.
- **preamble** (String) - Optional - Text displayed before the first item in the index.

### Usage Example
```java
Collection<HelpTopic> topics = new ArrayList<>();
IndexHelpTopic index = new IndexHelpTopic("MyIndex", "My index", "my.permission", topics, "Welcome to my index");
```
```
Tokens:
Raw