PandaSpigot

https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/
Admin
PandaSpigot is a Minecraft server software fork that provides enhanced performance and features for...
Tokens:699,582
Snippets:5,564
Trust Score:4.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Plugin YAML Example

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/plugin/PluginDescriptionFile.html

An example of a plugin.yml file, which is required for Bukkit plugins. This file defines essential plugin metadata like name, version, main class, author, and description. The structure is key-value pairs, with no indentation.

```yaml
name: Inferno
version: 1.4.1
description: This plugin is so 31337. You can set yourself on fire.
# We could place every author in the authors list, but chose not to for illustrative purposes
# Also, having an author distinguishes that person as the project lead, and ensures their
```

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

### options Method

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/configuration/Configuration.html

Gets the ConfigurationOptions for this Configuration.

```APIDOC
## Method: options

### Description
Gets the `ConfigurationOptions` for this `Configuration`.

### Signature
`ConfigurationOptions options()`
```

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

### Install DDL

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/plugin/java/JavaPlugin.html

Protected method to install Data Definition Language (DDL) for the plugin. This is typically used for setting up database schemas.

```java
protected void installDDL()
```

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

### GET /help/topic/preamble

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/IndexHelpTopic.html

Builds the preamble for a help index topic.

```APIDOC
## GET /help/topic/preamble

### Description
Generates the preamble text displayed at the top of a help index.

### Method
GET

### Endpoint
/help/topic/preamble

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

### Response
#### Success Response (200)
- **preamble** (String) - The rendered preamble text.

#### Response Example
{
  "preamble": "--- Help Index ---"
}
```

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

### Getting Opposite BlockFace

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/block/BlockFace.html

Shows how to obtain the opposite BlockFace for a given face. For example, the opposite of NORTH is SOUTH.

```java
BlockFace opposite = BlockFace.NORTH.getOppositeFace();
```

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

### Initialize Full BukkitCommand

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/command/defaults/BukkitCommand.html

Demonstrates the protected constructor used to initialize a BukkitCommand with a name, description, usage message, and a list of aliases.

```java
protected BukkitCommand(java.lang.String name, java.lang.String description, java.lang.String usageMessage, java.util.List<java.lang.String> aliases)
```

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

### Initialize and Serialize Pattern

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/block/banner/Pattern.html

Demonstrates how to instantiate a new Pattern object with a specific color and type, and how to serialize it into a map for configuration storage.

```java
import org.bukkit.DyeColor;
import org.bukkit.block.banner.Pattern;
import org.bukkit.block.banner.PatternType;
import java.util.Map;

// Create a new pattern
Pattern pattern = new Pattern(DyeColor.RED, PatternType.BASE);

// Serialize the pattern to a map
Map<String, Object> serialized = pattern.serialize();
```

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

### Get Inventory Iterator from Index (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/inventory/Inventory.html

Returns an iterator for the inventory's ItemStacks, starting at the specified index. The index can be positive or negative.

```Java
java.util.ListIterator<ItemStack> iterator(int index)
```

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

### Get Maximum World Height (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/World.html

Returns the maximum buildable height for the world. For example, a max height of 100 means blocks can exist from y=0 to y=99.

```Java
int getMaxHeight()
```

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

### Build Help Topic Preamble (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/IndexHelpTopic.html

Constructs the introductory text for a help topic. This method is intended to be overridden to customize the appearance of the index preamble.

```java
protected java.lang.String buildPreamble(CommandSender sender)
```

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

### TreeType Enum Methods

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/TreeType.html

Details the static methods available for the TreeType enum: `values()` to get an array of all constants and `valueOf(String name)` to retrieve a constant by its name. Includes usage examples and parameter/return information.

```java
public static
TreeType[]
values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
```
for (TreeType c : TreeType.values())
    System.out.println(c);

```


Returns:
    an array containing the constants of this enum type, in the order they are declared
public static
TreeType
valueOf(java.lang.String
name)

Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) 

Parameters:
    `name` - the name of the enum constant to be returned. 

Returns:
    the enum constant with the specified name 

Throws:
    `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name     `java.lang.NullPointerException` - if the argument is null
```

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

### Creating a Note Instance

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Note.html

Demonstrates how to instantiate a Note object using the constructor or static factory methods for specific musical variations.

```java
Note myNote = new Note(1, Note.Tone.A, false);
Note sharpNote = Note.sharp(1, Note.Tone.A);
Note flatNote = Note.flat(1, Note.Tone.B);
```

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

### Instantiate and Configure a Bed

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Bed.html

Demonstrates how to create a new Bed object and configure its orientation and head/foot status.

```java
import org.bukkit.material.Bed;
import org.bukkit.block.BlockFace;

// Instantiate a bed facing North
Bed bed = new Bed(BlockFace.NORTH);

// Configure as the head of the bed
bed.setHeadOfBed(true);

// Check status
boolean isHead = bed.isHeadOfBed();
```

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

### Get Failed Validation Text (Number Input) - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/conversations/NumericPrompt.html

Optionally override this method to display an additional message if the user enters an invalid numeric input. It takes conversation context and the invalid number input, returning a message to guide the user.

```Java
protected java.lang.String getFailedValidationText(ConversationContext context,
                                                   java.lang.Number invalidInput)
```

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

### Creating and Starting Timing Handlers

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/co/aikar/timings/Timings.html

Demonstrates how to create a Timing handler and how to use the ofStart method with Java 7 try-with-resources to automatically track execution time for a block of code.

```java
try (Timing ignored = Timings.ofStart(plugin, "MyTimedSection")) {
    // Code to be measured
}

// Or using a group handler
try (Timing ignored = Timings.ofStart(plugin, "MyTimedSection", groupHandler)) {
    // Code to be measured
}
```

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

### Get Failed Validation Text (String Input) - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/conversations/NumericPrompt.html

Optionally override this method to display an additional message if the user enters an invalid string input. It takes conversation context and the invalid input string, returning a message to guide the user.

```Java
protected java.lang.String getFailedValidationText(ConversationContext context,
                                                   java.lang.String invalidInput)
```

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

### Initialize PressurePlate

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/PressurePlate.html

Demonstrates how to instantiate a new PressurePlate object using the standard constructor.

```java
PressurePlate plate = new PressurePlate();
```

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

### Get Score (String)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/scoreboard/Objective.html

Gets an entry's Score for an Objective on this Scoreboard. Throws IllegalArgumentException or IllegalStateException.

```APIDOC
## Get Score (String)

### Description
Gets an entry's Score for an Objective on this Scoreboard.

### Method
`Score getScore(String entry)`

### Endpoint
[Endpoint not specified]

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **entry** (String) - Entry for the Score.

### Returns
* **Score** - Score tracking the Objective and entry specified.

### Throws
`java.lang.IllegalArgumentException` - if entry is null
`java.lang.IllegalStateException` - if this objective has been unregistered
```

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

### Set and Get Z-Coordinate of Location

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Location.html

Enables setting and getting the Z-coordinate of a Location. This completes the definition of a 3D point.

```java
public void setZ(double z)
public double getZ()
```

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

### Instantiate IndexHelpTopic

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/IndexHelpTopic.html

Demonstrates how to create an instance of IndexHelpTopic with a collection of topics and an optional preamble.

```java
Collection<HelpTopic> topics = new ArrayList<>();
topics.add(myTopic);
IndexHelpTopic index = new IndexHelpTopic("myIndex", "Short description", "my.permission", topics, "Welcome to the help index:");
```

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

### Load YamlConfiguration from File

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/configuration/file/YamlConfiguration.html

Demonstrates how to instantiate and load a configuration object from a physical file on the disk using the static loadConfiguration method.

```java
import org.bukkit.configuration.file.YamlConfiguration;
import java.io.File;

File configFile = new File("config.yml");
YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile);
```

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

### Get Inventory Holder - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/inventory/BrewerInventory.html

Gets the block or entity associated with this inventory. This method is inherited from the Inventory interface and is specified by it.

```java
BrewingStand getHolder()
```

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

### Initialize MemoryConfiguration

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/configuration/MemoryConfiguration.html

Demonstrates how to instantiate a MemoryConfiguration object, either as an empty configuration or one initialized with a set of default values.

```java
import org.bukkit.configuration.MemoryConfiguration;
import org.bukkit.configuration.Configuration;

// Create an empty MemoryConfiguration
MemoryConfiguration config = new MemoryConfiguration();

// Create a MemoryConfiguration with defaults
Configuration defaults = new MemoryConfiguration();
MemoryConfiguration configWithDefaults = new MemoryConfiguration(defaults);
```

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

### Get Eye Height

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/LivingEntity.html

Gets the height of the living entity's eyes above its Location. An overload is available to ignore the effects of sneaking.

```Java
double getEyeHeight()
double getEyeHeight(boolean ignoreSneaking)
```

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

### Server.Spigot Configuration Methods

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Server.Spigot.html

Methods to retrieve different configuration files for the server. Includes methods for Bukkit, Spigot, and PaperSpigot configurations.

```java
public YamlConfiguration getConfig()
Deprecated.
public YamlConfiguration getBukkitConfig()
public YamlConfiguration getPaperSpigotConfig()
public YamlConfiguration getSpigotConfig()
```

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

### Get EntityEffect Data (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/EntityEffect.html

Deprecated method to get the data value of an EntityEffect. This method is marked as deprecated and should be used with caution.

```Java
@Deprecated
public byte getData()
```

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

### Get Color Representation (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/DyeColor.html

Gets the java.awt.Color that this dye represents. This method is used to obtain the standard color representation of the dye.

```Java
public Color getColor()

```

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

### Initialize SimplexNoiseGenerator

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/util/noise/SimplexNoiseGenerator.html

Demonstrates how to instantiate the SimplexNoiseGenerator class using different constructors, including seeded and world-based initialization.

```java
SimplexNoiseGenerator generator = new SimplexNoiseGenerator();
SimplexNoiseGenerator seededGenerator = new SimplexNoiseGenerator(12345L);
SimplexNoiseGenerator worldGenerator = new SimplexNoiseGenerator(world);
```

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

### Registering HelpTopicFactory

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/HelpTopicFactory.html

Illustrates the process of registering a custom HelpTopicFactory with the HelpMap. This allows the help system to use the custom factory for specific command base classes.

```java
HelpMap.registerHelpTopicFactory(Class, HelpTopicFactory)
```

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

### Initialize BukkitCommand with Name

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/command/defaults/BukkitCommand.html

Demonstrates the protected constructor used to initialize a BukkitCommand with only a command name.

```java
protected BukkitCommand(java.lang.String name)
```

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

### Get Display Slot

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/scoreboard/Objective.html

Gets the display slot this objective is displayed at. Returns null if not displayed. Throws an IllegalStateException if the objective has already been unregistered.

```APIDOC
## Get Display Slot

### Description
Gets the display slot this objective is displayed at.

### Method
`DisplaySlot getDisplaySlot()`

### Endpoint
[Endpoint not specified]

### Returns
* **DisplaySlot** - The display slot for this objective, or null if not displayed.

### Throws
`java.lang.IllegalStateException` - if this objective has been unregistered
```

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

### Deprecated Get Entity Health Method

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/Damageable.html

Deprecated method for getting the entity's health. Use the non-deprecated `getHealth()` method instead.

```java
int _INVALID_getHealth()
```

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

### Creating a Title Instance

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/github/paperspigot/Title.html

Demonstrates how to instantiate a Title object using various constructors, including simple string-based titles and more complex component-based titles with timing parameters.

```java
Title simpleTitle = new Title("Hello World");
Title complexTitle = new Title("Main Title", "Subtitle", 10, 70, 20);
```

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

### Get Player by UUID - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Server.html

Retrieves a Player object using their unique UUID. This is the most reliable way to get a specific online player.

```java
Player getPlayer(java.util.UUID id)
```

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

### Configuring MemoryConfigurationOptions

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/configuration/MemoryConfigurationOptions.html

Demonstrates how to instantiate and configure a MemoryConfigurationOptions object, including setting the path separator and enabling default copying.

```java
MemoryConfiguration config = new MemoryConfiguration();
MemoryConfigurationOptions options = new MemoryConfigurationOptions(config);

// Set the path separator to a forward slash
options.pathSeparator('/');

// Enable copying of default values
options.copyDefaults(true);
```

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

### Initialize FlowerPot

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/FlowerPot.html

Demonstrates how to instantiate a new FlowerPot object using the default constructor or by specifying the material type.

```java
FlowerPot pot = new FlowerPot();
FlowerPot potWithType = new FlowerPot(Material.FLOWER_POT);
```

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

### Get Eye Location

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/LivingEntity.html

Get a Location detailing the current eye position of the living entity. This provides the exact coordinates of the entity's eyes.

```Java
Location getEyeLocation()
```

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

### Horse Domestication Management

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/Horse.html

Methods to get and set the horse's domestication level, which influences its taming probability, and to get the maximum domestication level.

```APIDOC
## GET /horse/domestication

### Description
Gets the domestication level of this horse.

### Method
GET

### Endpoint
/horse/domestication

### Response
#### Success Response (200)
- **domesticationLevel** (int) - The current domestication level of the horse.

#### Response Example
```json
{
  "domesticationLevel": 50
}
```

## POST /horse/domestication

### Description
Sets the domestication level of this horse. A higher level increases the chance of taming. The level must be greater than zero and no greater than the maximum domestication level.

### Method
POST

### Endpoint
/horse/domestication

### Parameters
#### Request Body
- **level** (int) - Required - The desired domestication level for the horse.

### Request Example
```json
{
  "level": 100
}
```

### Response
#### Success Response (204)
No content, operation successful.

## GET /horse/max-domestication

### Description
Gets the maximum domestication level of this horse.

### Method
GET

### Endpoint
/horse/max-domestication

### Response
#### Success Response (200)
- **maxDomesticationLevel** (int) - The maximum domestication level the horse can reach.

#### Response Example
```json
{
  "maxDomesticationLevel": 150
}
```

```

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

### Get All Help Topics

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/HelpMap.html

Returns a collection of all registered HelpTopic objects currently in the server's index.

```java
java.util.Collection<HelpTopic> getHelpTopics()
```

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

### Deprecated Get Maximum Entity Health Method

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/Damageable.html

Deprecated method for getting the maximum health of an entity. Use the non-deprecated `getMaxHealth()` method instead.

```java
int _INVALID_getMaxHealth()
```

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

### Get Firework Color Representation (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/DyeColor.html

Gets the firework color that this dye represents. This method is used to obtain the specific color representation for fireworks.

```Java
public Color getFireworkColor()

```

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

### Initialize Tree Material Object

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Tree.html

Demonstrates how to instantiate a Tree object using different constructors, including specifying species and log direction.

```java
Tree tree = new Tree(TreeSpecies.REDWOOD, BlockFace.UP);
Tree defaultTree = new Tree();
```

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

### Get Score (OfflinePlayer)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/scoreboard/Objective.html

Gets a player's Score for an Objective on this Scoreboard. Deprecated. Scoreboards can contain entries that aren't players. Throws IllegalArgumentException or IllegalStateException.

```APIDOC
## Get Score (OfflinePlayer)

### Description
Gets a player's Score for an Objective on this Scoreboard.

### Method
`@Deprecated Score getScore(OfflinePlayer player)`

### Endpoint
[Endpoint not specified]

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **player** (OfflinePlayer) - Player for the Score.

### Returns
* **Score** - Score tracking the Objective and player specified.

### Throws
`java.lang.IllegalArgumentException` - if player is null
`java.lang.IllegalStateException` - if this objective has been unregistered

### See Also
`getScore(String)`
```

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

### Managing Object Metadata with MetadataStoreBase

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/metadata/MetadataStoreBase.html

Examples showing how to set, retrieve, and remove metadata values associated with an object using the MetadataStoreBase implementation.

```java
public void updateMetadata(T subject, String key, MetadataValue value, Plugin plugin) {
    // Set metadata
    setMetadata(subject, key, value);

    // Check if metadata exists
    if (hasMetadata(subject, key)) {
        // Retrieve metadata
        List<MetadataValue> values = getMetadata(subject, key);
    }

    // Remove specific metadata
    removeMetadata(subject, key, plugin);
}
```

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

### Instantiate PlayerKickEvent

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/event/player/PlayerKickEvent.html

Demonstrates how to create a new instance of the PlayerKickEvent using either standard Strings or Kyori Adventure Components for the kick reason and leave message.

```java
PlayerKickEvent event = new PlayerKickEvent(player, "Kicked for spamming", "Player left the server");
PlayerKickEvent componentEvent = new PlayerKickEvent(player, Component.text("Kicked"), Component.text("Goodbye"));
```

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

### Get Deprecated Login Result - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/event/player/AsyncPlayerPreLoginEvent.html

Deprecated method to get the login result. It uses an older enum from PlayerPreLoginEvent and is recommended to use getLoginResult() instead.

```Java
@Deprecated
public PlayerPreLoginEvent.Result getResult()
```

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

### Instantiate RegisteredServiceProvider

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/plugin/RegisteredServiceProvider.html

Demonstrates the constructor for creating a new service provider registration. It requires the service class, the provider instance, the priority level, and the owning plugin.

```java
public RegisteredServiceProvider(java.lang.Class<T> service, T provider, ServicePriority priority, Plugin plugin)
```

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

### Get Relative World Time - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/World.html

Gets the relative in-game time of the world, analogous to hours * 1000. This represents a cyclical time within a day.

```java
long getTime()
```

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

### Get WorldType Name - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/WorldType.html

Provides an instance method to get the string name of a WorldType enum constant. This is useful for displaying or logging the type of a world.

```java
public java.lang.String getName()
{
  // Implementation details omitted for brevity
  return null;
}
```

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

### Initialize RegexPrompt with Pattern or String

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/conversations/RegexPrompt.html

Shows how to instantiate a RegexPrompt using either a compiled java.util.regex.Pattern or a raw string regex.

```java
RegexPrompt prompt = new RegexPrompt("[0-9]+");
RegexPrompt patternPrompt = new RegexPrompt(java.util.regex.Pattern.compile("[a-zA-Z]+"));
```

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

### Get Right Clicked Entity - PlayerArmorStandManipulateEvent

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/event/player/PlayerArmorStandManipulateEvent.html

Gets the specific ArmorStand entity that was right-clicked by the player. This method is inherited from PlayerInteractEntityEvent and provides direct access to the interacted entity.

```Java
public ArmorStand getRightClicked()
```

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

### Initialize RedstoneWire Object

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/RedstoneWire.html

Demonstrates how to instantiate a RedstoneWire object using the default constructor or by specifying the Material type.

```java
RedstoneWire wire = new RedstoneWire();
RedstoneWire wireFromMaterial = new RedstoneWire(Material.REDSTONE_WIRE);
```

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

### Location Construction and Basic Getters/Setters

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Location.html

Demonstrates how to construct a Location object and use basic methods to get and set its world, coordinates, yaw, and pitch.

```APIDOC
## Location Class

### Description
Represents a specific point in a Minecraft world, including coordinates and orientation.

### Constructor

```java
public Location(World world, double x, double y, double z, float yaw, float pitch)
```

Constructs a new Location with the given coordinates and direction.

### Parameters
- **world** (World) - The world in which this location resides
- **x** (double) - The x-coordinate of this new location
- **y** (double) - The y-coordinate of this new location
- **z** (double) - The z-coordinate of this new location
- **yaw** (float) - The absolute rotation on the x-plane, in degrees
- **pitch** (float) - The absolute rotation on the y-plane, in degrees

### Method Detail

#### setWorld

```java
public void setWorld(World world)
```

Sets the world that this location resides in.

Parameters:
    `world` - New world that this location resides in

#### getWorld

```java
public World getWorld()
```

Gets the world that this location resides in.

Returns:
    World that contains this location

#### setX

```java
public void setX(double x)
```

Sets the x-coordinate of this location.

Parameters:
    `x` - X-coordinate

#### getX

```java
public double getX()
```

Gets the x-coordinate of this location.

Returns:
    x-coordinate

#### setY

```java
public void setY(double y)
```

Sets the y-coordinate of this location.

Parameters:
    `y` - y-coordinate

#### getY

```java
public double getY()
```

Gets the y-coordinate of this location.

Returns:
    y-coordinate

#### setZ

```java
public void setZ(double z)
```

Sets the z-coordinate of this location.

Parameters:
    `z` - z-coordinate

#### getZ

```java
public double getZ()
```

Gets the z-coordinate of this location.

Returns:
    z-coordinate

#### setYaw

```java
public void setYaw(float yaw)
```

Sets the yaw of this location, measured in degrees.
* A yaw of 0 or 360 represents the positive z direction.
* A yaw of 180 represents the negative z direction.
* A yaw of 90 represents the negative x direction.
* A yaw of 270 represents the positive x direction.
Increasing yaw values are the equivalent of turning to your right-facing, increasing the scale of the next respective axis, and decreasing the scale of the previous axis.

Parameters:
    `yaw` - new rotation's yaw

#### getYaw

```java
public float getYaw()
```

Gets the yaw of this location, measured in degrees.
* A yaw of 0 or 360 represents the positive z direction.
* A yaw of 180 represents the negative z direction.
* A yaw of 90 represents the negative x direction.
* A yaw of 270 represents the positive x direction.
Increasing yaw values are the equivalent of turning to your right-facing, increasing the scale of the next respective axis, and decreasing the scale of the previous axis.

Returns:
    the rotation's yaw

#### setPitch

```java
public void setPitch(float pitch)
```

Sets the pitch of this location, measured in degrees.
* A pitch of 0 represents level forward facing.
* A pitch of 90 represents downward facing, or negative y direction.
* A pitch of -90 represents upward facing, or positive y direction.
Increasing pitch values the equivalent of looking down.

Parameters:
    `pitch` - new incline's pitch

#### getPitch

```java
public float getPitch()
```

Gets the pitch of this location, measured in degrees.
* A pitch of 0 represents level forward facing.
* A pitch of 90 represents downward facing, or negative y direction.
* A pitch of -90 represents upward facing, or positive y direction.
Increasing pitch values the equivalent of looking down.

Returns:
    the incline's pitch
```

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

### Get Absolute World Time - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/World.html

Gets the full, absolute in-game time of the world. This represents the total time elapsed since the world's creation.

```java
long getFullTime()
```

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

### Manage Command Description and Usage

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/command/Command.html

Provides methods to set and get the command's description and usage information. This is vital for in-game help commands and documentation, ensuring users understand the command's purpose and how to use it.

```java
public java.lang.String getDescription() {
    // Gets a brief description of this command
    // Returns: Description of this command
    return ""; // Placeholder implementation
}

public Command setDescription(java.lang.String description) {
    // Sets a brief description of this command. Defining a description in the PluginDescriptionFile.getCommands() (under the `description`' node) is equivalent to this method.
    // Parameters: description - new command description
    // Returns: this command object, for chaining
    return this; // Placeholder implementation
}

public java.lang.String getUsage() {
    // Gets an example usage of this command
    // Returns: One or more example usages
    return ""; // Placeholder implementation
}

public Command setUsage(java.lang.String usage) {
    // Sets the example usage of this command
    // Parameters: usage - new example usage
    // Returns: this command object, for chaining
    return this; // Placeholder implementation
}
```

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

### Java: Get Block Information from BlockState

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/block/BlockState.html

This snippet demonstrates how to retrieve various properties of a block using its BlockState object. It includes methods to get the parent Block, the Chunk it belongs to, its MaterialData, light level, Location, World, coordinates (x, y, z), and its Material type. It also shows how to get deprecated type ID.

```Java
Block block = blockState.getBlock();
Chunk chunk = blockState.getChunk();
MaterialData data = blockState.getData();
byte lightLevel = blockState.getLightLevel();
Location location = blockState.getLocation();
World world = blockState.getWorld();
int x = blockState.getX();
int y = blockState.getY();
int z = blockState.getZ();
Material type = blockState.getType();
int typeId = blockState.getTypeId();
```

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

### GET /entity/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities available within the org.bukkit.entity package.

```APIDOC
## GET /entity/hierarchy

### Description
Returns the class hierarchy for entities, detailing which interfaces and base classes (such as Animals, Ageable, or Tameable) specific entities implement or extend.

### Method
GET

### Endpoint
/entity/hierarchy

### Parameters
None

### Request Example
GET /entity/hierarchy

### Response
#### Success Response (200)
- **entities** (array) - A list of entity classes and their inheritance structure.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Sheep",
      "extends": ["org.bukkit.entity.Animals", "org.bukkit.material.Colorable"]
    },
    {
      "class": "org.bukkit.entity.Wolf",
      "extends": ["org.bukkit.entity.Animals", "org.bukkit.entity.Tameable"]
    }
  ]
}
```

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

### Get Plugin by Class

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/plugin/java/JavaPlugin.html

Provides fast access to the plugin that provided the given JavaPlugin class. It's used to get a reference to a specific plugin instance based on its class.

```java
public static <T extends JavaPlugin> T getPlugin(java.lang.Class<T> clazz)
```

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

### Initialize Button Object

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Button.html

Demonstrates the constructor usage for creating a new Button instance. It shows both the default constructor and the constructor accepting a Material type.

```java
Button button = new Button();
Button stoneButton = new Button(Material.STONE_BUTTON);
```

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

### Implementing a Custom MessagePrompt

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/conversations/MessagePrompt.html

Demonstrates how to extend the MessagePrompt class to create a custom prompt that displays a message and transitions to a subsequent prompt.

```java
import org.bukkit.conversations.ConversationContext;
import org.bukkit.conversations.MessagePrompt;
import org.bukkit.conversations.Prompt;

public class MyMessagePrompt extends MessagePrompt {
    @Override
    public String getPromptText(ConversationContext context) {
        return "This is a message prompt that does not wait for input.";
    }

    @Override
    protected Prompt getNextPrompt(ConversationContext context) {
        return Prompt.END_OF_CONVERSATION;
    }
}
```

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

### Get Default World Generator - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/plugin/Plugin.html

Gets a ChunkGenerator for use in a default world as specified in the server configuration. Parameters include the world name and a unique ID for the generator.

```java
ChunkGenerator getDefaultWorldGenerator(java.lang.String worldName, java.lang.String id)
```

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

### GET /entities/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the hierarchical structure of entity types within the Bukkit/PandaSpigot framework.

```APIDOC
## GET /entities/hierarchy

### Description
Returns a list of entity classes and their inheritance relationships within the PandaSpigot API.

### Method
GET

### Endpoint
/entities/hierarchy

### Parameters
None

### Response
#### Success Response (200)
- **entities** (array) - A list of entity objects representing the hierarchy.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Animals",
      "subclasses": ["org.bukkit.entity.Chicken", "org.bukkit.entity.Cow", "org.bukkit.entity.Wolf"]
    }
  ]
}
```

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

### NotePlayEvent - Getters and Setters

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/event/block/NotePlayEvent.html

Provides methods to retrieve and modify the state of the NotePlayEvent. This includes checking if the event is cancelled, getting and setting the instrument, and getting and setting the note to be played.

```java
public boolean isCancelled()
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins 

Specified by:
    isCancelled in interface Cancellable 

Returns:
    true if this event is cancelled
```

```java
public void setCancelled(boolean cancel)
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins. 

Specified by:
    setCancelled in interface Cancellable 

Parameters:
    cancel - true if you wish to cancel this event
```

```java
public Instrument getInstrument()
Gets the Instrument to be used. 

Returns:
    the Instrument;
```

```java
public void setInstrument(Instrument instrument)
Overrides the Instrument to be used. 

Parameters:
    instrument - the Instrument. Has no effect if null.
```

```java
public Note getNote()
Gets the Note to be played. 

Returns:
    the Note.
```

```java
public void setNote(Note note)
Overrides the Note to be played. 

Parameters:
    note - the Note. Has no effect if null.
```

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

### Server Configuration and Settings

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Server.html

Methods for configuring server settings and managing specific server behaviors. This includes getting and setting options like whether the End or Nether is allowed, and flight.

```java
void configureDbConfig(com.avaje.ebean.config.ServerConfig config)
populates a given ServerConfig with values attributes to this server.
boolean getAllowEnd()
gets whether this server allows the End or not.
boolean getAllowFlight()
gets whether this server allows flying or not.
boolean getAllowNether()
gets whether this server allows the Nether or not.
int getAmbientSpawnLimit()
gets user-specified limit for number of ambient mobs that can spawn in a chunk.
```

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

### Iterating Through DisplaySlot Constants - Java Example

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/scoreboard/DisplaySlot.html

Demonstrates how to iterate through all available DisplaySlot constants using the 'values()' method. This example shows a common pattern for accessing enum members.

```Java
for (DisplaySlot c : DisplaySlot.values())
    System.out.println(c);
```

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

### Get Line of Sight Blocks

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/entity/LivingEntity.html

Deprecated method to get all blocks along the living entity's line of sight. It scans from the eye position to a target, inclusive, up to a maximum distance.

```Java
@Deprecated
java.util.List<Block> getLineOfSight(java.util.HashSet<java.lang.Byte> transparent, int maxDistance)
```

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

### Managing Configuration Headers and Options

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/configuration/file/YamlConfiguration.html

Methods to retrieve configuration options and manage the compilation of configuration file headers.

```java
public YamlConfigurationOptions options() {}
protected String buildHeader() {}
protected String parseHeader(String input) {}
```

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

### GET /entity/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities, including base classes like Entity, Monster, and Ageable, and their respective implementations.

```APIDOC
## GET /entity/hierarchy

### Description
Returns the hierarchical structure of entities available in the PandaSpigot API, detailing inheritance patterns for mobs, animals, and complex entities.

### Method
GET

### Endpoint
/entity/hierarchy

### Parameters
None

### Request Example
GET /entity/hierarchy

### Response
#### Success Response (200)
- **entities** (array) - A list of entity classes and their inheritance relationships.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Entity",
      "subclasses": ["org.bukkit.entity.Ageable", "org.bukkit.entity.Monster"]
    },
    {
      "class": "org.bukkit.entity.Player",
      "interfaces": ["org.bukkit.command.CommandSender", "org.bukkit.OfflinePlayer"]
    }
  ]
}
```

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

### Initialize Rails Object

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Rails.html

Demonstrates how to instantiate a Rails object using the default constructor or by specifying the Material type.

```java
Rails rails = new Rails();
Rails railsFromMaterial = new Rails(Material.RAILS);
```

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

### Get Spawn Ticks

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Server.html

Gets the default tick intervals for spawning animals and monsters. Values can affect spawn rates, with specific notes on disabling spawns or using server configurations.

```java
int getTicksPerAnimalSpawns()
```

```java
int getTicksPerMonsterSpawns()
```

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

### GET /entities/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities within the PandaSpigot framework, detailing inheritance patterns for monsters, animals, and NPCs.

```APIDOC
## GET /entities/hierarchy

### Description
Returns a comprehensive list of entity types and their inheritance relationships within the org.bukkit.entity package.

### Method
GET

### Endpoint
/entities/hierarchy

### Parameters
None

### Request Example
GET /entities/hierarchy

### Response
#### Success Response (200)
- **entities** (array) - A list of entity classes and their parent interfaces/classes.

#### Response Example
{
  "entities": [
    { "class": "org.bukkit.entity.Monster", "subclasses": ["org.bukkit.entity.Blaze", "org.bukkit.entity.Zombie"] },
    { "class": "org.bukkit.entity.Player", "extends": ["org.bukkit.entity.HumanEntity", "org.bukkit.command.CommandSender"] }
  ]
}
```

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

### GET /entity/list

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the hierarchical list of entities available in the Pandaspigot API, categorized by their base types such as Animals, Monsters, and NPCs.

```APIDOC
## GET /entity/list

### Description
Returns a structured list of entity types and their inheritance relationships within the Bukkit entity framework.

### Method
GET

### Endpoint
/entity/list

### Parameters
None

### Request Example
GET /entity/list

### Response
#### Success Response (200)
- **entities** (array) - A list of entity classes and their parent interfaces/classes.

#### Response Example
{
  "entities": [
    "org.bukkit.entity.Animals",
    "org.bukkit.entity.Monster",
    "org.bukkit.entity.NPC"
  ]
}
```

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

### GET /api/blocks

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the hierarchical structure of block states and container blocks available in the PandaSpigot API.

```APIDOC
## GET /api/blocks

### Description
Returns the hierarchy of block states, including containers like Chests, Furnaces, and Dispensers.

### Method
GET

### Endpoint
/api/blocks

### Parameters
None

### Request Example
GET /api/blocks

### Response
#### Success Response (200)
- **blocks** (array) - A list of block state classes and their inheritance.

#### Response Example
{
  "blocks": [
    "org.bukkit.block.BlockState",
    "org.bukkit.block.Chest",
    "org.bukkit.block.Furnace"
  ]
}
```

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

### Get Wood Door Item Type

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Door.html

Retrieves the item type for a wooden door based on the provided tree species. Used to get the correct Material enum for a specific wood type.

```Java
public static Material getWoodDoorOfSpecies(TreeSpecies species)
```

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

### GET /entity/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural classification and inheritance hierarchy of entities within the PandaSpigot API.

```APIDOC
## GET /entity/hierarchy

### Description
Provides a hierarchical view of entity types, showing how specific entities like Animals, Monsters, and NPCs inherit from base classes.

### Method
GET

### Endpoint
/entity/hierarchy

### Parameters
None

### Request Example
{}

### Response
#### Success Response (200)
- **entities** (array) - A list of entity objects with their respective inheritance paths.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Animals",
      "subclasses": ["org.bukkit.entity.Chicken", "org.bukkit.entity.Cow", "org.bukkit.entity.Wolf"]
    },
    {
      "class": "org.bukkit.entity.Monster",
      "subclasses": ["org.bukkit.entity.Creeper", "org.bukkit.entity.Zombie", "org.bukkit.entity.Skeleton"]
    }
  ]
}
```

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

### GET /api/entities

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the hierarchical structure of entities within the PandaSpigot API, including animals, creatures, and specific entity types.

```APIDOC
## GET /api/entities

### Description
Returns a list of available entities and their inheritance structure, such as Animals, Tameable entities, and Vehicles.

### Method
GET

### Endpoint
/api/entities

### Parameters
None

### Request Example
GET /api/entities

### Response
#### Success Response (200)
- **entities** (array) - A list of entity types and their parent classes.

#### Response Example
{
  "entities": [
    "org.bukkit.entity.Animals",
    "org.bukkit.entity.Ocelot",
    "org.bukkit.entity.Wolf"
  ]
}
```

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

### Vine Class Initialization and Face Manipulation

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/Vine.html

Examples showing how to instantiate a Vine object and manipulate its attachment to block faces using the PandaSpigot API.

```java
import org.bukkit.material.Vine;
import org.bukkit.block.BlockFace;

// Initialize a new Vine
Vine vine = new Vine();

// Attach to a face
vine.putOnFace(BlockFace.NORTH);

// Check attachment
boolean isAttached = vine.isOnFace(BlockFace.NORTH);

// Remove from a face
vine.removeFromFace(BlockFace.NORTH);
```

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

### PistonExtensionMaterial Methods (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/PistonExtensionMaterial.html

Includes methods for getting and setting the facing direction, checking and setting the sticky state, and getting the attached face of a piston extension. Also includes a clone method.

```Java
public void setFacingDirection(BlockFace face)
public BlockFace getFacing()
public boolean isSticky()
public void setSticky(boolean sticky)
public BlockFace getAttachedFace()
public PistonExtensionMaterial clone()
```

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

### GET /entity/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities available in the PandaSpigot API, detailing inheritance patterns for mobs, players, and vehicles.

```APIDOC
## GET /entity/hierarchy

### Description
Returns the hierarchical structure of entity types, showing which classes extend others (e.g., Monster, Animals, Minecart).

### Method
GET

### Endpoint
/entity/hierarchy

### Parameters
None

### Request Example
GET /entity/hierarchy

### Response
#### Success Response (200)
- **entities** (array) - A list of entity classes and their inheritance metadata.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Player",
      "extends": ["org.bukkit.command.CommandSender", "org.bukkit.entity.HumanEntity"]
    },
    {
      "class": "org.bukkit.entity.Monster",
      "subclasses": ["org.bukkit.entity.Creeper", "org.bukkit.entity.Zombie"]
    }
  ]
}
```

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

### Command Constructors in Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/command/Command.html

Provides details on the constructors for the Command class, allowing initialization with different parameters.

```java
protected Command(java.lang.String name)
```

```java
protected Command(java.lang.String name,
                  java.lang.String description,
                  java.lang.String usageMessage,
                  java.util.List<java.lang.String> aliases)
```

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

### Get and Set Item Lore (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/inventory/meta/ItemMeta.html

Retrieves or sets the lore for an item. The lore is represented as a list of Components. Ensure to check hasLore() before getting lore. Setting lore to null removes it.

```java
default java.util.List<net.kyori.adventure.text.Component> lore()

Gets the lore that is set. 
Plugins should check if hasLore() returns `true` before calling this method. 

Returns:
    a list of lore that is set
```

```java
default void lore(java.util.List<net.kyori.adventure.text.Component> lore)

Sets the lore for this item. Removes lore when given null. 

Parameters:
    `lore` - the lore that will be set
```

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

### GET /api/entities/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities defined within the PandaSpigot API, including inheritance details for Animals, Creatures, and specific mobs.

```APIDOC
## GET /api/entities/hierarchy

### Description
Returns a structured representation of the entity class hierarchy, showing how various entities like Chicken, Cow, and Horse inherit from base classes such as Animals, Creature, or Ageable.

### Method
GET

### Endpoint
/api/entities/hierarchy

### Parameters
None

### Request Example
GET /api/entities/hierarchy

### Response
#### Success Response (200)
- **hierarchy** (object) - A nested object structure representing the inheritance tree of entities.

#### Response Example
{
  "entity": "Animals",
  "subtypes": [
    "Chicken",
    "Cow",
    "Horse",
    "Ocelot",
    "Pig",
    "Rabbit",
    "Sheep",
    "Wolf"
  ]
}
```

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

### GET /entities/hierarchy

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/overview-tree.html

Retrieves the structural hierarchy of entities available within the PandaSpigot API, detailing inheritance relationships between classes such as Monster, Animals, and HumanEntity.

```APIDOC
## GET /entities/hierarchy

### Description
Returns the class hierarchy for entities in the PandaSpigot framework. This helps developers understand the inheritance tree for mobs, players, and vehicles.

### Method
GET

### Endpoint
/entities/hierarchy

### Parameters
#### Query Parameters
- **type** (string) - Optional - Filter by specific entity category (e.g., 'Monster', 'Animals').

### Request Example
{
  "filter": "all"
}

### Response
#### Success Response (200)
- **entities** (array) - A list of entity class paths and their parent/child relationships.

#### Response Example
{
  "entities": [
    {
      "class": "org.bukkit.entity.Monster",
      "subclasses": ["org.bukkit.entity.Blaze", "org.bukkit.entity.Zombie"]
    }
  ]
}
```

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

### LoadingIntMap get Method

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/co/aikar/util/LoadingIntMap.html

Retrieves the value associated with the specified key. If the key does not exist, the loader function is called to compute and load the value. This method overrides the default get behavior from the superclass.

```java
public V get(int key)
```

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

### POST /conversation/begin

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/conversations/Conversation.html

Initializes and starts a new conversation session with a specified user.

```APIDOC
## POST /conversation/begin

### Description
Initializes a new conversation instance and begins redirecting the user's chat responses to the conversation prompts.

### Method
POST

### Endpoint
/conversation/begin

### Request Body
- **plugin** (Plugin) - Required - The plugin owning the conversation.
- **forWhom** (Conversable) - Required - The entity participating in the conversation.
- **firstPrompt** (Prompt) - Required - The initial prompt in the graph.
- **initialSessionData** (Map<Object, Object>) - Optional - Initial values for the conversation context.

### Request Example
{
  "plugin": "MyPlugin",
  "forWhom": "PlayerObject",
  "firstPrompt": "WelcomePrompt"
}

### Response
#### Success Response (200)
- **status** (string) - Indicates the conversation has successfully begun.
```

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

### BlockFace Enum Methods

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/block/BlockFace.html

Details the methods available for the BlockFace enum, including static methods to get enum constants by name or all constants, and instance methods to get coordinate modifications and the opposite face.

```java
public static BlockFace[] values()
Returns an array containing the constants of this enum type, in the order they are declared.
public static BlockFace valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
public int getModX()
Get the amount of X-coordinates to modify to get the represented block.
public int getModY()
Get the amount of Y-coordinates to modify to get the represented block.
public int getModZ()
Get the amount of Z-coordinates to modify to get the represented block.
public BlockFace getOppositeFace()
```

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

### HelpTopic Method: getFullText - Java

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/help/HelpTopic.html

Retrieves the complete description of the help topic, displayed when a user requests detailed information about the topic. The output may be paginated for display.

```java
public java.lang.String getFullText(CommandSender forWho)
```

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

### Instantiate MonsterEggs

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/MonsterEggs.html

Demonstrates how to create a new instance of the MonsterEggs class using the standard constructor.

```java
MonsterEggs eggs = new MonsterEggs();
```

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

### Get DyeColor by Color (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/DyeColor.html

Gets the DyeColor constant with the specified java.awt.Color value. It returns null if no constant matches the color. This method is useful for finding a dye based on its standard color representation.

```Java
public static DyeColor getByColor(Color color)

```

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

### Get DyeColor by Firework Color (Java)

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/DyeColor.html

Gets the DyeColor constant with the specified firework color value. It returns null if no constant matches the color. This method is useful for finding a dye based on its firework color representation.

```Java
public static DyeColor getByFireworkColor(Color color)

```

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

### POST /execute

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/command/defaults/HelpCommand.html

Executes the help command for a given sender with specific arguments.

```APIDOC
## POST /execute

### Description
Executes the help command, processing the arguments provided by the command sender.

### Method
POST

### Endpoint
/execute

### Parameters
#### Request Body
- **sender** (CommandSender) - Required - The source object executing the command.
- **currentAlias** (String) - Required - The alias of the command used.
- **args** (String[]) - Required - The arguments passed to the command.

### Request Example
{
  "sender": "Player",
  "currentAlias": "help",
  "args": ["list"]
}

### Response
#### Success Response (200)
- **success** (boolean) - Returns true if the command was successful.

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

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

### SpawnEgg Class Overview

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/material/SpawnEgg.html

Provides an overview of the SpawnEgg class, its purpose, and its relationship to other classes.

```APIDOC
## Class: SpawnEgg

### Description
Represents a spawn egg that can be used to spawn mobs.

### Inheritance
- `java.lang.Object`
  - `org.bukkit.material.MaterialData`
    - `org.bukkit.material.SpawnEgg`

### Implements
- `java.lang.Cloneable`
```

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

### Configure Server Environment

Source: https://repo.hpfxd.com/javadoc/releases/com/hpfxd/pandaspigot/pandaspigot-api/1.8.8-R0.1-SNAPSHOT/.cache/unpack/org/bukkit/Server.html

Methods to manage default game modes, console command senders, and file system access for world containers.

```java
GameMode getDefaultGameMode();
void setDefaultGameMode(GameMode mode);
ConsoleCommandSender getConsoleSender();
File getWorldContainer();
```
Tokens:
Raw