Carbon

https://docs.refinedev.org/carbon/javadocs/
Admin
Carbon is a high-performance Spigot fork developed by Refine Development, designed to optimize...
Tokens:207,380
Snippets:2,594
Trust Score:4.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full command configuration example

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

A comprehensive example showing the hierarchical structure of command definitions in plugin.yml.

```yaml
commands:
  flagrate:
    description: Set yourself on fire.
    aliases: [combust_me, combustMe]
    permission: inferno.flagrate
    permission-message: You do not have /<permission>
    usage: Syntax error! Perhaps you meant /<command> PlayerName?
  burningdeaths:
    description: List how many times you have died by fire.
    aliases:
    - burning_deaths
    - burningDeaths
    permission: inferno.burningdeaths
    usage: |
      /<command> [player]
      Example: /<command> - see how many times you have burned to death
      Example: /<command> CaptainIce - see how many times CaptainIce has burned to death
  # The next command has no description, aliases, etc. defined, but is still valid
  # Having an empty declaration is useful for defining the description, permission, and messages from a configuration dynamically
  apocalypse:
```

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

### Example plugin.yml configuration

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

A basic example of a plugin.yml file defining the required name, version, and description fields.

```yaml
name: Inferno
version: 1.4.1
description: This plugin is so 31337. You can set yourself on fire.
```

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

### begin()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/conversations/Conversation

Starts the conversation session.

```APIDOC
## begin()

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

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

### options()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemoryConfiguration

Gets the ConfigurationOptions for this Configuration.

```APIDOC
## options()

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

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

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

### getUsage()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/Command

Retrieves the example usage string for the command.

```APIDOC
### Method
public String getUsage()

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

### Returns
- **String**: One or more example usages.
```

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

### Get Relative Block Example

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Block

Demonstrates how to retrieve a block at a specific offset and set its material type.

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

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

### getStartLevel()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/enchantments/Enchantment

Gets the level that this Enchantment should start at.

```APIDOC
### Method
public abstract int getStartLevel()

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

### Returns
- **int** - Starting level of the Enchantment
```

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

### get(String path)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/ConfigurationSection

Gets the requested Object by path.

```APIDOC
## Object get(String path)

### Description
Gets the requested Object by path. If the Object does not exist but a default value has been specified, this will return the default value. If the Object does not exist and no default value was specified, this will return null.

### Parameters
- **path** (String) - Required - The path to retrieve.

### Returns
- **Object** - The requested object or the default value.
```

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

### getDefaults()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemoryConfiguration

Gets the source Configuration for this configuration.

```APIDOC
## getDefaults()

### Description
Gets the source Configuration for this configuration. If no configuration source was set, but default values were added, then a MemoryConfiguration will be returned.

### Returns
- **Configuration** - Configuration source for default values, or null if none exist.
```

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

### setup(KnockbackType type)

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/features/combat/ICombatProfile

Configures the combat profile based on the provided knockback type.

```APIDOC
### void setup(KnockbackType type)

Sets up the combat profile according to the specified knockback type.

#### Parameters
- **type** (KnockbackType) - The knockback type to apply.
```

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

### Create and Start a Timing Handler

Source: https://docs.refinedev.org/carbon/javadocs/co/aikar/timings/Timings

Creates and starts a Timing object, suitable for use with Java 7 try-with-resources blocks.

```java
try (Timing ignored = Timings.ofStart(plugin, someName)) { // timed section }
```

```java
try (Timing ignored = Timings.ofStart(plugin, someName, groupHandler)) { // timed section }
```

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

### get(String path)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemorySection

Gets the requested Object by path, returning a default value if specified or null if not found.

```APIDOC
## get(String path)

### Description
Gets the requested Object by path. If the Object does not exist but a default value has been specified, this will return the default value.

### Parameters
- **path** (String) - Required - Path of the Object to get.

### Returns
- **Object** - Requested Object.
```

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

### getExperience() / setExperience(int exp)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/entity/ExpBottleEvent

Methods to get or set the amount of experience to be created.

```APIDOC
### Methods
public int getExperience()
public void setExperience(int exp)

### Description
Retrieves or sets the total amount of experience to be created, which is divided into orbs.

### Parameters
- **exp** (int) - The total amount of experience to be created.
```

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

### setUsage(String usage)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/Command

Sets the example usage string for the command.

```APIDOC
### Method
public Command setUsage(String usage)

### Description
Sets the example usage of this command.

### Parameters
- **usage** (String) - Required - New example usage.

### Returns
- **Command**: This command object, for chaining.
```

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

### Timing ofStart(Plugin plugin, String name)

Source: https://docs.refinedev.org/carbon/javadocs/co/aikar/timings/Timings

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

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

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

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

### Returns
- **Timing** - Handler
```

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

### startsWithIgnoreCase

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/util/StringUtil

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

```APIDOC
## startsWithIgnoreCase

### Description
Checks if the provided string starts with the specified prefix, ignoring case. This method uses a region to check equality without requiring string copying.

### Signature
`public static boolean startsWithIgnoreCase(String string, String prefix)`

### Parameters
- **string** (String) - The string to check.
- **prefix** (String) - The prefix to compare against.

### Returns
- **boolean** - True if the string starts with the prefix, ignoring case.

### Throws
- **NullPointerException** - If prefix is null.
- **IllegalArgumentException** - If string is null.
```

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

### getInventory

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/HumanEntity

Get the player's inventory.

```APIDOC
## PlayerInventory getInventory()

### Description
Get the player's inventory, which also contains the armor slots.

### Returns
- **PlayerInventory** - The inventory of the player.
```

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

### startTiming()

Source: https://docs.refinedev.org/carbon/javadocs/co/aikar/timings/FullServerTickHandler

Starts timing the execution until stopTiming() is called.

```APIDOC
## Timing startTiming()

### Description
Starts timing the execution until stopTiming() is called.

### Returns
- **Timing** - The current timing instance.
```

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

### getLoad()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

Retrieves the server startup phase when the plugin should be loaded.

```APIDOC
## PluginLoadOrder getLoad()

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

### Returns
- **PluginLoadOrder** - The phase when the plugin should be loaded.
```

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

### registerHelpTopicFactory(Class<?> commandClass, HelpTopicFactory<?> factory)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpMap

Registers a factory for creating custom help topics.

```APIDOC
## void registerHelpTopicFactory(Class<?> commandClass, HelpTopicFactory<?> factory)

### Description
Associates a HelpTopicFactory object with a given command base class.

### Parameters
- **commandClass** (Class<?>) - The class for which the custom HelpTopicFactory applies. Must derive from either Command or CommandExecutor.
- **factory** (HelpTopicFactory<?>) - The HelpTopicFactory implementation to associate with the commandClass.

### Throws
- **IllegalArgumentException** - Thrown if commandClass does not derive from a legal base class.
```

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

### getEquipment()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the inventory with the equipment worn by the living entity.

```APIDOC
### EntityEquipment getEquipment()

Gets the inventory with the equipment worn by the living entity.

**Returns:**
- `EntityEquipment` - the living entity's inventory
```

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

### ServerBuildInfo.buildInfo()

Source: https://docs.refinedev.org/carbon/javadocs/io/papermc/paper/ServerBuildInfo

Retrieves the singleton instance of the ServerBuildInfo interface.

```APIDOC
## static ServerBuildInfo buildInfo()

### Description
Gets the current ServerBuildInfo instance.

### Returns
- **ServerBuildInfo** - The server build information object.
```

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

### getSize

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Team

Gets the size of the team.

```APIDOC
## int getSize()

### Description
Gets the size of the team.

### Returns
- **int** - number of entries on the team

### Throws
- **IllegalStateException** - if this team has been unregistered
```

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

### getTeams

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets all teams on this Scoreboard.

```APIDOC
### getTeams()

**Description**: Gets all teams on this Scoreboard.

**Returns**:
- (Set<Team>) An immutable set of Teams.
```

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

### getFullText(CommandSender forWho)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpTopic

Returns the full description of the help topic, paginated for the user.

```APIDOC
### Method
String getFullText(CommandSender forWho)

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

### Returns
- **String** - The full, paginated topic description.
```

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

### getResult()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/inventory/ShapelessRecipe

Get the result of this recipe.

```APIDOC
### getResult()

**Signature:** public ItemStack getResult()

**Returns:**
- ItemStack - The result stack.
```

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

### Define plugin load order in plugin.yml

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

Sets the server startup phase for loading the plugin.

```yaml
load: STARTUP
```

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

### beginConversation(Conversation conversation)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/conversations/Conversable

Starts a new conversation with the provided object.

```APIDOC
## boolean beginConversation(Conversation conversation)

### Description
Enters into a dialog with a Conversation object.

### Parameters
- **conversation** (Conversation) - The conversation to begin.

### Returns
- **boolean** - True if the conversation should proceed, false if it has been enqueued.
```

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

### getServer()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/Plugin

Returns the Server instance running the plugin.

```APIDOC
## Server getServer()

### Description
Returns the Server instance currently running this plugin.

### Returns
- **Server** - Server running this plugin
```

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

### getSkullType()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Skull

Gets the type of skull.

```APIDOC
## SkullType getSkullType()

### Description
Gets the type of skull.

### Returns
- **SkullType** - the type of skull
```

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

### allow()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/player/AsyncPlayerPreLoginEvent

Allows the player to log in.

```APIDOC
### allow

**Signature:** `public void allow()`

Allows the player to log in.
```

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

### getScoreboard

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Team

Gets the Scoreboard to which this team is attached.

```APIDOC
## Scoreboard getScoreboard()

### Description
Gets the Scoreboard to which this team is attached.

### Returns
- **Scoreboard** - Owning scoreboard, or null if this team has been unregistered
```

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

### getEntries

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Team

Gets the Set of entries on the team.

```APIDOC
## Set<String> getEntries()

### Description
Gets the Set of entries on the team.

### Returns
- **Set<String>** - entries on the team

### Throws
- **IllegalStateException** - if this entries has been unregistered
```

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

### getVersion() / setVersion(String version)

Source: https://docs.refinedev.org/carbon/javadocs/com/destroystokyo/paper/event/server/PaperServerListPingEvent

Gets or sets the version string that will be sent as the server version to the client.

```APIDOC
## getVersion()

### Description
Returns the version that will be sent as server version on the client.

## setVersion(String version)

### Description
Sets the version that will be sent as server version to the client.

### Parameters
- **version** (String) - Required - The server version
```

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

### getEntries

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets all entries tracked by this Scoreboard.

```APIDOC
### getEntries()

**Description**: Gets all entries tracked by this Scoreboard.

**Returns**:
- (Set<String>) Immutable set of all tracked entries.
```

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

### getFullText(CommandSender sender)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/IndexHelpTopic

Returns the full description of this help topic, formatted for the user's client.

```APIDOC
## Method: getFullText

### Description
Retrieves the full, paginated description of the help topic.

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

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

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

### Define plugin name in plugin.yml

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

Example of the name entry within a plugin.yml configuration file.

```yaml
name: MyPlugin
```

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

### IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/IndexHelpTopic

Constructs a new IndexHelpTopic with the specified name, short description, permission, and collection of topics.

```APIDOC
## Constructor: IndexHelpTopic

### Description
Creates a new index help topic instance.

### Parameters
- **name** (String) - The name of the topic.
- **shortText** (String) - The short description of the topic.
- **permission** (String) - The permission required to view this topic.
- **topics** (Collection<HelpTopic>) - The collection of help topics to include in this index.
```

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

### getPlayers

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets all players tracked by this Scoreboard.

```APIDOC
### getPlayers()

**Description**: Gets all players tracked by this Scoreboard. Note: This method is deprecated as scoreboards can contain entries that aren't players.

**Returns**:
- (Set<OfflinePlayer>) Immutable set of all tracked players.
```

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

### getTeam

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets a Team by name on this Scoreboard.

```APIDOC
### getTeam(String teamName)

**Description**: Gets a Team by name on this Scoreboard.

**Parameters**:
- **teamName** (String) - Team name.

**Returns**:
- (Team) The matching Team or null if no matches.

**Throws**:
- IllegalArgumentException - if teamName is null.
```

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

### Configuration Methods

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/TravelAgent

Methods to configure search and creation radii, and portal creation behavior.

```APIDOC
## Configuration Methods

### setSearchRadius(int radius)
Sets the block radius to search for available portals.

### getSearchRadius()
Returns the current search radius.

### setCreationRadius(int radius)
Sets the maximum radius from the location to create a portal.

### getCreationRadius()
Returns the current creation radius.

### setCanCreatePortal(boolean create)
Sets whether the agent should attempt to create a destination portal.

### getCanCreatePortal()
Returns whether the agent is configured to create destination portals.
```

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

### getFacing()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/material/Banner

Gets the direction this block is facing.

```APIDOC
## BlockFace getFacing()

### Description
Gets the direction this block is facing.

### Returns
- **BlockFace** - The direction the block is facing.
```

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

### getHelpTopics()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpMap

Retrieves all registered help topics.

```APIDOC
## Collection<HelpTopic> getHelpTopics()

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

### Returns
- **Collection<HelpTopic>** - All the registered help topics.
```

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

### registerAll(String fallbackPrefix, List<Command> commands)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/CommandMap

Registers a list of commands belonging to a plugin, using a fallback prefix to ensure uniqueness.

```APIDOC
## registerAll(String fallbackPrefix, List<Command> commands)

### Description
Registers all the commands belonging to a certain plugin. The fallbackPrefix is prepended to each command to ensure uniqueness.

### Parameters
- **fallbackPrefix** (String) - A prefix which is prepended to each command with a ':' one or more times.
- **commands** (List<Command>) - A list of commands to register.
```

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

### getHolder

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/inventory/PlayerInventory

Gets the entity that owns this inventory.

```APIDOC
## HumanEntity getHolder()

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

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

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

### getPlayerProfile

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Gets the player's profile.

```APIDOC
## PlayerProfile getPlayerProfile()

### Description
Gets a copy of this players profile.

### Returns
- **PlayerProfile** - The players profile object.
```

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

### getTargetEntity

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets information about the entity being targeted.

```APIDOC
## Entity getTargetEntity(int maxDistance, boolean ignoreBlocks)

### Description
Gets information about the entity being targeted.

### Parameters
- **maxDistance** (int) - Required - The maximum distance to scan
- **ignoreBlocks** (boolean) - Required - True to scan through blocks

### Returns
- (Entity) - The entity being targeted, or null if no entity is targeted
```

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

### Initialize FixedSetPrompt

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/conversations/FixedSetPrompt

Create a new instance of FixedSetPrompt by passing the allowed string options to the constructor.

```java
foo = new FixedSetPrompt("bar", "cheese", "panda");
```

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

### ServerBuildInfo.asString(StringRepresentation representation)

Source: https://docs.refinedev.org/carbon/javadocs/io/papermc/paper/ServerBuildInfo

Generates a string representation of the server build information based on the provided format.

```APIDOC
## String asString(ServerBuildInfo.StringRepresentation representation)

### Description
Creates a string representation of the server build information.

### Parameters
- **representation** (ServerBuildInfo.StringRepresentation) - Required - The type of representation to use.

### Returns
- **String** - The formatted string representation.
```

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

### getName()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/enchantments/Enchantment

Gets the unique name of this enchantment.

```APIDOC
### Method
public abstract String getName()

### Description
Gets the unique name of this enchantment.

### Returns
- **String** - Unique name
```

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

### IPatchService.get()

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/patches/IPatchService

Retrieves the singleton instance of the IPatchService.

```APIDOC
### static IPatchService get()

Retrieves the singleton instance of the IPatchService.
```

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

### configuration()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/FileConfigurationOptions

Retrieves the FileConfiguration instance associated with these options.

```APIDOC
## FileConfiguration configuration()

### Description
Returns the FileConfiguration that this object is responsible for.

### Returns
- **FileConfiguration** - The associated configuration object.
```

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

### getDefaultGameMode

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets the default game mode.

```APIDOC
## public static GameMode getDefaultGameMode()

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

### Returns
- **GameMode** - the default game mode
```

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

### getOperators

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets a set of player operators.

```APIDOC
## public static Set<OfflinePlayer> getOperators()

### Description
Gets a set containing all player operators.

### Returns
- **Set<OfflinePlayer>** - a set containing player operators
```

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

### SpawnEgg()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/material/SpawnEgg

Constructs a new SpawnEgg object.

```APIDOC
## SpawnEgg()

### Description
Constructs a new SpawnEgg object.
```

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

### Block Key Packing and Unpacking

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Block

Shows how to pack block coordinates into a long value and unpack them back into integers.

```java
long value = ((long)x & 0x7FFFFFF) | (((long)z & 0x7FFFFFF) << 27) | ((long)y << 54);
int x = (int) ((packed << 37) >> 37);
int y = (int) (packed >>> 54);
int z = (int) ((packed << 10) >> 37);
```

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

### getBannedPlayers

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets a set of banned players.

```APIDOC
## public static Set<OfflinePlayer> getBannedPlayers()

### Description
Gets a set containing all banned players.

### Returns
- **Set<OfflinePlayer>** - a set containing banned players
```

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

### getSpawnRadius

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets the spawn protection radius.

```APIDOC
## public static int getSpawnRadius()

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

### Returns
- **int** - spawn radius, or 0 if none
```

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

### getLoadBefore()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

Retrieves the list of plugins that should load after this plugin.

```APIDOC
## List<String> getLoadBefore()

### Description
Gets the list of plugins that should consider this plugin a soft-dependency, ensuring this plugin loads before them.

### Returns
- **List<String>** - An immutable list of plugins that should consider this plugin a soft-dependency.
```

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

### setFlying(boolean value)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Makes this player start or stop flying.

```APIDOC
## void setFlying(boolean value)

### Description
Makes this player start or stop flying.

### Parameters
- **value** (boolean) - Required - True to fly.
```

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

### getNewExp() / setNewExp(int exp)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/entity/PlayerDeathEvent

Gets or sets the amount of experience points the player should have upon respawning.

```APIDOC
### int getNewExp()
Returns the new EXP of the respawned player.

### void setNewExp(int exp)
Sets the new EXP of the respawned player.
```

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

### getTabCompleter()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/PluginCommand

Gets the TabCompleter associated with this command.

```APIDOC
### Method
TabCompleter getTabCompleter()

### Description
Gets the TabCompleter associated with this command.
```

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

### load(String file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/FileConfiguration

Loads the configuration from a specified file path, clearing existing values and replacing them with the file contents.

```APIDOC
## void load(String file)

### Description
Loads this FileConfiguration from the specified location. All existing values are removed, and new values are loaded from the given file.

### Parameters
- **file** (String) - Required - The path to the file to load from.

### Throws
- **FileNotFoundException** - Thrown when the file cannot be opened.
- **IOException** - Thrown when the file cannot be read.
- **InvalidConfigurationException** - Thrown when the file is not a valid configuration.
- **IllegalArgumentException** - Thrown when the file path is null.
```

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

### getBiome

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Block

Gets or sets the biome of the block.

```APIDOC
## Biome getBiome()

### Description
Returns the biome that this block resides in.

## void setBiome(Biome bio)

### Description
Sets the biome that this block resides in.

### Parameters
- **bio** (Biome) - Required - New Biome type for this block.
```

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

### newAutoMap

Source: https://docs.refinedev.org/carbon/javadocs/co/aikar/util/LoadingMap

Creates a LoadingMap with an auto-instantiating loader using reflection to construct values.

```APIDOC
## newAutoMap<K, V>

### Description
Creates a LoadingMap with an auto instantiating loader. It will auto construct the class of the Value when not found using reflection.

### Signature
`public static <K, V> Map<K,V> newAutoMap(Map<K,V> backingMap, Class<? extends V> valueClass)`

### Parameters
- **backingMap** (Map<K,V>) - The actual map being used.
- **valueClass** (Class<? extends V>) - The class used for the V generic.
```

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

### PlayerExpChangeEvent(Player player, int expAmount)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/player/PlayerExpChangeEvent

Constructs a new PlayerExpChangeEvent instance.

```APIDOC
### Constructor
`PlayerExpChangeEvent(Player player, int expAmount)`

Creates a new event instance for a player experiencing an experience change.
```

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

### getRotation()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Skull

Gets the rotation of the skull in the world.

```APIDOC
## BlockFace getRotation()

### Description
Gets the rotation of the skull in the world.

### Returns
- **BlockFace** - the rotation of the skull
```

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

### getEntryTeam

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets an entry's Team on this Scoreboard.

```APIDOC
### getEntryTeam(String entry)

**Description**: Gets an entry's Team on this Scoreboard.

**Parameters**:
- **entry** (String) - The entry to search for.

**Returns**:
- (Team) The entry's Team or null if the entry is not on a team.

**Throws**:
- IllegalArgumentException - if entry is null.
```

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

### openInventory

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/HumanEntity

Opens an inventory window for the player.

```APIDOC
## InventoryView openInventory(Inventory inventory)

### Description
Opens an inventory window with the specified inventory on the top and the player's inventory on the bottom.

### Parameters
- **inventory** (Inventory) - The inventory to open.

### Returns
- **InventoryView** - The newly opened inventory view.
```

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

### getPlayerTeam

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/scoreboard/Scoreboard

Gets a player's Team on this Scoreboard.

```APIDOC
### getPlayerTeam(OfflinePlayer player)

**Description**: Gets a player's Team on this Scoreboard. Note: This method is deprecated as scoreboards can contain entries that aren't players.

**Parameters**:
- **player** (OfflinePlayer) - The player to search for.

**Returns**:
- (Team) The player's Team or null if the player is not on a team.

**Throws**:
- IllegalArgumentException - if player is null.
```

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

### getServer()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/CommandSender

Retrieves the server instance associated with the command sender.

```APIDOC
## Server getServer()

### Description
Returns the server instance that this command is running on.

### Returns
- **Server** - The server instance.
```

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

### getType()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/potion/PotionEffectTypeWrapper

Get the potion type bound to this wrapper.

```APIDOC
### Method
`PotionEffectType getType()`

### Description
Get the potion type bound to this wrapper.

### Returns
- **PotionEffectType** - The potion effect type.
```

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

### load(File file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/FileConfiguration

Loads the configuration from the specified file.

```APIDOC
## load(File file)

### Description
Loads this FileConfiguration from the specified location.

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

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

### getMaterial()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/material/TexturedMaterial

Gets the current Material this block is made of.

```APIDOC
## Material getMaterial()

### Description
Gets the current Material this block is made of.

### Returns
- **Material** - The material of this block.
```

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

### MinecraftFont()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/map/MinecraftFont

Constructor to initialize a new instance of the MinecraftFont.

```APIDOC
## MinecraftFont()

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

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

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

### PlayerInitialSpawnEvent(Player player, Location spawnLocation)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/player/PlayerInitialSpawnEvent

Constructs a new PlayerInitialSpawnEvent with the specified player and spawn location.

```APIDOC
## Constructor: PlayerInitialSpawnEvent(Player player, Location spawnLocation)

### Description
Initializes a new instance of the event for a specific player at a given location.

### Parameters
- **player** (Player) - The player spawning.
- **spawnLocation** (Location) - The initial spawn location.
```

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

### getRepairCost()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/inventory/meta/Repairable

Gets the current repair penalty of the item.

```APIDOC
## int getRepairCost()

### Description
Gets the repair penalty.

### Returns
- **int**: the repair penalty
```

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

### getInventory()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/event/inventory/PrepareItemCraftEvent

Gets the primary CraftingInventory involved in this transaction.

```APIDOC
### Method
`public CraftingInventory getInventory()`

### Description
Gets the primary Inventory involved in this transaction.

### Returns
- **CraftingInventory** - The crafting inventory on which the recipe was formed.
```

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

### onEnable() / onDisable() / onLoad()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/Plugin

Lifecycle methods for the plugin.

```APIDOC
## void onEnable()
Called when this plugin is enabled.

## void onDisable()
Called when this plugin is disabled.

## void onLoad()
Called after a plugin is loaded but before it has been enabled.
```

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

### getSpectatorTarget

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Gets the entity the player is currently spectating.

```APIDOC
## Entity getSpectatorTarget()

### Description
Gets the entity which is followed by the camera when in GameMode.SPECTATOR.

### Returns
- **Entity** - the followed entity, or null if not in spectator mode or not following a specific entity.
```

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

### getHealthScale

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Gets the current health scale value.

```APIDOC
## double getHealthScale()

### Description
Gets the number that health is scaled to for the client.

### Returns
- **double** - the number that health would be scaled to for the client if HealthScaling is set to true.
```

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

### BoundingBox.of

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/util/BoundingBox

Static factory methods to create a new BoundingBox instance from various inputs like Vectors, Locations, or Blocks.

```APIDOC
## BoundingBox.of

### Description
Creates a new BoundingBox instance based on provided geometric inputs.

### Signatures
- `static BoundingBox of(Vector corner1, Vector corner2)`
- `static BoundingBox of(Location corner1, Location corner2)`
- `static BoundingBox of(Block corner1, Block corner2)`
- `static BoundingBox of(Block block)`
- `static BoundingBox of(Vector center, double x, double y, double z)`
- `static BoundingBox of(Location center, double x, double y, double z)`
```

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

### getLivingEntities

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/World

Get a list of all living entities in this World.

```APIDOC
## getLivingEntities()

### Description
Get a list of all living entities in this World.

### Returns
- **List<LivingEntity>** - A List of all LivingEntities currently residing in this world
```

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

### helpTopicComparatorInstance()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpTopicComparator

Retrieves the singleton instance of the HelpTopicComparator.

```APIDOC
### public static HelpTopicComparator helpTopicComparatorInstance()

Returns the singleton instance of the HelpTopicComparator used for sorting help topics.
```

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

### getLookVector

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the vector that the living entity is looking at.

```APIDOC
## Vector getLookVector(double magnitude)

### Description
Gets the vector that the living entity is looking at.

### Parameters
- **magnitude** (double) - Required - The length of the vector

### Returns
- (Vector) - The vector that the living entity is looking at
```

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

### StringUtil Methods

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/utils/text/StringUtil

A collection of static utility methods for handling strings, arrays, and combat module formatting.

```APIDOC
## static boolean isEmpty(String[] array)
Checks if a string array is empty.

## static String formatComment(ICombatModule combatModule, boolean isValue)
Formats a comment based on a combat module and a boolean flag.

## static String formatComment(ICombatValue<?> combatValue)
Formats a comment based on a combat value.

## static String formatComment(String[] comment)
Formats an array of strings into a single comment string.

## static int getWidth(String text)
Calculates the width of a given string.

## static String[] minimizeWidth(String[] description)
Minimizes the width of an array of strings.
```

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

### getTargetBlock

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the block that the living entity has targeted.

```APIDOC
## Block getTargetBlock(Set<Material> transparent, int maxDistance)

### Description
Gets the block that the living entity has targeted. This method considers all blocks as 1x1x1 in size.

### Parameters
- **transparent** (Set<Material>) - Required - Set containing all transparent block Materials (set to null for only air)
- **maxDistance** (int) - Required - The maximum distance to scan (may be limited by server by at least 100 blocks, no less)

### Returns
- (Block) - The block that the living entity has targeted
```

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

### createTopic(TCommand command)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpTopicFactory

Constructs a custom HelpTopic for a given command that derives from a custom command base class.

```APIDOC
## createTopic(TCommand command)

### Description
This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it. It is used by the help system to generate specialized help documentation for plugin commands.

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

### Returns
- **HelpTopic** - A new custom help topic or null to intentionally not create a topic.
```

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

### loadConfiguration(File file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/YamlConfiguration

Static factory method to create a YamlConfiguration from a file.

```APIDOC
## public static YamlConfiguration loadConfiguration(File file)

### Description
Creates a new YamlConfiguration and loads data from the specified file.

### Parameters
- **file** (File) - Required - The file to load from.

### Returns
- **YamlConfiguration** - The loaded configuration instance.
```

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

### getId()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Skeleton.SkeletonType.html

Gets the ID of this skeleton type. (Deprecated)

```APIDOC
### Method
public int getId()

### Description
Gets the ID of this skeleton type. This method is deprecated and uses magic values.

### Returns
- **int** - Skeleton type ID
```

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

### FlowerPot()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/material/FlowerPot

Default constructor for a flower pot.

```APIDOC
## FlowerPot()

### Description
Default constructor for a flower pot.
```

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

### String getName()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemorySection

Gets the name of this individual ConfigurationSection.

```APIDOC
## String getName()

### Description
Gets the name of this individual ConfigurationSection, in the path. This will always be the final part of getCurrentPath(), unless the section is orphaned.

### Returns
- **String** - Name of this section.
```

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

### indent()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/YamlConfigurationOptions

Gets the current indentation level in spaces.

```APIDOC
### int indent()

Gets how much spaces should be used to indent each line.
```

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

### Clickable Constructors

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/utils/text/Clickable

Initializes a new Clickable instance with optional message, hover text, and click action parameters.

```APIDOC
### Constructors

- **Clickable()**
- **Clickable(String msg)**
- **Clickable(String msg, String hoverMsg, String clickString)**
- **Clickable(String msg, String hoverMsg, String clickString, boolean suggest)**
```

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

### restart()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Server.Spigot.html

Restarts the server.

```APIDOC
## void restart()

### Description
Restart the server. If the server administrator has not configured restarting, the server will stop.
```

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

### getBanList

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets a ban list for a specific type.

```APIDOC
## public static BanList getBanList(BanList.Type type)

### Description
Gets a ban list for the supplied type.

### Parameters
- **type** (BanList.Type) - Required - the type of list to fetch

### Returns
- **BanList** - a ban list of the specified type
```

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

### instance()

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/features/chunk/IChunkAPI

Retrieves the singleton instance of the IChunkAPI.

```APIDOC
### static IChunkAPI instance()

Returns the global instance of the IChunkAPI.
```

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

### getIPBans

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets a set of banned IP addresses.

```APIDOC
## public static Set<String> getIPBans()

### Description
Gets a set containing all current IPs that are banned.

### Returns
- **Set<String>** - a set containing banned IP addresses
```

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

### getOfflinePlayer (UUID)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Gets an offline player by UUID.

```APIDOC
## public static OfflinePlayer getOfflinePlayer(UUID id)

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

### Parameters
- **id** (UUID) - Required - the UUID of the player to retrieve

### Returns
- **OfflinePlayer** - an offline player
```

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

### getHelpTopic(String topicName)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/help/HelpMap

Retrieves a specific help topic by its name.

```APIDOC
## HelpTopic getHelpTopic(String topicName)

### Description
Returns a help topic for a given topic name.

### Parameters
- **topicName** (String) - The help topic name to look up.

### Returns
- **HelpTopic** - A HelpTopic object matching the topic name or null if none can be found.
```

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

### createInventory

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Creates an empty inventory with various configuration options such as type, size, and title.

```APIDOC
## public static Inventory createInventory(InventoryHolder owner, InventoryType type, String title)

### Description
Creates an empty inventory with the specified type and title.

### Parameters
- **owner** (InventoryHolder) - Optional - The holder of the inventory.
- **type** (InventoryType) - Required - The type of inventory to create.
- **title** (String) - Optional - The title of the inventory.

### Returns
- **Inventory** - The new inventory.
```

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

### getOwner()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/block/Skull

Gets the owner of the skull, if one exists.

```APIDOC
## String getOwner()

### Description
Gets the owner of the skull, if one exists.

### Returns
- **String** - the owner of the skull or null if the skull does not have an owner
```

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

### loadConfiguration(File file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/YamlConfiguration

Creates a new YamlConfiguration instance and loads the configuration data from the specified file.

```APIDOC
### static YamlConfiguration loadConfiguration(File file)

Creates a new `YamlConfiguration` instance, loading the configuration data from the provided `File` object.
```

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

### getDescription()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/Command

Retrieves the brief description associated with the command.

```APIDOC
### Method
public String getDescription()

### Description
Gets a brief description of this command.

### Returns
- **String**: Description of this command.
```

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

### getFoodLevel

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Gets the player's current food level.

```APIDOC
## int getFoodLevel()

### Description
Gets the player's current food level.

### Returns
- **int** - Food level.
```

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

### getDescription()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginDescriptionFile

Retrieves the human-friendly description of the plugin.

```APIDOC
## String getDescription()

### Description
Gives a human-friendly description of the functionality the plugin provides.

### Returns
- **String** - Description of this plugin, or null if not specified.
```

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

### Vine()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/material/Vine

Constructs a new Vine object.

```APIDOC
## Vine()

### Description
Constructs a new Vine object.
```

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

### getGameRuleValue

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/World

Gets the current state of a specified game rule.

```APIDOC
### String getGameRuleValue(String rule)

Returns the current value of the specified game rule as a String. Returns null if the rule is null.
```

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

### getArrowsStuck

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the number of arrows currently stuck in the entity.

```APIDOC
## int getArrowsStuck()

### Description
Get the number of arrows stuck in this entity.

### Returns
- **int** - Number of arrows stuck
```

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

### load(File file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/file/FileConfiguration

Loads the configuration from the specified file, clearing existing values.

```APIDOC
## void load(File file)

### Description
Loads this FileConfiguration from the specified location. All existing values are removed and replaced by the contents of the file.

### Parameters
- **file** (File) - Required - The file to load from.

### Throws
- **FileNotFoundException** - Thrown when the file cannot be opened.
- **IOException** - Thrown when the file cannot be read.
- **InvalidConfigurationException** - Thrown when the file content is invalid.
```

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

### Server Management Methods

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Bukkit

Methods for managing server state, including shutdown, player limits, and configuration.

```APIDOC
## static void shutdown()

### Description
Shutdowns the server, stopping everything.

## static void setMaxPlayers(int i)

### Description
Set the maximum amount of players which can login to this server.

### Parameters
- **i** (int) - The amount of players this server allows.

## static int getMaxPlayers()

### Description
Get the maximum amount of players which can login to this server.

### Returns
- (int) The amount of players this server allows.
```

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

### ProfileProperty Constructors

Source: https://docs.refinedev.org/carbon/javadocs/com/destroystokyo/paper/profile/ProfileProperty

Constructors for creating a new ProfileProperty instance.

```APIDOC
## ProfileProperty(String name, String value)
## ProfileProperty(String name, String value, String signature)

### Description
Creates a new property instance for a player profile.

### Parameters
- **name** (String) - The name of the property (e.g., "textures").
- **value** (String) - The value of the property, typically base64 encoded.
- **signature** (String) - Optional cryptographic signature from Mojang.
```

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

### getKiller()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the player identified as the killer of the living entity.

```APIDOC
### Player getKiller()

Gets the player identified as the killer of the living entity. May be null.

**Returns:**
- `Player` - killer player, or null if none found
```

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

### getTargetBlockFace

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/LivingEntity

Gets the blockface of the block that the living entity has targeted.

```APIDOC
## BlockFace getTargetBlockFace(int maxDistance, FluidCollisionMode fluidMode)

### Description
Gets the blockface of that block that the living entity has targeted.

### Parameters
- **maxDistance** (int) - Required - The maximum distance to scan
- **fluidMode** (FluidCollisionMode) - Required - Whether to check fluids or not

### Returns
- (BlockFace) - The blockface of the block that the living entity has targeted, or null if no block is targeted
```

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

### ICombatModule Methods

Source: https://docs.refinedev.org/carbon/javadocs/xyz/refinedev/spigot/features/combat/module/ICombatModule

Methods available for interacting with combat modules.

```APIDOC
## String getName()

### Description
Get the name of the module.

### Returns
- **String** - The name of the module.

---

## String getPathPrefix()

### Description
Get the path prefix of the module.

### Returns
- **String** - The path prefix.

---

## String getComment()

### Description
Get the comment of the module.

### Returns
- **String** - The comment.

---

## boolean isEnabled()

### Description
Check whether the module is enabled or not.

### Returns
- **boolean** - true if enabled, false otherwise.

---

## List<ICombatValue<?>> getValues()

### Description
Get the list of combat values in the module.

### Returns
- **List<ICombatValue<?>>** - The list of combat values.

---

## ICombatValue<?> getValue(String name)

### Description
Get a specific combat value by name or ID.

### Parameters
- **name** (String) - The name or ID of the value.

### Returns
- **ICombatValue<?>** - The combat value, or null if not found.

---

## void loadValues()

### Description
Loads the values from the module fields annotated with @Modifier.

---

## void load(YamlFile yamlFile, String path)

### Description
Loads the module configuration from the given YamlFile.

### Parameters
- **yamlFile** (YamlFile) - The YamlFile to load from.
- **path** (String) - The base path in the yaml file.

---

## void save(YamlFile yamlFile, String path)

### Description
Saves the module configuration to the given YamlFile.

### Parameters
- **yamlFile** (YamlFile) - The YamlFile to save to.
- **path** (String) - The base path in the yaml file.
```

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

### getId()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Villager.Profession.html

Gets the ID of this profession. Note: This method is deprecated.

```APIDOC
### int getId()

Gets the ID of this profession. 

*Deprecated: Magic value*
```

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

### onTabComplete(CommandSender, Command, String, String[])

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/TabCompleter

Requests a list of possible completions for a command argument.

```APIDOC
## List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args)

### Description
Requests a list of possible completions for a command argument.

### Parameters
- **sender** (CommandSender) - Source of the command
- **command** (Command) - Command which was executed
- **alias** (String) - The alias used
- **args** (String[]) - The arguments passed to the command, including final partial argument to be completed and command label

### Returns
- **List<String>** - A List of possible completions for the final argument, or null to default to the command executor
```

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

### getGameMode

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/HumanEntity

Gets the human's current game mode.

```APIDOC
## GameMode getGameMode()

### Description
Gets this human's current GameMode.

### Returns
- **GameMode** - Current game mode.
```

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

### initialize(MapView map)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/map/MapRenderer

Initializes the renderer for a specific map view.

```APIDOC
## void initialize(MapView map)

### Description
Initialize this MapRenderer for the given map.

### Parameters
- **map** (MapView) - The MapView being initialized.
```

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

### getHighestBlockAt

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/World

Gets the highest non-empty block at the given coordinates.

```APIDOC
## Block getHighestBlockAt(int x, int z)

### Description
Gets the highest non-empty block at the given coordinates.

### Parameters
- **x** (int) - Required - The x coordinate.
- **z** (int) - Required - The z coordinate.
```

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

### getString(String path)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemorySection

Gets the requested String by path.

```APIDOC
## getString(String path)

### Description
Gets the requested String by path. If the String does not exist but a default value has been specified, this will return the default value.

### Parameters
- **path** (String) - Required - Path of the String to get.

### Returns
- **String** - Requested String.
```

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

### performCommand(String command)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/entity/Player

Makes the player perform the given command.

```APIDOC
### performCommand(String command)

Makes the player perform the given command.

#### Parameters
- **command** (String) - Command to perform.

#### Returns
- **boolean** - true if the command was successful, otherwise false.
```

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

### takeSnapshot()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/Chunk

Creates a lightweight snapshot of the current chunk properties for storage and later restoration.

```APIDOC
### takeSnapshot()

#### Description
Take a light-weight snapshot of current properties of the given chunk. The snapshot is not a deep-clone and can only be used once.

#### Returns
- **ICarbonChunkSnapshot<?>** - A snapshot of the chunk.
```

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

### Configuration getRoot()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemorySection

Gets the root Configuration that contains this ConfigurationSection.

```APIDOC
## Configuration getRoot()

### Description
Gets the root Configuration that contains this ConfigurationSection. For any Configuration themselves, this will return its own object.

### Returns
- **Configuration** - Root configuration containing this section.
```

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

### String getCurrentPath()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/configuration/MemorySection

Gets the path of this ConfigurationSection from its root Configuration.

```APIDOC
## String getCurrentPath()

### Description
Gets the path of this ConfigurationSection from its root Configuration. For any Configuration themselves, this will return an empty string.

### Returns
- **String** - Path of this section relative to its root.
```

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

### onTabComplete(CommandSender, Command, String, String[], Location)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/command/TabCompleter

Requests a list of possible completions for a command argument, including the location context.

```APIDOC
## default List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args, Location location)

### Description
Requests a list of possible completions for a command argument, providing additional location context for the completion request.
```

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

### getPluginDescription(File file)

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/plugin/PluginLoader

Loads a PluginDescriptionFile from the specified file.

```APIDOC
## PluginDescriptionFile getPluginDescription(File file)

### Description
Loads a PluginDescriptionFile from the specified file.

### Parameters
- **file** (File) - The file to attempt to load from.

### Returns
- **PluginDescriptionFile** - A new PluginDescriptionFile loaded from the plugin.yml in the specified file.

### Throws
- **InvalidDescriptionException** - If the plugin description file could not be created.
```

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

### getItemTarget()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/enchantments/Enchantment

Gets the type of ItemStack that may fit this Enchantment.

```APIDOC
### Method
public abstract EnchantmentTarget getItemTarget()

### Description
Gets the type of ItemStack that may fit this Enchantment.

### Returns
- **EnchantmentTarget** - Target type of the Enchantment
```

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

### getMaxLevel()

Source: https://docs.refinedev.org/carbon/javadocs/org/bukkit/enchantments/Enchantment

Gets the maximum level that this Enchantment may become.

```APIDOC
### Method
public abstract int getMaxLevel()

### Description
Gets the maximum level that this Enchantment may become.

### Returns
- **int** - Maximum level of the Enchantment
```
Tokens:
Raw