Mythic

https://www.mythiccraft.io/javadocs/mythic
Admin
Mythic is a comprehensive API framework for creating and managing custom mythical creatures, skills,...
Tokens:900,655
Snippets:4,663
Trust Score:8.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### BukkitBoatChest.instantiate

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitBoatChest

Instantiates the BukkitBoatChest with provided configuration.

```APIDOC
## POST /websites/mythiccraft_io_javadocs_mythic/instantiate

### Description
Instantiates the BukkitBoatChest entity using the provided MythicConfig.

### Method
POST

### Endpoint
`/websites/mythiccraft_io_javadocs_mythic/instantiate`

### Parameters
#### Query Parameters
- **config** (MythicConfig) - Required - The configuration object for instantiation.

#### Request Body
None

### Request Example
```java
// Assuming 'mythicConfig' is an instance of MythicConfig
bukkitBoatChest.instantiate(mythicConfig);
```

### Response
#### Success Response (200)
- **void** - This method does not return a value.

#### Response Example
N/A

```

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

### Get Health of MythicMob

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/mobs/MobType

Retrieves the health of the MythicMob. This method can be called without parameters to get the general health, or with an ActiveMob object to get the health of a specific active instance.

```java
public PlaceholderDouble getHealth()

Specified by:
    `getHealth` in interface `MythicMob`
```

```java
public double getHealth(ActiveMob am)

Specified by:
    `getHealth` in interface `MythicMob`
```

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

### SkillExecutor - Get Location Target

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/skills/class-use/SkillMetadata

Gets the target location for a skill using SkillMetadata.

```APIDOC
## SkillExecutor - Get Location Target

### Description
Retrieves the target `AbstractLocation` for a skill using a `SkillTargeter` and the current `SkillMetadata` context.

### Method
`AbstractLocation`

### Endpoint
N/A (Java Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
AbstractLocation targetLocation = SkillExecutor.getLocationTarget(skillTargeter, skillMetadata);
```

### Response
#### Success Response (200)
Returns the target `AbstractLocation`.

#### Response Example
```json
{
  "example": "AbstractLocation object"
}
```
```

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

### MythicBukkit Bootstrap and Adapters

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/class-use/MythicBukkit

Documentation for classes and methods related to bootstrapping the MythicBukkit plugin and its adapters.

```APIDOC
## POST /mythicbukkit/bootstrap/load

### Description
Loads the MythicBukkit plugin using the provided BukkitBootstrap.

### Method
POST

### Endpoint
/mythicbukkit/bootstrap/load

### Parameters
#### Request Body
- **plugin** (MythicBukkit) - Required - The MythicBukkit plugin instance to load.

### Request Example
```json
{
  "plugin": "<MythicBukkitInstance>"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message upon successful loading.

#### Response Example
```json
{
  "message": "MythicBukkit plugin loaded successfully."
}
```

## POST /mythicbukkit/adapters/skill/load

### Description
Loads the BukkitSkillAdapter, requiring a MythicBukkit plugin instance.

### Method
POST

### Endpoint
/mythicbukkit/adapters/skill/load

### Parameters
#### Request Body
- **plugin** (MythicBukkit) - Required - The MythicBukkit plugin instance.

### Request Example
```json
{
  "plugin": "<MythicBukkitInstance>"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "BukkitSkillAdapter loaded successfully."
}
```

## POST /mythicbukkit/adapters/stat/load

### Description
Loads the BukkitStatListener, requiring a MythicBukkit plugin instance.

### Method
POST

### Endpoint
/mythicbukkit/adapters/stat/load

### Parameters
#### Request Body
- **arg0** (MythicBukkit) - Required - The MythicBukkit plugin instance.

### Request Example
```json
{
  "arg0": "<MythicBukkitInstance>"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "BukkitStatListener loaded successfully."
}
```
```

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

### SkillAdapter Initialization and Retrieval

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/adapters/SkillAdapter

This section details how to initialize and retrieve the SkillAdapter, which is crucial for integrating MythicMobs skills within a Bukkit environment.

```APIDOC
## SkillAdapter API

### Description
Provides methods for initializing and accessing the SkillAdapter, a core component for managing skills in the MythicCraft ecosystem.

### Method
`initializeBukkit(MythicBukkit plugin)`

### Description
Initializes the Bukkit-specific adapter for MythicMobs skills.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
MythicBukkit plugin = ...; // Obtain your MythicBukkit plugin instance
SkillAdapter.initializeBukkit(plugin);
```

### Response
#### Success Response (200)
Void

#### Response Example
N/A (This is a method call, not an HTTP request/response)

---

### Method
`get()`

### Description
Retrieves the static instance of the AbstractSkillAdapter.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
AbstractSkillAdapter adapter = SkillAdapter.get();
```

### Response
#### Success Response (200)
- **adapter** (AbstractSkillAdapter) - The singleton instance of the AbstractSkillAdapter.

#### Response Example
```java
// Assuming 'adapter' is the returned value from SkillAdapter.get()
// You can now use adapter methods, e.g.:
// adapter.someSkillMethod(...);
```

---

### Field Summary

*   **adapter** (`AbstractSkillAdapter`) - The static, protected adapter instance.
```

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

### PhatLootsDrop Constructor and Get Method

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/drops/droppables/PhatLootsDrop

Details for the PhatLootsDrop constructor and the get method, which is part of the IMultiDrop interface.

```APIDOC
## PhatLootsDrop API

### Description
Provides details about the PhatLootsDrop class, including its constructor and the `get` method.

### Constructor Details

#### PhatLootsDrop(String line, MythicLineConfig config)

*   **Description**: Constructs a new PhatLootsDrop.
*   **Parameters**:
    *   `line` (String) - The configuration line.
    *   `config` (MythicLineConfig) - The MythicLineConfig object.

### Method Details

#### get(DropMetadata meta)

*   **Description**: Retrieves a LootBag based on the provided metadata.
*   **Method**: public
*   **Interface**: `IMultiDrop`
*   **Parameters**:
    *   `meta` (DropMetadata) - The metadata for the drop.
*   **Returns**: (LootBag) - The generated LootBag.
```

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

### BukkitFirework Constructor and Launch Method

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/adapters/BukkitFirework

This section details the constructor for BukkitFirework and its launch method, including parameters and their descriptions.

```APIDOC
## BukkitFirework API

### Description
Provides functionality to create and launch fireworks within the Bukkit Minecraft server environment.

### Constructor
`BukkitFirework(String type, int duration, Collection<Color> colors, Collection<Color> fadeColors, boolean flicker, boolean trail)`

**Parameters:**
- **type** (String) - The type of firework effect.
- **duration** (int) - The duration of the firework effect.
- **colors** (Collection<Color>) - A collection of colors for the firework.
- **fadeColors** (Collection<Color>) - A collection of fade colors for the firework.
- **flicker** (boolean) - Whether the firework should flicker.
- **trail** (boolean) - Whether the firework should leave a trail.

### Method
`void launch(SkillMetadata data, AbstractLocation location)`

**Description:**
Launches the firework at the specified location with the given skill metadata.

**Parameters:**
- **data** (SkillMetadata) - Metadata associated with the skill that is launching the firework.
- **location** (AbstractLocation) - The location where the firework should be launched.
```

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

### StaticInt Constructor and Get Methods (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/placeholders/parsers/StaticInt

This snippet demonstrates the constructor and various 'get' methods of the StaticInt class. The constructor initializes the static integer, and the 'get' methods retrieve the integer value, with some variations accepting different parameters like PlaceholderMeta, AbstractEntity, or SkillCaster.

```Java
public class StaticInt extends PlaceholderIntImpl {
    public StaticInt(String string) {
        // Constructor implementation
    }

    public int get() {
        // Method implementation
    }

    public int get(PlaceholderMeta meta) {
        // Method implementation
    }

    public int get(AbstractEntity entity) {
        // Method implementation
    }

    public int get(PlaceholderMeta meta, AbstractEntity entity) {
        // Method implementation
    }

    public int get(SkillCaster caster) {
        // Method implementation
    }

    @Override
    public String toString() {
        // Method implementation
    }
}
```

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

### ConfigMenu Constructor

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/menus/config/ConfigMenu

Initializes a new instance of the ConfigMenu class.

```APIDOC
## ConfigMenu Constructor

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

### Method
```
public ConfigMenu(MythicBukkit plugin, MenuManager manager)
```

### Parameters
* **plugin** (MythicBukkit) - The MythicBukkit plugin instance.
* **manager** (MenuManager) - The MenuManager instance.
```

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

### DropMetadata Method Implementations (Example)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/drops/DropMetadata

Illustrates example implementations of key methods from the DropMetadata interface, such as getDropper, getCause, getAmount, and setAmount.

```java
Optional<SkillCaster> getDropper() {
    // Implementation details for retrieving the dropper
    return Optional.empty(); // Placeholder
}

Optional<AbstractEntity> getCause() {
    // Implementation details for retrieving the cause
    return Optional.empty(); // Placeholder
}

float getAmount() {
    // Implementation details for retrieving the amount
    return 0.0f; // Placeholder
}

void setAmount(float amount) {
    // Implementation details for setting the amount
}
```

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

### Method: instantiate

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitBee

Documentation for the `instantiate` method, which is specified by `MythicEntity`.

```APIDOC
## Method: instantiate

`public void instantiate(MythicConfig mc)`

### Description
Instantiates the Bee entity with the provided MythicConfig object.

### Specified by
`instantiate` in class `MythicEntity`
```

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

### StatRegistry.StatMap Get and Comparison (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/stats/StatRegistry.StatMap

Retrieves the current calculated value of the statistic and compares this StatMap instance with another. `get` returns the effective statistic value, while `compareTo` is used for ordering.

```Java
public double get()
public int compareTo(StatRegistry.StatMap other)
```

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

### BukkitWitherSkeleton Constructor and Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitWitherSkeleton

Provides details on the constructor and key methods of the BukkitWitherSkeleton class, including instantiation, spawning, applying options, comparing entities, and checking instance types.

```APIDOC
## BukkitWitherSkeleton API

### Description
This section details the `BukkitWitherSkeleton` class, which extends `BukkitEntityType`. It covers its constructor and essential methods for managing Wither Skeleton entities in a Bukkit environment.

### Class Hierarchy
`java.lang.Object` -> `io.lumine.mythic.api.mobs.entities.MythicEntity` -> `io.lumine.mythic.bukkit.adapters.BukkitEntityType` -> `io.lumine.mythic.bukkit.entities.BukkitWitherSkeleton`

### Constructor Details

#### `BukkitWitherSkeleton()`

*   **Description**: Initializes a new instance of the `BukkitWitherSkeleton` class.
*   **Method**: Constructor

### Method Details

#### `instantiate(MythicConfig mc)`

*   **Description**: Instantiates the Wither Skeleton entity using a provided `MythicConfig`.
*   **Method**: `void instantiate(MythicConfig mc)`
*   **Inherited from**: `io.lumine.mythic.api.mobs.entities.MythicEntity`

#### `spawn(Location location, SpawnReason reason, Consumer<Entity> prespawnFunc)`

*   **Description**: Spawns a Wither Skeleton entity at a specific location with given spawn reason and a pre-spawn function.
*   **Method**: `org.bukkit.entity.Entity spawn(org.bukkit.Location location, SpawnReason reason, Consumer<org.bukkit.entity.Entity> prespawnFunc)`
*   **Inherited from**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### `applyOptions(Entity e)`

*   **Description**: Applies specific Bukkit entity options to an existing entity.
*   **Method**: `org.bukkit.entity.Entity applyOptions(org.bukkit.entity.Entity e)`
*   **Inherited from**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### `compare(Entity e)`

*   **Description**: Compares the current `BukkitWitherSkeleton` instance with another Bukkit entity.
*   **Method**: `boolean compare(org.bukkit.entity.Entity e)`
*   **Inherited from**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### `isInstanceOf(Entity e)`

*   **Description**: Checks if the provided Bukkit entity is an instance of `BukkitWitherSkeleton`.
*   **Method**: `static boolean isInstanceOf(org.bukkit.entity.Entity e)`
*   **Inherited from**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`
```

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

### Get Particle Name and ID (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/ParticleMaker.ParticleType

Provides methods to get the string name and integer ID for a given ParticleMaker.ParticleType. These are fundamental for identifying and referencing particle effects.

```java
public String getName()
public int getId()
```

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

### Metrics Status and Start

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/metrics/MetricsLite

Checks if the server owner has opted out of plugin metrics. The 'start' method initiates the measurement of statistics, creating an asynchronous task to send data periodically.

```java
public boolean isOptOut()

public boolean start()

```

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

### MythicItem Constructor and getConfig

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/config/class-use/MythicConfig

Shows how MythicItem can be constructed with a MythicConfig and how to retrieve the associated MythicConfig from an existing MythicItem.

```java
new MythicItem(Pack pack, File file, String internalName, MythicConfig mc);
MythicItem.getConfig();
```

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

### instantiate Method

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitSniffer

Instantiates a MythicConfig object.

```APIDOC
## void instantiate(MythicConfig mc)

### Description
Instantiates a MythicConfig object. This method is specified by the MythicEntity class.

### Method
`void`

### Endpoint
N/A

### Parameters
#### Request Body
- **mc** (MythicConfig) - Required - The MythicConfig object to instantiate.

### Request Example
```json
{
  "mc": {
    "config_data": "..."
  }
}
```

### Response
#### Success Response (200)
Indicates successful instantiation.

#### Response Example
```json
{
  "message": "MythicConfig instantiated successfully"
}
```
```

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

### DropExecutor Get Drop Table Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/drops/DropExecutor

Retrieves drop table information from the DropExecutor. This includes fetching a specific drop table by name or getting a collection of all available drop tables.

```java
public Optional<DropTable> getDropTable(String name)
public Collection<DropTable> getDropTables()
```

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

### Method: instantiate(MythicConfig mc)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitBlockDisplay

Instantiates the BukkitBlockDisplay entity using configuration from MythicConfig.

```APIDOC
## Method: instantiate(MythicConfig mc)

### Description
Initializes and configures the `BukkitBlockDisplay` entity based on the provided `MythicConfig` object. This method is specified by the `MythicEntity` interface.

### Method
`public void instantiate(MythicConfig mc)`

### Endpoint
N/A (Instance method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **mc** (MythicConfig) - Required - The configuration object used to instantiate the entity.

### Request Example
```java
MysticConfig config = ...; // Load or create MythicConfig
BukkitBlockDisplay display = new BukkitBlockDisplay();
display.instantiate(config);
```

### Response
None

### Error Handling
Potential exceptions may be thrown if the `MythicConfig` is invalid or improperly formatted.
```

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

### Get AbstractPlayer Instances in MythicCraft API Adapters

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/adapters/class-use/AbstractPlayer

Demonstrates methods within io.lumine.mythic.api.adapters for retrieving AbstractPlayer instances. These include getting a player by name or UUID, and fetching all online players.

```java
AbstractPlayer player = ServerInterface.getPlayer(String name);
AbstractPlayer player = ServerInterface.getPlayer(UUID uuid);
List<AbstractPlayer> onlinePlayers = ServerInterface.getOnlinePlayers();
```

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

### Get MythicEntityType Enum Values

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/mobs/entities/class-use/MythicEntityType

Provides methods to get a specific MythicEntityType enum constant by its name or to retrieve all available enum constants. These are fundamental for working with the MythicEntityType enumeration.

```java
MythicEntityType.get(String s)
MythicEntityType.valueOf(String name)
MythicEntityType.values()
```

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

### BukkitFox Constructor and Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitFox

Provides details on the constructor and key methods of the BukkitFox class, including instantiation, spawning, applying options, comparing entities, and getting height.

```APIDOC
## BukkitFox Class Documentation

### Description
Represents a Fox entity within the MythicCraft Bukkit environment. This class extends `BukkitEntityType` and implements `TameableEntityType`, providing specific functionalities for fox entities.

### Constructor

*   **BukkitFox()**
    *   Description: Initializes a new instance of the `BukkitFox` class.

### Methods

#### `instantiate(MythicConfig mc)`

*   **Method**: `void`
*   **Description**: Instantiates the BukkitFox entity using a provided `MythicConfig`.
*   **Specified by**: `instantiate` in class `MythicEntity`

#### `spawn(Location location, SpawnReason reason, Consumer<Entity> prespawnFunc)`

*   **Method**: `Entity`
*   **Description**: Spawns a BukkitFox entity at the specified location with given reason and an optional prespawn function.
*   **Specified by**: `spawn` in class `BukkitEntityType`

#### `applyOptions(Entity entity)`

*   **Method**: `Entity`
*   **Description**: Applies specific options to an existing Bukkit entity, customizing its behavior as a BukkitFox.
*   **Specified by**: `applyOptions` in class `BukkitEntityType`

#### `compare(Entity e)`

*   **Method**: `boolean`
*   **Description**: Compares the current BukkitFox entity with another Bukkit entity to determine equality or compatibility.
*   **Specified by**: `compare` in class `BukkitEntityType`

#### `getHeight()`

*   **Method**: `int`
*   **Description**: Retrieves the height of the BukkitFox entity.
*   **Overrides**: `getHeight` in class `MythicEntity`

### Inherited Methods

*   **From `BukkitEntityType`**: `getHead`, `getHeadString`, `MythicEntity getMythicEntity(...)`, `spawn(...)`, `spawnBaseEntity`, `spawnEntity`
*   **From `Object`**: `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`
*   **From `TameableEntityType`**: `getTameableProperty`
```

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

### castAtEntity Method Implementation Example

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/skills/ITargetedEntitySkill

Example of how the castAtEntity method might be implemented to apply a skill effect to a targeted entity. This method is crucial for skills that interact directly with entities.

```java
SkillResult castAtEntity(SkillMetadata data, AbstractEntity target)
  {
    // Implementation logic for casting a skill at a specific entity
    // For example, applying damage, effects, or other mechanics.
    return SkillResult.SUCCESS;
  }
```

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

### BukkitTraderLlama Constructor and Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitTraderLlama

This section details the constructor and key methods of the BukkitTraderLlama class, including instantiation, spawning, applying entity options, comparing entities, and retrieving height.

```APIDOC
## BukkitTraderLlama API

### Description
Provides documentation for the BukkitTraderLlama class, a specific entity type within the MythicCraftbukkit plugin. It details its constructors and methods for managing entity behavior.

### Method
N/A (This is a class documentation, not a specific endpoint)

### Endpoint
N/A

### Constructor
#### BukkitTraderLlama()
- **Description**: Initializes a new instance of the BukkitTraderLlama class.

### Methods
#### instantiate
- **Method**: `void instantiate(MythicConfig mc)`
- **Description**: Instantiates the entity based on MythicConfig settings.
- **Inherited From**: `io.lumine.mythic.api.mobs.entities.MythicEntity`

#### spawn
- **Method**: `org.bukkit.entity.Entity spawn(org.bukkit.Location location, SpawnReason reason, Consumer<org.bukkit.entity.Entity> prespawnFunc)`
- **Description**: Spawns a BukkitTraderLlama entity at the specified location with given spawn reason and a prespawn function.
- **Inherited From**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### applyOptions
- **Method**: `org.bukkit.entity.Entity applyOptions(org.bukkit.entity.Entity entity)`
- **Description**: Applies specific BukkitTraderLlama options to an existing Bukkit entity.
- **Inherited From**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### compare
- **Method**: `boolean compare(org.bukkit.entity.Entity e)`
- **Description**: Compares this BukkitTraderLlama with another Bukkit entity.
- **Inherited From**: `io.lumine.mythic.bukkit.adapters.BukkitEntityType`

#### getHeight
- **Method**: `int getHeight()`
- **Description**: Retrieves the height of the BukkitTraderLlama entity.
- **Overrides**: `getHeight` in class `MythicEntity`

### Methods inherited from class io.lumine.mythic.bukkit.adapters.BukkitEntityType
- `getHead, getHeadString, getMythicEntity, getMythicEntity, getMythicEntity, spawn, spawn, spawn, spawnBaseEntity, spawnEntity`

### Methods inherited from class java.lang.Object
- `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Methods inherited from interface io.lumine.mythic.bukkit.entities.properties.TameableEntityType
- `getTameableProperty`
```

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

### BukkitEntity Constructor

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/adapters/BukkitEntity

Initializes a new BukkitEntity instance.

```APIDOC
## BukkitEntity Constructor

### Description
Initializes a new BukkitEntity instance with a provided Bukkit Entity.

### Method
**CONSTRUCTOR**

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
// This is a constructor, not directly callable like a method.
// Example usage would be within another class's instantiation process.
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

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

### StatRegistry Get Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/stats/StatRegistry

Provides methods to retrieve statistical data. This includes getting the value of a specific stat, retrieving all applicable stats, and accessing pre-process and post-process stat data for a given trigger.

```java
public double get(StatType type)
public Collection<StatType> getApplicableStats()
public Collection<StatType> getApplicableStats(SkillTrigger trigger)
public Collection<StatRegistry.StatMap> getPreProcessStats(SkillTrigger trigger)
public Collection<StatRegistry.StatMap> getPostProcessStats(SkillTrigger trigger)
public Optional<StatRegistry.StatMap> getStatData(StatType type)
```

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

### Get ThreadSafetyLevel Enum Values (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/skills/class-use/ThreadSafetyLevel

Provides static methods to retrieve an enum constant by its name or to get all constants of the ThreadSafetyLevel enum. These are utility methods for working with thread safety levels.

```java
import io.lumine.mythic.api.skills.ThreadSafetyLevel;

// Get a specific enum constant by name
ThreadSafetyLevel levelByName = ThreadSafetyLevel.valueOf("SAFE_ONLY");

// Get all enum constants
ThreadSafetyLevel[] allLevels = ThreadSafetyLevel.values();
```

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

### Construct MythicConfig Impl with MythicConfig

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/config/class-use/MythicConfig

Demonstrates how to create a new MythicConfigImpl instance using an existing MythicConfig object and a name. This is often used when creating new configuration contexts.

```java
new MythicConfig.MythicConfigImpl(MythicConfig config, String name);
```

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

### BukkitBee Class Overview

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitBee

Provides an overview of the BukkitBee class, its constructors, and methods.

```APIDOC
## Class BukkitBee

`public class BukkitBee extends BukkitEntityType`

### Description
Represents a Bee entity within the MythicCraft ecosystem, extending BukkitEntityType.

### Constructor Summary

| Constructor     | Description        |
|-----------------|--------------------|
| `BukkitBee()`   | Initializes a new BukkitBee instance. |

### Method Summary

| Modifier and Type | Method                                                                | Description                                                                                                |
|-------------------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| `org.bukkit.entity.Entity` | `applyOptions(org.bukkit.entity.Entity entity)`                       | Applies options to the given Bukkit entity.                                                                |
| `boolean`         | `compare(org.bukkit.entity.Entity e)`                                 | Compares this BukkitBee with another Bukkit entity.                                                        |
| `int`             | `getHeight()`                                                         | Gets the height of the Bee entity. Overrides `getHeight` in `MythicEntity`.                                |
| `void`            | `instantiate(MythicConfig mc)`                                        | Instantiates the Bee entity with the given MythicConfig. Specified by `instantiate` in `MythicEntity`.     |
| `org.bukkit.entity.Entity` | `spawn(org.bukkit.Location location, SpawnReason reason, Consumer<org.bukkit.entity.Entity> prespawnFunc)` | Spawns a Bee entity at the specified location with the given reason and prespawn function. Specified by `spawn` in `BukkitEntityType`. |

### Inherited Methods

* **From `io.lumine.mythic.bukkit.adapters.BukkitEntityType`**: `getHead`, `getHeadString`, `getMythicEntity`, `getMythicEntity`, `getMythicEntity`, `spawn`, `spawn`, `spawn`, `spawnBaseEntity`, `spawnEntity`
* **From `java.lang.Object`**: `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`
```

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

### Scope Enum Methods: get() and toString() (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/config/Scope

Details the instance methods of the Scope enum. The get() method is specified by the PropertyScope interface, and toString() provides a string representation of the enum constant.

```java
public String get() {
    // Returns a string representation of the scope.
}

public String toString() {
    // Overrides the default Enum toString() method.
}
```

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

### Get All Current Mob Counts - Java

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/spawning/MythicSpawnState

Provides a map of all mob spawn categories to their current mob counts. This method is useful for getting a snapshot of all mob populations. Part of the MythicSpawnState interface.

```java
Map<MobSpawnCategory,Integer> getCurrentMobCounts()
```

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

### BukkitSlime Constructor and Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitSlime

This section details the constructors and key methods of the BukkitSlime class, including instantiation, spawning, and entity manipulation.

```APIDOC
## BukkitSlime Class Documentation

### Description
Provides specific implementations for Bukkit Slime entities within the MythicCraft framework. It extends `MythicEntity` and `BukkitEntityType`.

### Methods

#### Constructor

- **BukkitSlime()**
  - Description: Initializes a new instance of the `BukkitSlime` class.

#### Core Methods

- **instantiate(MythicConfig mc)**
  - Description: Instantiates the slime entity based on MythicCraft configuration.
  - Method: `void`
  - Endpoint: N/A (Class method)
  - Parameters:
    - **mc** (MythicConfig) - Required - The configuration object.

- **spawn(org.bukkit.Location location, SpawnReason reason, Consumer<org.bukkit.entity.Entity> prespawnFunc)**
  - Description: Spawns a Bukkit Slime entity at the specified location with given parameters.
  - Method: `org.bukkit.entity.Entity`
  - Endpoint: N/A (Class method)
  - Parameters:
    - **location** (org.bukkit.Location) - Required - The location to spawn the entity.
    - **reason** (SpawnReason) - Required - The reason for spawning.
    - **prespawnFunc** (Consumer<org.bukkit.entity.Entity>) - Optional - A function to execute before spawning.

- **applyOptions(org.bukkit.entity.Entity entity)**
  - Description: Applies specific Bukkit options to an existing entity.
  - Method: `org.bukkit.entity.Entity`
  - Endpoint: N/A (Class method)
  - Parameters:
    - **entity** (org.bukkit.entity.Entity) - Required - The entity to apply options to.

- **compare(org.bukkit.entity.Entity e)**
  - Description: Compares this BukkitSlime instance with another Bukkit entity.
  - Method: `boolean`
  - Endpoint: N/A (Class method)
  - Parameters:
    - **e** (org.bukkit.entity.Entity) - Required - The entity to compare against.

- **getHeight()**
  - Description: Gets the height of the slime entity.
  - Method: `int`
  - Endpoint: N/A (Class method)

- **canSplit()**
  - Description: Checks if the slime can split into smaller slimes.
  - Method: `boolean`
  - Endpoint: N/A (Class method)

### Inherited Methods

- **Methods inherited from class `io.lumine.mythic.bukkit.adapters.BukkitEntityType`**: `getHead, getHeadString, getMythicEntity, getMythicEntity, getMythicEntity, spawn, spawn, spawn, spawnBaseEntity, spawnEntity`
- **Methods inherited from class `java.lang.Object`**: `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

### Request Example

```json
{
  "example": "This is a conceptual representation. Actual usage involves Bukkit API calls."
}
```

### Response

#### Success Response (200)

- **spawnedEntity** (org.bukkit.entity.Entity) - The spawned Bukkit entity.
- **result** (boolean) - Indicates success or failure of operations like `canSplit` or `compare`.
- **height** (int) - The height of the slime.

#### Response Example

```json
{
  "spawnedEntity": "<BukkitEntity Object>",
  "result": true,
  "height": 2
}
```
```

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

### Get String Value Methods for PlaceholderString

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/skills/placeholders/PlaceholderString

Details the various 'get' methods available on the PlaceholderString interface. These methods retrieve string representations of placeholders, with different overloads accepting contextual information such as AbstractEntity, SkillCaster, or PlaceholderMeta.

```java
String get();
String get(AbstractEntity entity);
String get(SkillCaster caster);
String get(PlaceholderMeta meta);
String get(PlaceholderMeta meta, AbstractEntity entity);
String get(PlaceholderMeta meta, AbstractLocation location);
```

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

### BukkitCustom Constructor and Methods (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitCustom

This snippet shows the default constructor for BukkitCustom and its primary methods: instantiate, spawn, applyOptions, and compare. The instantiate method takes a MythicConfig to set up the entity, while spawn allows for entity creation at a specific location with optional pre-spawn logic. applyOptions modifies entity properties, and compare checks for entity equality.

```java
public class BukkitCustom extends BukkitEntityType {
  public BukkitCustom() {
  }

  public void instantiate(MythicConfig mc) {
  }

  public org.bukkit.entity.Entity spawn(org.bukkit.Location location, SpawnReason reason, Consumer<org.bukkit.entity.Entity> prespawnFunc) {
  }

  public org.bukkit.entity.Entity applyOptions(org.bukkit.entity.Entity e) {
  }

  public boolean compare(org.bukkit.entity.Entity e) {
  }
}
```

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

### Get AuraRegistry from ActiveMob

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/auras/class-use/AuraRegistry

Retrieves the AuraRegistry associated with an ActiveMob.

```APIDOC
## GET ActiveMob.getAuraRegistry()

### Description
Returns the AuraRegistry instance associated with an ActiveMob.

### Method
GET

### Endpoint
`/activemob/auraregistry`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **AuraRegistry** (Object) - The AuraRegistry object.

#### Response Example
```json
{
  "auraRegistry": {
    "auras": [
      {
        "type": "Regeneration",
        "duration": 5000,
        "amplifier": 2
      }
    ]
  }
}
```
```

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

### GoToSpawnLocationGoal - Constructor

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/mobs/ai/goals/GoToSpawnLocationGoal

Initializes the GoToSpawnLocationGoal with the entity, configuration line, and MythicLineConfig.

```APIDOC
## GoToSpawnLocationGoal Constructor

### Description
Initializes the GoToSpawnLocationGoal with the entity, configuration line, and MythicLineConfig.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
GoToSpawnLocationGoal goal = new GoToSpawnLocationGoal(entity, "line", mlc);
```

### Response
#### Success Response (Constructor)
N/A

#### Response Example
N/A
```

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

### BukkitEntity Constructor and Core Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/adapters/BukkitEntity

Details on constructing a BukkitEntity and fundamental methods like damage, removal, and metadata handling.

```APIDOC
## BukkitEntity API

### Description
This section covers the core functionalities of the `BukkitEntity` class, including its constructor and essential methods for entity manipulation.

### Constructor
```APIDOC
BukkitEntity(org.bukkit.entity.Entity e)
```
* **Description**: Initializes a new `BukkitEntity` instance with a given Bukkit entity.

### Methods
#### Damage
* **Method**: `damage(float damage)`
* **Description**: Applies a specified amount of damage to the entity.

#### Removal
* **Method**: `remove()`
* **Description**: Removes the entity from the game world.

#### Metadata
* **Method**: `getMetadata(String key)`
* **Returns**: `Optional<Object>`
* **Description**: Retrieves metadata associated with a specific key.

* **Method**: `hasMetadata(String key)`
* **Returns**: `boolean`
* **Description**: Checks if the entity has metadata associated with a specific key.

* **Method**: `setMetadata(String key, Object value)`
* **Description**: Sets a metadata value for the entity under a given key.

* **Method**: `removeMetadata(String key)`
* **Description**: Removes metadata associated with a specific key.

### Request Example
```json
{
  "example": "BukkitEntity myEntity = new BukkitEntity(someBukkitEntity);"
}
```

### Response
#### Success Response (200)
* **Description**: Methods typically return `void` or `boolean` for most operations. Data retrieval methods return specific types or Optional wrappers.

#### Response Example
```json
{
  "example": "// No direct response body for these methods, results are in return values or side effects."
}
```
```

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

### Get AuraRegistry from SkillCaster

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/auras/class-use/AuraRegistry

Retrieves the AuraRegistry associated with a SkillCaster.

```APIDOC
## GET SkillCaster.getAuraRegistry()

### Description
Returns the AuraRegistry instance managed by the SkillCaster.

### Method
GET

### Endpoint
`/skillcaster/auraregistry`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **AuraRegistry** (Object) - The AuraRegistry object.

#### Response Example
```json
{
  "auraRegistry": {
    "auras": [
      {
        "type": "Poison",
        "duration": 10000,
        "amplifier": 1
      }
    ]
  }
}
```
```

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

### ConfigMenu Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/menus/config/ConfigMenu

Provides documentation for the core methods of the ConfigMenu class, including opening menus and building editable menu structures.

```APIDOC
## ConfigMenu Methods

### Description
Provides methods for interacting with and building configuration menus.

### Methods

#### `open(Player player)`

##### Description
Opens the configuration menu for the specified player.

##### Method
```
public void open(org.bukkit.entity.Player player)
```

##### Parameters
* **player** (Player) - The player to open the menu for.

#### `open(Player player, ConfigMenuContext context)`

##### Description
Opens the configuration menu for the specified player with a given context.

##### Method
```
public void open(org.bukkit.entity.Player player, ConfigMenuContext context)
```

##### Parameters
* **player** (Player) - The player to open the menu for.
* **context** (ConfigMenuContext) - The context to use when opening the menu.

##### Overrides
`open` in class `io.lumine.utils.menu.ReloadableMenu<ConfigMenuContext>`

#### `build(EditableMenuBuilder<ConfigMenuContext> builder)`

##### Description
Builds the editable menu structure using the provided builder.

##### Method
```
public io.lumine.utils.menu.EditableMenuBuilder<ConfigMenuContext> build(io.lumine.utils.menu.EditableMenuBuilder<ConfigMenuContext> builder)
```

##### Parameters
* **builder** (EditableMenuBuilder<ConfigMenuContext>) - The builder to use for constructing the menu.

##### Specified by
`build` in class `io.lumine.utils.menu.ReloadableMenu<ConfigMenuContext>`
```

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

### Get BukkitStrider Height

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitStrider

Retrieves the height of the BukkitStrider entity.

```APIDOC
## int getHeight()

### Description
Retrieves the height of the BukkitStrider entity.

### Method
`public int getHeight()`

### Endpoint
N/A (Method)

### Parameters
None

### Request Example
```java
BukkitStrider strider = new BukkitStrider();
int height = strider.getHeight();
```

### Response
#### Success Response (200)
- **int** - The height of the Strider entity.

#### Response Example
```json
{
  "height": 3
}
```
```

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

### TemplateUtil.TemplateItem config() Method and Constructor

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/config/class-use/MythicConfig

Demonstrates how to retrieve the 'config' component from a TemplateItem record and the constructor for TemplateItem that accepts a MythicConfig object.

```java
TemplateUtil.TemplateItem.config();
new TemplateItem(Pack pack, File file, String id, MythicConfig config, String parentId);
```

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

### BukkitBabyZoglin getHeight Method

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitBabyZoglin

Gets the height of the BukkitBabyZoglin entity.

```APIDOC
## getHeight Method

### Description
Gets the height of the BukkitBabyZoglin entity.

### Method
`public int getHeight()`

### Endpoint
N/A (Method within a class)

### Parameters
None

### Request Example
```java
int height = bukkitBabyZoglin.getHeight();
```

### Response
#### Success Response (200)
*   **height** (int) - The height of the entity.

#### Response Example
```json
{
  "height": 1
}
```

```

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

### StaticDouble get() Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/skills/placeholders/parsers/StaticDouble

The StaticDouble class implements several `get()` methods to retrieve the static double value. These methods vary in their parameters, allowing the value to be accessed with or without contextual information like PlaceholderMeta, AbstractEntity, or SkillCaster.

```java
public double get()
public double get(PlaceholderMeta meta)
public double get(AbstractEntity entity)
public double get(PlaceholderMeta meta, AbstractEntity entity)
public double get(SkillCaster caster)
```

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

### MPetCompat Class Overview

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/compatibility/MPetCompat

Provides an overview of the MPetCompat class, including its constructors and methods.

```APIDOC
## Class: MPetCompat

### Description
Handles compatibility with MythicPets in the MythicCraft ecosystem.

### Nested Classes
- **MPetCompat.MiniaturePetType**: Represents the type of miniature pet.

### Constructors
- **MPetCompat()**: Constructor for the MPetCompat class.

### Methods
- **getModel(MythicConfig config)**: Retrieves the MiniaturePetType based on the provided MythicConfig.

### Inherited Methods from java.lang.Object
- `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`
```

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

### BukkitGiant Constructors and Methods

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitGiant

This section details the constructors and key methods of the BukkitGiant class, including instantiation, spawning, and applying entity options.

```APIDOC
## BukkitGiant Class Documentation

### Description
Provides a Bukkit-specific implementation for the MythicGiant entity, handling its instantiation, spawning, and configuration within the Bukkit environment.

### Methods

#### Constructor

*   **BukkitGiant()**
    *   Description: Initializes a new instance of the BukkitGiant class.

#### Core Methods

*   **instantiate(MythicConfig mc)**
    *   Method: `void`
    *   Description: Instantiates the BukkitGiant entity using the provided MythicConfig.
    *   Inherited from: `MythicEntity`

*   **spawn(Location location, SpawnReason reason, Consumer<Entity> prespawnFunc)**
    *   Method: `Entity`
    *   Description: Spawns a BukkitGiant entity at the specified location with the given spawn reason and an optional prespawn function.
    *   Inherited from: `BukkitEntityType`

*   **applyOptions(Entity entity)**
    *   Method: `Entity`
    *   Description: Applies specific Bukkit-related options to an already spawned Bukkit entity.
    *   Inherited from: `BukkitEntityType`

*   **compare(Entity e)**
    *   Method: `boolean`
    *   Description: Compares this BukkitGiant instance with another Bukkit entity.
    *   Inherited from: `BukkitEntityType`

### Inherited Methods

*   **From `BukkitEntityType`**: `getHead`, `getHeadString`, `getMythicEntity`, `spawn`, `spawnBaseEntity`, `spawnEntity`
*   **From `MythicEntity`**: `getHeight`
*   **From `Object`**: `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`
```

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

### Get Bounding Boxes for a Block (Java)

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/core/utils/physics/ComplexAABB.Stair

This static method, `get`, from the `ComplexAABB.Stair` class takes a Bukkit `Block` object as input and returns a collection of `BoundingBox` objects. This is useful for physics calculations and collision detection within the game world.

```java
@NotNull public static Collection<org.bukkit.util.BoundingBox> get(@NotNull org.bukkit.block.Block block)

```

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

### Get MythicEntityType by String

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/api/mobs/entities/MythicEntityType

The `get(String s)` static method is provided to retrieve a MythicEntityType based on a String input. The exact behavior and potential exceptions for this method are not detailed in the provided documentation, but it is expected to parse the input string to find a matching entity type.

```java
public static MythicEntityType get(String s)
```

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

### BukkitTextDisplay Constructor

Source: https://www.mythiccraft.io/javadocs/mythic/io/lumine/mythic/bukkit/entities/BukkitTextDisplay

Initializes a new instance of the BukkitTextDisplay class.

```APIDOC
## BukkitTextDisplay Constructor

### Description
Constructs a new BukkitTextDisplay object.

### Method
`public BukkitTextDisplay()`

### Endpoint
N/A (Constructor)

### Parameters
None

### Request Body
None

### Response
N/A (Constructor)

### Response Example
N/A (Constructor)
```
Tokens:
Raw