Spigot-API

https://hub.spigotmc.org/javadocs/spigot
Admin
Spigot-API provides the Java documentation for developing plugins for the Spigot Minecraft server,...
Tokens:1,576,489
Snippets:14,537
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Placement Material Examples

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/data/BlockData.html

Examples showing how specific block materials map to their corresponding placement materials.

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

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

### Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/metadata/MetadataStoreBase.html

Initializes a new instance of the MetadataStoreBase class.

```APIDOC
## Constructor MetadataStoreBase

### Description
Initializes a new instance of the `MetadataStoreBase` class.

### Method
`public MetadataStoreBase()`
```

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

### getStartLevel()

Source: https://hub.spigotmc.org/javadocs/spigot/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

### Returns
(int) The starting level of the enchantment.
```

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

### SpawnerEntry.Equipment Usage

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/spawner/class-use/SpawnerEntry.Equipment.html

Demonstrates how to get and set the equipment for a SpawnerEntry.

```APIDOC
## SpawnerEntry.Equipment

### Description
Represents the equipment that will be applied to a spawned entity.

### Methods

#### `getEquipment()`

##### Description
Gets the equipment which will be applied to the spawned entity.

##### Returns
- `SpawnerEntry.Equipment` - The equipment for the spawned entity.

#### `setEquipment(SpawnerEntry.Equipment equipment)`

##### Description
Sets the equipment which will be applied to the spawned entity.

##### Parameters
- **equipment** (`SpawnerEntry.Equipment`) - Required - The equipment to set.

### Constructors

#### `SpawnerEntry(EntitySnapshot snapshot, int spawnWeight, SpawnRule spawnRule, SpawnerEntry.Equipment equipment)`

##### Description
Constructs a new SpawnerEntry with the specified parameters, including equipment.

##### Parameters
- **snapshot** (`EntitySnapshot`) - Required - The entity snapshot.
- **spawnWeight** (`int`) - Required - The spawn weight.
- **spawnRule** (`SpawnRule`) - Required - The spawn rule.
- **equipment** (`SpawnerEntry.Equipment`) - Required - The equipment to apply.
```

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

### Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/SimplePluginManager.html

Initializes a new instance of the SimplePluginManager.

```APIDOC
## Constructor Details
### SimplePluginManager
public SimplePluginManager(@NotNull Server instance, @NotNull SimpleCommandMap commandMap)
```

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

### Get Specific Line

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/sign/SignSide.html

Retrieves the line of text at a specific index on this side of the sign. Line indexing starts at 0.

```APIDOC
## getLine

### Description
Gets the line of text at the specified index on this side of the sign. For example, getLine(0) will return the first line of text.

### Method
`String getLine(int index)`

### Parameters
* **index** (int) - Line number to get the text from, starting at 0

### Returns
Text on the given line

### Throws
* `IndexOutOfBoundsException` - Thrown when the line does not exist
```

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

### BookMeta.Spigot Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/BookMeta.Spigot.html

Initializes a new instance of the Spigot BookMeta class.

```APIDOC
## Spigot()

### Description
Constructs a new Spigot BookMeta object.

### Method
`Spigot()`

### Endpoint
N/A (Constructor)
```

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

### getBuffer

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/generator/LimitedRegion.html

Gets the buffer around the central chunk which is accessible. The returned value is in normal world coordinate scale. For example: If the method returns 16 you have a working area of 48x48.

```APIDOC
## getBuffer

### Description
Gets the buffer around the central chunk which is accessible. The returned value is in normal world coordinate scale.

### Returns
- The buffer in X and Z direction (int)
```

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

### Get Recipe

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Server.html

Get the Recipe for the given key.

```APIDOC
## getRecipe

### Description
Get the `Recipe` for the given key.

### Parameters
* `recipeKey` (NamespacedKey) - the key of the recipe to return

### Returns
* `Recipe` - the recipe for the given key or null.
```

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

### Getting the HelpMap

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/class-use/HelpMap.html

You can obtain the HelpMap instance from either the Bukkit static class or the Server instance. The HelpMap provides access to help topics registered on the server.

```APIDOC
## Bukkit.getHelpMap()

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

### Method
`static HelpMap`

### Endpoint
N/A (Static method)

## Server.getHelpMap()

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

### Method
`HelpMap`

### Endpoint
N/A (Instance method)
```

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

### Get Horse Style

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.html

Gets the horse's style.

```APIDOC
Horse.Style getStyle()
Gets the horse's style.
```

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

### Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/SimpleServicesManager.html

Initializes a new instance of the SimpleServicesManager class.

```APIDOC
## SimpleServicesManager()

### Description
Initializes a new instance of the SimpleServicesManager class.

### Constructor
`SimpleServicesManager()`
```

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

### getLoad

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/PluginDescriptionFile.html

Retrieves the phase of server startup at which the plugin should be loaded.

```APIDOC
### getLoad 
@NotNull public PluginLoadOrder getLoad()
Gives the phase of server startup that the plugin should be loaded. 
  * Possible values are in `PluginLoadOrder`. 
  * Defaults to `PluginLoadOrder.POSTWORLD`. 
  * Certain caveats apply to each phase. 
```

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

### Get Horse Color

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/Horse.html

Gets the horse's color.

```APIDOC
Horse.Color getColor()
Gets the horse's color.
```

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

### Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/map/MinecraftFont.html

Initializes a new instance of the MinecraftFont class.

```APIDOC
## Constructor: MinecraftFont()

### Description
Initialize a new MinecraftFont.

### Signature
`public MinecraftFont()`
```

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

### Get World by Name

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Gets the world with the given name.

```APIDOC
## getWorld

### Description
Gets the world with the given name.

### Parameters
#### Path Parameters
- `name` (String) - The name of the world to retrieve

### Returns
- a world with the given name, or null if none exists
```

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

### Constructor

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/permissions/PermissibleBase.html

Initializes a new PermissibleBase instance.

```APIDOC
## Constructor PermissibleBase

### Description
Initializes a new PermissibleBase instance.

### Parameters
* **opable** (ServerOperator) - The server operator associated with this permissible base.
```

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

### Get Plugin Command

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Gets a PluginCommand with the given name or alias.

```APIDOC
## getPluginCommand

### Description
Gets a `PluginCommand` with the given name or alias.

### Parameters
#### Path Parameters
- `name` (String) - The name of the plugin command to retrieve

### Returns
- a `PluginCommand` with the given name, or null if none exists
```

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

### Server Instance Management

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Methods for setting the server instance and spawn radius.

```APIDOC
## setServer(Server server)

### Description
Attempts to set the `Server` singleton.

### Returns
`static void`
```

```APIDOC
## setSpawnRadius(int value)

### Description
Sets the radius, in blocks, around each worlds spawn point to protect.

### Returns
`static void`
```

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

### Get World by UUID

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Gets the world from the given Unique ID.

```APIDOC
## getWorld

### Description
Gets the world from the given Unique ID.

### Parameters
#### Path Parameters
- `uid` (UUID) - A unique ID of the world to retrieve

### Returns
- a world with the given Unique ID, or null if none exists
```

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

### Server.Spigot.getConfig()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/configuration/file/class-use/YamlConfiguration.html

Gets the server's main configuration file.

```APIDOC
## Server.Spigot.getConfig()

### Description
Gets the server's main configuration file.

### Method
YamlConfiguration
```

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

### LightningStrike Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/LightningStrike.html

Provides methods to check if a lightning strike is an effect, get and set flash counts, get and set life ticks, and get or set the causing player.

```APIDOC
## isEffect

### Description
Returns whether the strike is an effect that does no damage.

### Returns
- `boolean`: whether the strike is an effect

## getFlashes

### Description
Get the amount of flashes that will occur before the lightning is removed. By default this value is between 1 and 3.

### Returns
- `int`: the flashes

## setFlashes

### Description
Set the amount of flashes that will occur before the lightning is removed. One flash will occur after this lightning strike's life has reduced below 0.

### Parameters
- `flashes` (int) - the flashes

## getLifeTicks

### Description
Get the amount of ticks this lightning strike will inflict damage upon its hit entities. When life ticks are negative, there is a random chance that another flash will be initiated and life ticks reset to 1.

### Returns
- `int`: the life ticks

## setLifeTicks

### Description
Get the amount of ticks this lightning strike will inflict damage upon its hit entities. When life ticks are negative, there is a random chance that another flash will be initiated and life ticks reset to 1. Additionally, if life ticks are set to 2 (the default value when a lightning strike has been spawned), a list of events will occur: Impact sound effects will be played, Fire will be spawned (dependent on difficulty), Lightning rods will be powered (if hit), Copper will be stripped (if hit), `GameEvent.LIGHTNING_STRIKE` will be dispatched.

### Parameters
- `ticks` (int) - the life ticks

## getCausingPlayer

### Description
Get the `Player` that caused this lightning to strike. This will occur naturally if a trident enchanted with `Channeling` were thrown at an entity during a storm.

### Returns
- `Player`: the player

## setCausingPlayer

### Description
Set the `Player` that caused this lightning to strike.

### Parameters
- `player` (Player) - the player
```

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

### StructurePiece - Get Bounding Box

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the bounding box of a structure piece.

```APIDOC
## StructurePiece.getBoundingBox()

### Description
Gets the bounding box of this structure piece.

### Method
BoundingBox
```

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

### Constructor Summary

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/PluginDescriptionFile.html

Constructors for creating a PluginDescriptionFile object.

```APIDOC
## Constructor Summary

Constructors

### PluginDescriptionFile(InputStream stream)

### PluginDescriptionFile(Reader reader)
Loads a PluginDescriptionFile from the specified reader.

### PluginDescriptionFile(String pluginName, String pluginVersion, String mainClass)
Creates a new PluginDescriptionFile with the given detailed information.
```

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

### HelpCommand

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/command/defaults/HelpCommand.html

Provides functionality for in-game help commands.

```APIDOC
## Class: HelpCommand

Extends: `BukkitCommand`

Description:
Handles in-game help commands, allowing players to access information about other commands.

### Constructor

- `HelpCommand()`: Creates a new instance of the HelpCommand.

### Methods

- `execute(CommandSender sender, String currentAlias, String[] args)`: Executes the command. Returns true if the command was successful, otherwise false.
- `tabComplete(CommandSender sender, String alias, String[] args)`: Provides tab completion suggestions for the help command. Returns a list of possible completions.
- `findPossibleMatches(String searchString)`: Protected method to find possible help topics matching a search string.
- `damerauLevenshteinDistance(String s1, String s2)`: Protected static method to compute the Damerau-Levenshtein distance between two strings.
```

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

### GeneratedStructure - Get Bounding Box

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the bounding box of a placed structure.

```APIDOC
## GeneratedStructure.getBoundingBox()

### Description
Gets the bounding box of this placed structure.

### Method
BoundingBox
```

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

### AsyncStructureSpawnEvent - Get Bounding Box

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the bounding box of the structure being spawned.

```APIDOC
## AsyncStructureSpawnEvent.getBoundingBox()

### Description
Get the bounding box of the structure.

### Method
BoundingBox
```

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

### HelpTopicFactory.createTopic

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/class-use/HelpTopic.html

Creates a HelpTopic for a given command, allowing for custom help topic generation based on command implementations.

```APIDOC
## HelpTopicFactory.createTopic

### Description
This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it.

### Method
HelpTopic

### Parameters
- **command** (TCommand) - Description of the command object used to create the topic.
```

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

### Plugin.getDescription()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/class-use/PluginDescriptionFile.html

Returns the plugin.yaml file containing the details for this plugin.

```APIDOC
## Plugin.getDescription()

### Description
Returns the plugin.yaml file containing the details for this plugin.

### Method
`PluginDescriptionFile`

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

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

### AsyncStructureGenerateEvent - Get Bounding Box

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the bounding box of the structure being generated.

```APIDOC
## AsyncStructureGenerateEvent.getBoundingBox()

### Description
Get the bounding box of the structure.

### Method
BoundingBox
```

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

### Server Configuration and Settings

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Server.html

Methods to get and set various server configuration options.

```APIDOC
## getAllowEnd()

### Description
Gets whether this server allows the End dimension or not.

### Method
GET

### Endpoint
/server/allow-end
```

```APIDOC
## getAllowFlight()

### Description
Gets whether this server allows flying or not.

### Method
GET

### Endpoint
/server/allow-flight
```

```APIDOC
## getAllowNether()

### Description
Gets whether this server allows the Nether dimension or not.

### Method
GET

### Endpoint
/server/allow-nether
```

```APIDOC
## getConnectionThrottle()

### Description
Gets the value of the connection throttle setting.

### Method
GET

### Endpoint
/server/connection-throttle
```

```APIDOC
## getDefaultGameMode()

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

### Method
GET

### Endpoint
/server/default-gamemode
```

```APIDOC
## getGenerateStructures()

### Description
Get the generate-structures setting.

### Method
GET

### Endpoint
/server/generate-structures
```

```APIDOC
## getHideOnlinePlayers()

### Description
Gets whether the Server hides online players in the server list.

### Method
GET

### Endpoint
/server/hide-online-players
```

```APIDOC
## getIdleTimeout()

### Description
Gets the idle kick timeout in seconds.

### Method
GET

### Endpoint
/server/idle-timeout
```

```APIDOC
## getInitialDisabledPacks()

### Description
Gets a list of data packs that will not be enabled automatically.

### Method
GET

### Endpoint
/server/initial-disabled-packs
```

```APIDOC
## getInitialEnabledPacks()

### Description
Gets a list of data packs to be enabled initially.

### Method
GET

### Endpoint
/server/initial-enabled-packs
```

```APIDOC
## getIp()

### Description
Get the IP address that this server is bound to, or an empty string if not specified.

### Method
GET

### Endpoint
/server/ip
```

```APIDOC
## getOnlineMode()

### Description
Gets whether the Server is in online mode or not.

### Method
GET

### Endpoint
/server/online-mode
```

```APIDOC
## getPauseWhenEmptyTime()

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

### Method
GET

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

```APIDOC
## getPort()

### Description
Get the game port that the server runs on.

### Method
GET

### Endpoint
/server/port
```

```APIDOC
## getResourcePack()

### Description
Gets the server resource pack URI, or an empty string if not specified.

### Method
GET

### Endpoint
/server/resource-pack
```

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

### Get Team

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/scoreboard/Scoreboard.html

Retrieves a team by its name or gets the team a player belongs to.

```APIDOC
## getTeam

### Description
Gets a Team by name on this Scoreboard.

### Method Signature
```java
Team getTeam(@NotNull String teamName)
```

### Parameters
#### Path Parameters
- **teamName** (String) - Required - The name of the team to retrieve.

### Returns
- **Team** - The Team with the specified name, or null if not found.
```

```APIDOC
## getEntryTeam

### Description
Gets a Team for a given entry on this Scoreboard.

### Method Signature
```java
Team getEntryTeam(@NotNull String entry)
```

### Parameters
#### Path Parameters
- **entry** (String) - Required - The entry to find the team for.

### Returns
- **Team** - The Team the entry belongs to, or null if the entry is not on a team.
```

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

### Bukkit.getServer()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/class-use/Server.html

Retrieves the singleton instance of the Server, which represents the Minecraft server environment.

```APIDOC
## Bukkit.getServer()

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

### Method
static Server

### Endpoint
Bukkit.getServer()
```

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

### Get Handler List

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/enchantment/EnchantItemEvent.html

A static method to get the handler list for EnchantItemEvent.

```APIDOC
## Get Handler List
@NotNull public static HandlerList getHandlerList()
```

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

### Get Configuration Options

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/configuration/file/FileConfiguration.html

Gets the `FileConfigurationOptions` for this `Configuration`. All setters through this method are chainable.

```APIDOC
## options()

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

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

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

### Server Access

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Methods for getting and setting the server instance.

```APIDOC
## getServer

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

### Method
`public static Server getServer()`

### Returns
Server instance being ran
```

```APIDOC
## setServer

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

### Method
`public static void setServer(@NotNull Server server)`

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

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

### Custom PersistentDataType Implementation Example

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/persistence/PersistentDataType.html

Example of how to implement a custom PersistentDataType for UUID.

```APIDOC
## Custom Implementation Example: UUIDTagType

```java
public class UUIDTagType implements PersistentDataType<byte[], UUID> {

    @Override
    public Class<byte[]> getPrimitiveType() {
        return byte[].class;
    }

    @Override
    public Class<UUID> getComplexType() {
        return UUID.class;
    }

    @Override
    public byte[] toPrimitive(UUID complex, PersistentDataAdapterContext context) {
        ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
        bb.putLong(complex.getMostSignificantBits());
        bb.putLong(complex.getLeastSignificantBits());
        return bb.array();
    }

    @Override
    public UUID fromPrimitive(byte[] primitive, PersistentDataAdapterContext context) {
        ByteBuffer bb = ByteBuffer.wrap(primitive);
        long firstLong = bb.getLong();
        long secondLong = bb.getLong();
        return new UUID(firstLong, secondLong);
    }
}
```

**Note**: Any plugin-owned implementation of this interface is required to define one of the existing primitive types found in this interface. `BOOLEAN` is a convenience type and not a primitive.
```

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

### Static Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/BoundingBox.html

Static methods for creating BoundingBox instances.

```APIDOC
## deserialize(Map<String,Object> args)

### Description
Deserializes a BoundingBox from a map.

### Method
`static BoundingBox deserialize(Map<String,Object> args)`
```

```APIDOC
## of(Block block)

### Description
Creates a new 1x1x1 sized bounding box containing the given block.

### Method
`static BoundingBox of(Block block)`
```

```APIDOC
## of(Block corner1, Block corner2)

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

### Method
`static BoundingBox of(Block corner1, Block corner2)`
```

```APIDOC
## of(Location center, double x, double y, double z)

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

### Method
`static BoundingBox of(Location center, double x, double y, double z)`
```

```APIDOC
## of(Location corner1, Location corner2)

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

### Method
`static BoundingBox of(Location corner1, Location corner2)`
```

```APIDOC
## of(Vector center, double x, double y, double z)

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

### Method
`static BoundingBox of(Vector center, double x, double y, double z)`
```

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

### YamlConfiguration.loadConfiguration(File)

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/configuration/file/class-use/YamlConfiguration.html

Creates a new YamlConfiguration, loading from the given file.

```APIDOC
## YamlConfiguration.loadConfiguration(File)

### Description
Creates a new `YamlConfiguration`, loading from the given file.

### Method
static YamlConfiguration

### Parameters
#### Path Parameters
- **file** (File) - Description: The file to load the configuration from.
```

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

### Entity - Get Bounding Box

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the entity's current bounding box.

```APIDOC
## Entity.getBoundingBox()

### Description
Gets the entity's current bounding box.

### Method
BoundingBox
```

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

### Conduit - Get Hunting Area

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/class-use/BoundingBox.html

Gets the bounding box where the conduit will search for hostile entities.

```APIDOC
## Conduit.getHuntingArea()

### Description
Get a BoundingBox (relative to real-world coordinates) in which the conduit will search for hostile entities to target.

### Method
BoundingBox
```

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

### PluginDescriptionFile.getLoad()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/class-use/PluginLoadOrder.html

Retrieves the PluginLoadOrder for a plugin, indicating the server startup phase at which the plugin is intended to be loaded.

```APIDOC
## PluginDescriptionFile.getLoad()

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

### Returns
- `PluginLoadOrder` - The load order phase for the plugin.
```

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

### Get Holder

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/JukeboxInventory.html

Gets the block or entity that owns this inventory. For a Jukebox, this will return the Jukebox block itself.

```APIDOC
## getHolder

### Description
Gets the block or entity belonging to the open inventory.

### Method
`Jukebox`

### Returns
The holder of the inventory; null if it has no holder.
```

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

### WorldCreator Instance Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldCreator.html

Methods for configuring world creation options.

```APIDOC
## WorldCreator biomeProvider()

### Description
Gets the biome provider that will be used to create or load the world.

### Method
GET
```

```APIDOC
## WorldCreator biomeProvider(String biomeProvider)

### Description
Sets the biome provider that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **biomeProvider** (String) - Required - The name of the biome provider.
```

```APIDOC
## WorldCreator biomeProvider(String biomeProvider, CommandSender output)

### Description
Sets the biome provider that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **biomeProvider** (String) - Required - The name of the biome provider.
- **output** (CommandSender) - Required - The command sender to output messages to.
```

```APIDOC
## WorldCreator biomeProvider(BiomeProvider biomeProvider)

### Description
Sets the biome provider that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **biomeProvider** (BiomeProvider) - Required - The biome provider instance.
```

```APIDOC
## WorldCreator copy(World world)

### Description
Copies the options from the specified world.

### Method
COPY

### Parameters
#### Path Parameters
- **world** (World) - Required - The world to copy options from.
```

```APIDOC
## WorldCreator copy(WorldCreator creator)

### Description
Copies the options from the specified `WorldCreator`.

### Method
COPY

### Parameters
#### Path Parameters
- **creator** (WorldCreator) - Required - The WorldCreator to copy options from.
```

```APIDOC
## World createWorld()

### Description
Creates a world with the specified options.

### Method
CREATE

### Returns
- World - The created world.
```

```APIDOC
## World.Environment environment()

### Description
Gets the environment that will be used to create or load the world.

### Method
GET
```

```APIDOC
## WorldCreator environment(World.Environment env)

### Description
Sets the environment that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **env** (World.Environment) - Required - The environment to set.
```

```APIDOC
## boolean generateStructures()

### Description
Gets whether or not structures will be generated in the world.

### Method
GET
```

```APIDOC
## WorldCreator generateStructures(boolean generate)

### Description
Sets whether or not worlds created or loaded with this creator will have structures.

### Method
SET

### Parameters
#### Path Parameters
- **generate** (boolean) - Required - Whether to generate structures.
```

```APIDOC
## ChunkGenerator generator()

### Description
Gets the generator that will be used to create or load the world.

### Method
GET
```

```APIDOC
## WorldCreator generator(String generator)

### Description
Sets the generator that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **generator** (String) - Required - The name of the generator.
```

```APIDOC
## WorldCreator generator(String generator, CommandSender output)

### Description
Sets the generator that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **generator** (String) - Required - The name of the generator.
- **output** (CommandSender) - Required - The command sender to output messages to.
```

```APIDOC
## WorldCreator generator(ChunkGenerator generator)

### Description
Sets the generator that will be used to create or load the world.

### Method
SET

### Parameters
#### Path Parameters
- **generator** (ChunkGenerator) - Required - The generator instance.
```

```APIDOC
## String generatorSettings()

### Description
Gets the generator settings of the world that will be created or loaded.

### Method
GET
```

```APIDOC
## WorldCreator generatorSettings(String generatorSettings)

### Description
Sets the generator settings of the world that will be created or loaded.

### Method
SET

### Parameters
#### Path Parameters
- **generatorSettings** (String) - Required - The generator settings.
```

```APIDOC
## boolean hardcore()

### Description
Gets whether the world will be hardcore or not.

### Method
GET
```

```APIDOC
## WorldCreator hardcore(boolean hardcore)

### Description
Sets whether the world will be hardcore or not.

### Method
SET

### Parameters
#### Path Parameters
- **hardcore** (boolean) - Required - Whether the world should be hardcore.
```

```APIDOC
## boolean keepSpawnInMemory()

### Description
Deprecated. The concept of spawn chunks has been removed, use `World.isChunkForceLoaded(int, int)` for finer control.

### Method
GET
```

```APIDOC
## WorldCreator keepSpawnInMemory(boolean keepSpawnInMemory)

### Description
Deprecated. The concept of spawn chunks has been removed, use `World.setChunkForceLoaded(int, int, boolean)` for finer control.

### Method
SET

### Parameters
#### Path Parameters
- **keepSpawnInMemory** (boolean) - Required - Whether to keep spawn in memory.
```

```APIDOC
## String name()

### Description
Gets the name of the world that is to be loaded or created.

### Method
GET
```

```APIDOC
## long seed()

### Description
Gets the seed that will be used to create this world.

### Method
GET
```

```APIDOC
## WorldCreator seed(long seed)

### Description
Sets the seed that will be used to create this world.

### Method
SET

### Parameters
#### Path Parameters
- **seed** (long) - Required - The seed for the world.
```

```APIDOC
## WorldType type()

### Description
Gets the type of the world that will be created or loaded.

### Method
GET
```

```APIDOC
## WorldCreator type(WorldType type)

### Description
Sets the type of the world that will be created or loaded.

### Method
SET

### Parameters
#### Path Parameters
- **type** (WorldType) - Required - The type of the world.
```

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

### Instance Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/spigotmc/CustomTimingsHandler.html

Provides instance methods for managing individual timing sections.

```APIDOC
## reset()

### Description
Resets this timer, setting all its recorded values to zero.
```

```APIDOC
## startTiming()

### Description
Starts timing to track a specific section of code.
```

```APIDOC
## stopTiming()

### Description
Stops timing a section of code that was previously started.
```

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

### Get Map by ID

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Deprecated. Magic value. Gets the map from the given item ID.

```APIDOC
## getMap

### Description
Deprecated. Magic value. Gets the map from the given item ID.

### Parameters
#### Path Parameters
- `id` (int) - The id of the map to get

### Returns
- a map view if it exists, or null otherwise
```

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

### Get Block Metadata (Deprecated)

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Block.html

Gets the metadata for this block. This method is deprecated and should not be used in new code.

```java
byte getData()
```

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

### HelpTopic Class Overview

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/HelpTopic.html

The HelpTopic class is the base for all help topics displayed via the /help command. Implementations can be simple, setting basic text, or complex, overriding all methods for custom behavior.

```APIDOC
## Class: HelpTopic

### Description
Abstract class for help topics displayed by the /help command. Allows for simple text-based topics or complex custom implementations.

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

### Fields
- `amendedPermission` (protected String): Permission override for viewing the topic.
- `fullText` (protected String): The complete description of the help topic.
- `name` (protected String): The name of the help topic.
- `shortText` (protected String): A brief description for the topic index.

### Constructor
- `HelpTopic()`: Default constructor.

### Methods
- `amendCanSee(String amendedPermission)`: Sets a specific permission to view this topic.
- `amendTopic(String amendedShortText, String amendedFullText)`: Modifies the short and full text of the topic.
- `applyAmendment(String baseText, String amendment)`: (protected) Utility for custom implementations to apply amendments.
- `canSee(CommandSender player)`: (abstract) Checks if a sender can view this topic.
- `getFullText(CommandSender forWho)`: Returns the full text description of the topic.
- `getName()`: Returns the name of the topic.
- `getShortText()`: Returns the brief description of the topic.
```

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

### JavaPlugin.getDescription()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/plugin/class-use/PluginDescriptionFile.html

Returns the plugin.yaml file containing the details for this plugin.

```APIDOC
## JavaPlugin.getDescription()

### Description
Returns the plugin.yaml file containing the details for this plugin.

### Method
`final PluginDescriptionFile`

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

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

### Get Crafting Recipe

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Server.html

Get the Recipe for the list of ItemStacks provided. The list is formatted as a crafting matrix.

```APIDOC
## getCraftingRecipe

### Description
Get the `Recipe` for the list of ItemStacks provided. The list is formatted as a crafting matrix where the index follow the pattern below:
```
[ 0 1 2 ]
[ 3 4 5 ]
[ 6 7 8 ]
```

NOTE: This method will not modify the provided ItemStack array, for that, use `craftItem(ItemStack[], World, Player)`.

### Parameters
* `craftingMatrix` (ItemStack[]) - list of items to be crafted from. Must not contain more than 9 items.
* `world` (World) - The world the crafting takes place in.

### Returns
* `Recipe` - the `Recipe` resulting from the given crafting matrix.
```

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

### Get All Help Topics

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/help/HelpMap.html

Returns a collection of all help topics currently registered in the server's index.

```APIDOC
## getHelpTopics

### Description
Returns a collection of all the registered help topics.

### Method
Collection<HelpTopic>

### Returns
All the registered help topics.

### Code Example
```java
@NotNull Collection<HelpTopic> getHelpTopics()
```
```

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

### Getting Offline Players

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/class-use/OfflinePlayer.html

Methods to retrieve an OfflinePlayer by name or UUID, or to get all players who have ever played on the server.

```APIDOC
## Bukkit API - OfflinePlayer Retrieval

### Methods returning OfflinePlayer

#### `static OfflinePlayer` Bukkit.getOfflinePlayer(String name)

**Description:** Deprecated. Gets an offline player by their name. Persistent storage should use UUIDs.

#### `static OfflinePlayer` Bukkit.getOfflinePlayer(UUID id)

**Description:** Gets the player by the given UUID, regardless if they are offline or online.

#### `OfflinePlayer` Server.getOfflinePlayer(String name)

**Description:** Deprecated. Gets an offline player by their name from the server instance. Persistent storage should use UUIDs.

#### `OfflinePlayer` Server.getOfflinePlayer(UUID id)

**Description:** Gets the player by the given UUID from the server instance, regardless if they are offline or online.

### Methods returning arrays or sets of OfflinePlayer

#### `static OfflinePlayer[]` Bukkit.getOfflinePlayers()

**Description:** Gets an array of every player that has ever played on this server.

#### `OfflinePlayer[]` Server.getOfflinePlayers()

**Description:** Gets an array of every player that has ever played on this server from the server instance.

#### `static Set<OfflinePlayer>` Bukkit.getBannedPlayers()

**Description:** Gets a set containing all banned players.

#### `Set<OfflinePlayer>` Server.getBannedPlayers()

**Description:** Gets a set containing all banned players from the server instance.

#### `static Set<OfflinePlayer>` Bukkit.getOperators()

**Description:** Gets a set containing all player operators.

#### `Set<OfflinePlayer>` Server.getOperators()

**Description:** Gets a set containing all player operators from the server instance.

#### `static Set<OfflinePlayer>` Bukkit.getWhitelistedPlayers()

**Description:** Gets a list of whitelisted players.

#### `Set<OfflinePlayer>` Server.getWhitelistedPlayers()

**Description:** Gets a list of whitelisted players from the server instance.
```

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

### EntityDamageEvent.DamageCause valueOf() and values() Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html

Provides methods to get a DamageCause enum constant by its name or to get all available constants.

```APIDOC
## Methods

### `static EntityDamageEvent.DamageCause valueOf(String name)`

Returns the enum constant of this class with the specified name.

### `static EntityDamageEvent.DamageCause[] values()`

Returns an array containing the constants of this enum class, in the order they are declared.
```

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

### startsWithIgnoreCase

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/StringUtil.html

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

```APIDOC
## startsWithIgnoreCase

### Description
This method uses a region to check case-insensitive equality. This means the internal array does not need to be copied like a toLowerCase() call would.

### Method
`static boolean startsWithIgnoreCase(String string, String prefix)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- `string` (String) - The string to check.
- `prefix` (String) - The prefix of the string to compare.

### Returns
- `boolean` - true if the provided string starts with, ignoring case, the prefix provided.

### Throws
- `NullPointerException` - if prefix is null.
- `IllegalArgumentException` - if string is null.

### Request Example
```java
boolean startsWith = StringUtil.startsWithIgnoreCase("HelloWorld", "hello"); // true
boolean startsWith2 = StringUtil.startsWithIgnoreCase("HelloWorld", "world"); // false
```

### Response
#### Success Response (200)
Returns a boolean indicating whether the string starts with the prefix ignoring case.

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

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

### WorldCreator.createWorld()

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldCreator.html

Creates or loads a world with the configured options. If the world already exists, it will be loaded from disk and some options may be ignored.

```APIDOC
## WorldCreator.createWorld()

### Description
Creates a world with the specified options. If the world already exists, it will be loaded from disk and some options may be ignored.

### Method Signature
`@Nullable public World createWorld()`

### Returns
* `World` - The newly created or loaded world object.
```

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

### startPlaying

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Jukebox.html

Attempts to start playing the record in the jukebox. Returns true if a record was present and playback started, false otherwise.

```APIDOC
## startPlaying

boolean startPlaying()

Starts the jukebox playing if there is a record.

Returns:
    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
```

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

### Instance Methods

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/util/BoundingBox.html

Instance methods for interacting with BoundingBox objects.

```APIDOC
## clone()

### Description
Creates a copy of this bounding box.

### Method
`clone()`
```

```APIDOC
## contains(double x, double y, double z)

### Description
Checks if this bounding box contains the specified position.

### Method
`contains(double x, double y, double z)`
```

```APIDOC
## contains(BoundingBox other)

### Description
Checks if this bounding box fully contains the given bounding box.

### Method
`contains(BoundingBox other)`
```

```APIDOC
## contains(Vector position)

### Description
Checks if this bounding box contains the specified position.

### Method
`contains(Vector position)`
```

```APIDOC
## contains(Vector min, Vector max)

### Description
Checks if this bounding box fully contains the bounding box that is defined by the given corners.

### Method
`contains(Vector min, Vector max)`
```

```APIDOC
## copy(BoundingBox other)

### Description
Copies another bounding box.

### Method
`copy(BoundingBox other)`
```

```APIDOC
## expand(double expansion)

### Description
Expands this bounding box uniformly by the given value in all directions.

### Method
`expand(double expansion)`
```

```APIDOC
## expand(double x, double y, double z)

### Description
Expands this bounding box uniformly by the given values in both positive and negative directions.

### Method
`expand(double x, double y, double z)`
```

```APIDOC
## expand(double dirX, double dirY, double dirZ, double expansion)

### Description
Expands this bounding box in the specified direction.

### Method
`expand(double dirX, double dirY, double dirZ, double expansion)`
```

```APIDOC
## expand(double negativeX, double negativeY, double negativeZ, double positiveX, double positiveY, double positiveZ)

### Description
Expands this bounding box by the given values in the corresponding directions.

### Method
`expand(double negativeX, double negativeY, double negativeZ, double positiveX, double positiveY, double positiveZ)`
```

```APIDOC
## expand(BlockFace blockFace, double expansion)

### Description
Expands this bounding box in the direction specified by the given block face.

### Method
`expand(BlockFace blockFace, double expansion)`
```

```APIDOC
## expand(Vector expansion)

### Description
Expands this bounding box uniformly by the given values in both positive and negative directions.

### Method
`expand(Vector expansion)`
```

```APIDOC
## expand(Vector direction, double expansion)

### Description
Expands this bounding box in the specified direction.

### Method
`expand(Vector direction, double expansion)`
```

```APIDOC
## expandDirectional(double dirX, double dirY, double dirZ)

### Description
Expands this bounding box in the specified direction.

### Method
`expandDirectional(double dirX, double dirY, double dirZ)`
```

```APIDOC
## expandDirectional(Vector direction)

### Description
Expands this bounding box in the specified direction.

### Method
`expandDirectional(Vector direction)`
```

```APIDOC
## getCenter()

### Description
Gets the center of the bounding box.

### Method
`getCenter()`
```

```APIDOC
## getCenterX()

### Description
Gets the x coordinate of the center of the bounding box.

### Method
`getCenterX()`
```

```APIDOC
## getCenterY()

### Description
Gets the y coordinate of the center of the bounding box.

### Method
`getCenterY()`
```

```APIDOC
## getCenterZ()

### Description
Gets the z coordinate of the center of the bounding box.

### Method
`getCenterZ()`
```

```APIDOC
## getHeight()

### Description
Gets the height of the bounding box.

### Method
`getHeight()`
```

```APIDOC
## getMax()

### Description
Gets the maximum corner as vector.

### Method
`getMax()`
```

```APIDOC
## getMaxX()

### Description
Gets the maximum x value.

### Method
`getMaxX()`
```

```APIDOC
## getMaxY()

### Description
Gets the maximum y value.

### Method
`getMaxY()`
```

```APIDOC
## getMaxZ()

### Description
Gets the maximum z value.

### Method
`getMaxZ()`
```

```APIDOC
## getMin()

### Description
Gets the minimum corner as vector.

### Method
`getMin()`
```

```APIDOC
## getMinX()

### Description
Gets the minimum x value.

### Method
`getMinX()`
```

```APIDOC
## getMinY()

### Description
Gets the minimum y value.

### Method
`getMinY()`
```

```APIDOC
## getMinZ()

### Description
Gets the minimum z value.

### Method
`getMinZ()`
```

```APIDOC
## getVolume()

### Description
Gets the volume of the bounding box.

### Method
`getVolume()`
```

```APIDOC
## getWidthX()

### Description
Gets the width of the bounding box in the x direction.

### Method
`getWidthX()`
```

```APIDOC
## getWidthZ()

### Description
Gets the width of the bounding box in the z direction.

### Method
`getWidthZ()`
```

```APIDOC
## hashCode()

### Description
Returns a hash code value for the object.

### Method
`hashCode()`
```

```APIDOC
## intersection(BoundingBox other)

### Description
Resizes this bounding box to represent the intersection of this and the given bounding box.

### Method
`intersection(BoundingBox other)`
```

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

### Get Ticks Per Ambient Spawns

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Server.html

Gets the default ticks per ambient mob spawns value. This method is deprecated.

```APIDOC
## getTicksPerAmbientSpawns

### Description
Gets the default ticks per ambient mob spawns value. This method is deprecated in favor of `getTicksPerSpawns(SpawnCategory)`.

### Method
```java
@Deprecated(since="1.18.1") int getTicksPerAmbientSpawns()
```

### Returns
- `int` - The default ticks per ambient mobs spawn value.

### Notes
- A value of 1 means spawning is attempted every tick.
- A value of 400 means spawning is attempted every 400th tick.
- A value below 0 resets to Minecraft's default.
- A value of 0 disables ambient mob spawning.
```

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

### Server Information and Access

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Bukkit.html

Retrieve core server information and access the server singleton.

```APIDOC
## getServer()

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

### Method
`static Server getServer()`

## getServerIcon()

### Description
Gets an instance of the server's default server-icon.

### Method
`static CachedServerIcon getServerIcon()`

## getServerLinks()

### Description
Gets the server links which will be sent to clients.

### Method
`static ServerLinks getServerLinks()`

## getShutdownMessage()

### Description
Gets the default message that is displayed when the server is stopped.

### Method
`static String getShutdownMessage()`

## getVersion()

### Description
Gets the version string of this server implementation.

### Method
`static String getVersion()`
```

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

### UUIDItemTagType Example

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/tags/ItemTagType.html

An example implementation of the ItemTagType interface for handling UUIDs. This class demonstrates how to convert a UUID to a byte array and back.

```APIDOC
## UUIDItemTagType

### Description
This class implements `ItemTagType<byte[], UUID>` to handle the storage and retrieval of UUIDs as byte arrays.

### Implements
`ItemTagType<byte[], UUID>`

### Methods
#### getPrimitiveType
@Override
public Class<byte[]> getPrimitiveType() {
    return byte[].class;
}

#### getComplexType
@Override
public Class<UUID> getComplexType() {
    return UUID.class;
}

#### toPrimitive
@Override
public byte[] toPrimitive(UUID complex, ItemTagAdapterContext context) {
    ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
    bb.putLong(complex.getMostSignificantBits());
    bb.putLong(complex.getLeastSignificantBits());
    return bb.array();
}

#### fromPrimitive
@Override
public UUID fromPrimitive(byte[] primitive, ItemTagAdapterContext context) {
    ByteBuffer bb = ByteBuffer.wrap(primitive);
    long firstLong = bb.getLong();
    long secondLong = bb.getLong();
    return new UUID(firstLong, secondLong);
}
```

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

### Get Relative Block by Face

Source: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Block.html

Gets the block directly adjacent to the current block on the specified face. This is a shorthand for `getRelative(face, 1)`.

```java
@NotNull Block getRelative(@NotNull BlockFace face)
```
Tokens:
Raw