Nexo

https://jd.nexomc.com/1.8/
Admin
Nexo is a game plugin or mod that enhances gameplay with custom blocks, furniture, combat mechanics,...
Tokens:240,590
Snippets:3,803
Trust Score:5.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### start

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/SelfHostServer.html

Starts the server.

```APIDOC
## start

### Description
Starts the server.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **Unit** - Indicates successful execution.
```

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

### start Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/NexoPackServer.html

Starts the resource pack server functionality.

```java
Unit start()
```

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

### start

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/NexoPackServer.html

Starts the resource pack server or related services. This is a synchronous operation.

```APIDOC
## start

### Description
Initiates the resource pack server or any associated services required for pack management and distribution. This is a synchronous call.

### Method
`Unit`

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
- **Unit** - Indicates the server has started.
```

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

### isFirstInstall Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoDatapack.html

Checks if this is the first installation of the datapack.

```java
final Boolean isFirstInstall()
```

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

### isFirstInstall

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoDatapack.html

Checks if this is the first installation of the datapack.

```APIDOC
## isFirstInstall

### Description
Checks if this is the first installation of the datapack.

### Method
`final Boolean isFirstInstall()`

### Returns
`true` if it's the first install, `false` otherwise.
```

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

### getBestTool Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/drops/Drop.html

Gets the best tool string associated with this drop.

```java
final String getBestTool()
```

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

### instance Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/NexoPlugin.html

Provides a static method to get the singleton instance of NexoPlugin.

```java
final static NexoPlugin instance()
```

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

### run Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/impl/other/SoundAction.html

Executes the sound action for a given player within a specific context.

```APIDOC
## run Method

### Description
Executes the sound action for the specified player.

### Parameters
#### Path Parameters
- **player** (Player) - The player to whom the sound action will be applied.
- **context** (Context<Player>) - The context in which the action is performed.
```

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

### Get Mechanic by ItemStack

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/NoteBlockMechanicFactory.html

Retrieves a NoteBlockMechanic based on an ItemStack. This allows for getting the mechanic associated with a given item in the game.

```java
NoteBlockMechanic getMechanic(ItemStack itemStack)
```

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

### Get Mechanic by BlockData

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/NoteBlockMechanicFactory.html

Retrieves a NoteBlockMechanic based on BlockData. This is useful for getting the mechanic associated with a specific block type or state.

```java
final NoteBlockMechanic getMechanic(BlockData blockData)
```

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

### Place Furniture (Basic)

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Places the furniture at the specified location.

```java
final ItemDisplay place(Location location)
```

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

### getMINI_MESSAGE

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/AdventureUtils.html

Gets the MiniMessage instance.

```APIDOC
## getMINI_MESSAGE

### Description
Gets the MiniMessage instance.

### Method
final MiniMessage

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **MiniMessage**: The MiniMessage instance.

### Response Example
None
```

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

### run Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/impl/command/ConsoleAction.html

Executes the console action for a given player and context.

```APIDOC
## run Method

### Description
Executes the console action for a given player and context.

### Signature
`Unit run(Player player, Context<Player> context)`

### Parameters
* **player** (Player) - The player performing the action.
* **context** (Context<Player>) - The context in which the action is performed.
```

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

### packUrl

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/S3Server.html

Gets the URL of the uploaded pack.

```APIDOC
## packUrl

### Description
Retrieves the URL where the uploaded pack can be accessed.

### Method
```java
String packUrl()
```

### Returns
- String: The URL of the pack.
```

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

### Initialize Server Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/NexoPackServer.Companion.html

The initializeServer method is used to initialize the server.

```kotlin
final static Unit initializeServer()

```

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

### getRESOLVER

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/glyphs/GlyphTag.html

Gets the main TagResolver instance.

```APIDOC
## getRESOLVER

### Description
Gets the main TagResolver instance.

### Method
final TagResolver

### Response
#### Success Response (TagResolver)
- Returns the static TagResolver instance.
```

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

### Download Default Pack Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/PackDownloader.html

Initiates the asynchronous download of default packs. Returns a CompletableFuture that completes when the download is finished.

```java
 final CompletableFuture<Void> downloadDefaultPack()
```
```

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

### from Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/ClickAction.html

Creates a ClickAction instance from a configuration section.

```APIDOC
## from Method

### Description
Factory method to create a ClickAction object from a given ConfigurationSection.

### Signature
`final static ClickAction from(ConfigurationSection config)`

### Parameters
* **config** (ConfigurationSection) - The configuration section to parse.
```

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

### Get Vector2f

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a Vector2f object from a ConfigurationSection.

```java
final static Vector2f getVector2f(ConfigurationSection $self, String key)

```

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

### Get Prompt Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/NexoPackServer.Companion.html

The getPrompt method returns a Component representing the server prompt.

```kotlin
final Component getPrompt()

```

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

### onPlacingVanilla Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/CustomBlockListener.html

Handles vanilla block placing events.

```java
final Unit onPlacingVanilla(BlockPlaceEvent
 $self)
```

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

### Get Vector3f

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a Vector3f object from a ConfigurationSection.

```java
final static Vector3f getVector3f(ConfigurationSection $self, String key)

```

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

### Get Quaternionf

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a Quaternionf object from a ConfigurationSection.

```java
final static Quaternionf getQuaternion(ConfigurationSection $self, String key)

```

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

### Create a NexoPackServer Instance

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/PackServerRegistry.html

Creates and returns an instance of a NexoPackServer based on the provided type string. This method is final.

```java
final NexoPackServer create(String type)
```

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

### from Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/light/LightBlock.html

Creates a LightBlock instance from an object, likely a hitbox object.

```java
final LightBlock from(Object hitboxObject)
```

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

### Get NamespacedKey

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a NamespacedKey object from a ConfigurationSection.

```java
final static NamespacedKey getNamespacedKey(ConfigurationSection $self, String key)

```

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

### Get Key

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a Key object from a ConfigurationSection.

```java
final static Key getKey(ConfigurationSection $self, String key)

```

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

### CompatibilityProvider Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/CompatibilityProvider.html

Initializes a new instance of the CompatibilityProvider class.

```APIDOC
## CompatibilityProvider Constructor

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

### Constructor
CompatibilityProvider()
```

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

### RecipeBuilder open Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/builders/RecipeBuilder.html

Opens the builder's inventory for the player.

```java
final Unit open()
```

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

### CustomBlockRegistry Method: get

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/CustomBlockRegistry.html

Retrieves a CustomBlockType by its name.

```java
final CustomBlockType<out CustomBlockMechanic> get(String name)
```

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

### FurnitureBed Constructor with String

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBed.html

Initializes a FurnitureBed instance using a string representation.

```java
FurnitureBed(String bedString)
```

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

### Get Mechanic Factory

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/MechanicsManager.html

Retrieves a MechanicFactory by its ID.

```java
final MechanicFactory getMechanicFactory(String
 mechanicID)
```

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

### Get ItemBuilder lore

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/ItemBuilder.html

Retrieves the lore of the ItemBuilder.

```java
final List<Component> lore()
```

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

### Place Furniture (With Space Check)

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Places the furniture at the specified location with yaw, facing, and a space availability check.

```java
final ItemDisplay place(Location location, Float yaw, BlockFace facing, Boolean checkSpace)
```

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

### onTrack Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/trident/CustomTridentListener.html

Handles the event when a player starts tracking an entity.

```java
final Unit onTrack(PlayerTrackEntityEvent $self)
```

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

### Get All Glyphs

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves a collection of all registered Glyphs.

```java
final Collection<Glyph> glyphs()
```

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

### NexoDatapack Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoDatapack.html

Initializes a new instance of the NexoDatapack class with a key and description.

```APIDOC
## NexoDatapack(String key, String description)

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

### Constructor
`NexoDatapack(String key, String description)`
```

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

### getHierarchy Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/drops/Drop.html

Gets the list of hierarchy strings for this drop.

```java
final List<String> getHierarchy()
```

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

### Match Server Version by String

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/VersionUtil.html

Checks if the current server version matches the provided version string.

```java
final Boolean matchesServer(String server)
```

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

### Get Root Section

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves the root ConfigurationSection object.

```java
final ConfigurationSection getRootSection()

```

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

### Get Root ID

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves the root ID of the configuration.

```java
final String getRootId()

```

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

### SoundAction Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/impl/other/SoundAction.html

Initializes a new instance of the SoundAction class with the provided ActionMeta.

```APIDOC
## SoundAction Constructor

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

### Parameters
#### Path Parameters
- **meta** (ActionMeta<Player>) - Description for meta parameter
```

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

### FurnitureProperties Full Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureProperties.html

Constructs FurnitureProperties with all possible properties. Use this when manually setting all furniture display and transformation parameters.

```java
FurnitureProperties(Color glowColor, Float viewRange, Display.Brightness brightness, ItemDisplay.ItemDisplayTransform displayTransform, Vector3f _scale, Display.Billboard trackingRotation, Float shadowStrength, Float shadowRadius, Float displayWidth, Float displayHeight, Vector3f translation, Quaternionf leftRotation, Quaternionf rightRotation, Boolean offsetAgainstBlocks)
```

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

### datapackFormat

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/NMSHandler.html

Gets the current data pack format version.

```APIDOC
## datapackFormat

### Description
Gets the current data pack format version.

### Method
GET (or equivalent for SDK)

### Endpoint
NMSHandler.datapackFormat()

### Response
#### Success Response
- **Integer** - The data pack format version.
```

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

### resourcepackFormat

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/NMSHandler.html

Gets the current resource pack format version.

```APIDOC
## resourcepackFormat

### Description
Gets the current resource pack format version.

### Method
GET (or equivalent for SDK)

### Endpoint
NMSHandler.resourcepackFormat()

### Response
#### Success Response
- **Integer** - The resource pack format version.
```

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

### from Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/ClickAction.html

Creates a ClickAction instance from a ConfigurationSection. This is a static factory method.

```java
final static ClickAction from(ConfigurationSection config) 
```

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

### FurnitureBedListener - onProjectile Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBedListener.html

Handles events related to projectile launches.

```java
final Unit onProjectile(ProjectileLaunchEvent $self)
```

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

### Get Repairable Component

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/IItemUtils.html

Retrieves the repairable component of an ItemStack.

```java
Object repairableComponent(ItemStack itemStack)
```

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

### ItemBuilder Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/ItemBuilder.html

Demonstrates the different ways to initialize an ItemBuilder instance.

```java
ItemBuilder(Material material)

```

```java
ItemBuilder(WrappedMMOItem wrapped)

```

```java
ItemBuilder(WrappedCrucibleItem wrapped)

```

```java
ItemBuilder(ItemBuilder itemBuilder)

```

```java
ItemBuilder(ItemStack itemStack)

```

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

### Get NMS Handler

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/NMSHandlers.html

Retrieves the current NMS handler.

```java
final static NMSHandler handler()
```

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

### FurnitureMechanic Companion Methods

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.Companion.html

Lists the methods available in the FurnitureMechanic.Companion class, including base entity creation and key retrieval.

```java
final ItemDisplay baseEntity(Block	block) 
```

```java
final ItemDisplay baseEntity(Location	location) 
```

```java
final ItemDisplay baseEntity(Integer	interactionId) 
```

```java
final NamespacedKey getFURNITURE_KEY() 
```

```java
final NamespacedKey getDISPLAY_NAME_KEY() 
```

```java
final NamespacedKey getFURNITURE_DYE_KEY() 
```

```java
final NamespacedKey getFURNITURE_LIGHT_KEY() 
```

```java
final NamespacedKey getMODELENGINE_KEY() 
```

```java
final NamespacedKey getEVOLUTION_KEY() 
```

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

### Get Consumable Component

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/IItemUtils.html

Retrieves the consumable component of an ItemStack.

```java
Object consumableComponent(ItemStack itemStack)
```

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

### onBreakingTall Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/stringblock/StringBlockMechanicListener.html

Handles the event when a player breaks a tall block.

```java
final Unit onBreakingTall(BlockBreakEvent $self)
```

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

### Get ChorusBlockMechanic by BlockData

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a ChorusBlockMechanic instance from BlockData.

```java
final static ChorusBlockMechanic chorusBlockMechanic(BlockData	blockData)
```

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

### PackDownloader Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/PackDownloader.html

Initializes a new instance of the PackDownloader class. No specific setup is detailed here.

```java
PackDownloader()
```
```

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

### Get StringBlockMechanic by BlockData

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a StringBlockMechanic instance from BlockData.

```java
final static StringBlockMechanic stringMechanic(BlockData	blockData)
```

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

### placeCustomBlock(Player, EquipmentSlot, ItemStack, T, Block, BlockFace) Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/CustomBlockType.html

Abstract method to place a custom block with detailed parameters including player, item, and placement context.

```java
abstract Unit placeCustomBlock(Player player, EquipmentSlot hand, ItemStack item, T mechanic, Block placedAgainst, BlockFace blockFace)
```

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

### downloadDefaultPack

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/PackDownloader.html

Initiates the download of the default pack. This operation is asynchronous and returns a CompletableFuture that completes when the download is finished.

```APIDOC
## downloadDefaultPack

### Description
Initiates the download of the default pack. This operation is asynchronous and returns a CompletableFuture that completes when the download is finished.

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
#### Success Response
- CompletableFuture<Void>: Completes when the download is finished.

### Response Example
N/A (Asynchronous operation)
```

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

### Get ArmorEffectsFactory Instance

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/misc/armor_effects/ArmorEffectsFactory.Companion.html

Retrieves the singleton instance of ArmorEffectsFactory.

```APIDOC
## instance

### Description
Provides access to the singleton instance of the ArmorEffectsFactory.

### Method
```java
final ArmorEffectsFactory
```

### Endpoint
N/A (Method call)

### Parameters
None

### Request Example
```java
ArmorEffectsFactory armorEffectsFactory = ArmorEffectsFactory.Companion.instance();
```

### Response
- **ArmorEffectsFactory** (ArmorEffectsFactory) - The singleton instance of ArmorEffectsFactory.
```

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

### load Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/libs/CommandAPIManager.html

Loads command-related configurations or data.

```java
 final Unit load()
```

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

### Get MUSIC_DISC_KEY Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/jukebox/JukeboxBlock.Companion.html

Retrieves the NamespacedKey for the music disc.

```java
final NamespacedKey getMUSIC_DISC_KEY()
```

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

### Get VANILLA_WOOD_SOUNDS Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/blocksounds/BlockSounds.Companion.html

Retrieves the list of sound names for vanilla wood blocks.

```java
final List<String> getVANILLA_WOOD_SOUNDS()
```

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

### matchesServer (String)

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/VersionUtil.html

Checks if the current server version matches the provided version string.

```APIDOC
## matchesServer (String)

### Description
Checks if the current server version matches the provided version string.

### Method Signature
`final Boolean matchesServer(String server)`
```

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

### Get DEFAULT ShulkerHitbox

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/hitbox/ShulkerHitbox.Companion.html

Retrieves the default ShulkerHitbox instance.

```java
final ShulkerHitbox getDEFAULT()
```

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

### initializeMetrics

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoMetrics.html

Initializes the metrics system. This method should be called to set up the necessary components for metric tracking.

```APIDOC
## initializeMetrics

### Description
Initializes the metrics system. This method should be called to set up the necessary components for metric tracking.

### Method
`public final Unit initializeMetrics()`

### Endpoint
N/A (SDK Method)

### Parameters
None

### Response
- **Unit**: Indicates the successful completion of the initialization process.
```

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

### Get Furniture Hitbox

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the hitbox configuration for the furniture.

```java
final FurnitureHitbox getHitbox()
```

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

### Get Waterloggable Status

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Checks if the furniture item is waterloggable.

```java
final Boolean getWaterloggable()
```

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

### FurnitureHitbox Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/hitbox/FurnitureHitbox.html

Constructors for creating FurnitureHitbox instances with different initialization parameters.

```APIDOC
## FurnitureHitbox Constructors

### FurnitureHitbox(ConfigurationSection hitboxSection)

Initializes a FurnitureHitbox using a ConfigurationSection.

### FurnitureHitbox(Collection<String> hitboxList)

Initializes a FurnitureHitbox using a collection of hitbox strings.

### FurnitureHitbox(Collection<BarrierHitbox> barriers, Collection<InteractionHitbox> interactions, Collection<ShulkerHitbox> shulkers)

Initializes a FurnitureHitbox with collections of barrier, interaction, and shulker hitboxes.

### FurnitureHitbox(ObjectOpenHashSet<BarrierHitbox> barriers, ObjectOpenHashSet<InteractionHitbox> interactions, ObjectOpenHashSet<ShulkerHitbox> shulkers)

Initializes a FurnitureHitbox with ObjectOpenHashSet collections of barrier, interaction, and shulker hitboxes.
```

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

### startBlockBreak Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/breaker/ModernBreakerManager.html

Starts the block breaking process for a player, block, and custom mechanic.

```java
Unit startBlockBreak(Player
 player, Block
 block, CustomBlockMechanic
 mechanic) 
```

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

### Get Water Data

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/IFurniturePacketManager.Companion.html

Retrieves the block data for water.

```java
final BlockData getWATER_DATA()

```

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

### instance()

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/trident/TridentFactory.Companion.html

Retrieves the singleton instance of TridentFactory.

```APIDOC
## instance()

### Description
This method provides access to the singleton instance of the `TridentFactory`.

### Method
`public final`

### Returns
`TridentFactory` - The singleton instance of TridentFactory.

### Example
```kotlin
val tridentFactory = TridentFactory.instance()
```
```

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

### Get Block Sounds Configuration

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the block sounds configuration for a furniture item.

```java
final BlockSounds getBlockSounds()
```

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

### Get Air Data

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/IFurniturePacketManager.Companion.html

Retrieves the block data for air.

```java
final BlockData getAIR_DATA()

```

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

### Start Block Break Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/breaker/BreakerManager.html

Abstract method to initiate the block breaking process. Requires player, block, and custom mechanic details.

```java
abstract Unit startBlockBreak(Player player, Block block, CustomBlockMechanic mechanic)

```

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

### Place Furniture (With Yaw and Facing)

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Places the furniture at the specified location with a given yaw and block face.

```java
final ItemDisplay place(Location location, Float yaw, BlockFace facing)
```

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

### Get Down Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the downward direction.

```java
final String getDownBlock()
```

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

### NexoDatapack Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoDatapack.html

Initializes a new instance of the NexoDatapack class with a key and description.

```java
NexoDatapack(String key, String description)
```

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

### Get Up Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the upward direction.

```java
final String getUpBlock()
```

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

### Get StringBlockMechanicFactory Instance

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/stringblock/StringBlockMechanicFactory.Companion.html

Retrieves the singleton instance of the StringBlockMechanicFactory.

```java
final StringBlockMechanicFactory instance()
```

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

### RecipesView Create Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/inventories/RecipesView.html

Creates a GUI for displaying recipes, taking a page number and a list of custom recipes as input.

```java
final Gui create(Integer	page, List<CustomRecipe>	filteredRecipes)
```

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

### perform Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/commands/CommandsParser.html

Executes a command or action associated with this parser for a given player.

```APIDOC
## perform Method

### Description
Performs an action or executes a command for the specified player.

### Method Signature
`final Unit perform(Player player)`

### Parameters
#### Path Parameters
- **player** (Player) - The player for whom the action is performed.
```

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

### Get Y Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the Y-axis direction.

```java
final String getYBlock()
```

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

### Get Directional Type

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the directional type of the block.

```java
final DirectionalBlock.DirectionalType getDirectionalType()
```

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

### Get MAX_BLOCK_VARIATION

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/NoteBlockMechanicFactory.Companion.html

Retrieves the maximum block variation value.

```APIDOC
## getMAX_BLOCK_VARIATION

### Description
Retrieves the maximum block variation value.

### Method
`getMAX_BLOCK_VARIATION()`

### Returns
- `Integer` - The maximum block variation.
```

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

### Perform Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/misc/custom/listeners/CustomListener.html

Abstract method to perform custom logic with player and item stack.

```java
final Unit perform(Player	player, ItemStack	itemStack)

```

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

### Get No Update

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Checks if updates are disabled for the NexoMeta instance.

```java
final Boolean getNoUpdate()
```

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

### WrappedMMOItem Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/mmoitems/WrappedMMOItem.html

Provides documentation for the different ways to construct a WrappedMMOItem object.

```APIDOC
## WrappedMMOItem Constructors

### WrappedMMOItem(ConfigurationSection section)

**Description**: Constructs a WrappedMMOItem using a ConfigurationSection.

### WrappedMMOItem(ConfigurationSection section, Boolean silent)

**Description**: Constructs a WrappedMMOItem using a ConfigurationSection with an option to be silent.

### WrappedMMOItem(Type type, String id, Integer level, ItemTier tier, Boolean cache)

**Description**: Constructs a WrappedMMOItem with specific item properties and a cache option.
```

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

### Get Emojis

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves a list of all registered emojis as Glyphs.

```java
final List<Glyph> emojis()
```

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

### Get NoteBlockMechanic by BlockData

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a NoteBlockMechanic instance from BlockData.

```java
final static NoteBlockMechanic noteBlockMechanic(BlockData	data)
```

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

### setExperience Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/builders/CookingBuilder.html

Sets the experience points awarded for the recipe.

```java
final Unit setExperience(Integer	experience)
```

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

### getUseFurniture Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/events/furniture/NexoFurnitureInteractEvent.html

Gets the current result for using the furniture.

```java
final Event.Result getUseFurniture()
```

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

### FurnitureMechanic Companion Methods

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.Companion.html

Provides access to methods for creating and retrieving base entities for furniture, as well as accessing various NamespacedKeys used internally.

```APIDOC
## FurnitureMechanic.Companion Methods

### Description
Provides access to methods for creating and retrieving base entities for furniture, as well as accessing various NamespacedKeys used internally.

### Methods

- **baseEntity(Block block)**: Creates a base entity for furniture from a given block.
- **baseEntity(Location location)**: Creates a base entity for furniture from a given location.
- **baseEntity(Integer interactionId)**: Creates a base entity for furniture using an interaction ID.
- **getFURNITURE_KEY()**: Returns the NamespacedKey for furniture.
- **getDISPLAY_NAME_KEY()**: Returns the NamespacedKey for display names.
- **getFURNITURE_DYE_KEY()**: Returns the NamespacedKey for furniture dyes.
- **getFURNITURE_LIGHT_KEY()**: Returns the NamespacedKey for furniture lighting.
- **getMODELENGINE_KEY()**: Returns the NamespacedKey for ModelEngine integration.
- **getEVOLUTION_KEY()**: Returns the NamespacedKey for evolution-related data.
```

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

### getCanRotate Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/events/furniture/NexoFurnitureInteractEvent.html

Gets the current result for rotating the furniture.

```java
final Event.Result getCanRotate()
```

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

### Furniture Placement and Interaction

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Methods for placing, removing, and interacting with furniture, including checking space and running click actions.

```APIDOC
## Furniture Placement and Interaction

### Description
Methods for placing, removing, and interacting with furniture, including checking space and running click actions.

### Methods
- **placedItem**(ItemDisplay baseEntity): ItemDisplay
- **isInteractable**(Player player): Boolean
- **place**(Location location): ItemDisplay
- **place**(Location location, Float yaw, BlockFace facing): ItemDisplay
- **place**(Location location, Float yaw, BlockFace facing, Boolean checkSpace): ItemDisplay
- **removeBaseEntity**(ItemDisplay baseEntity): Unit
- **notEnoughSpace**(ItemDisplay baseEntity, Float yaw): Boolean
- **notEnoughSpace**(Location location, Float yaw): Boolean
- **runClickActions**(Player player): Unit
- **rotateFurniture**(ItemDisplay baseEntity): Unit
```

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

### WrappedMMOItem Constructor with ConfigurationSection

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/mmoitems/WrappedMMOItem.html

Constructor for WrappedMMOItem that takes a ConfigurationSection.

```java
WrappedMMOItem(ConfigurationSection section)
```

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

### NexoBlockPlaceEvent getHand()

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/events/custom_block/NexoBlockPlaceEvent.html

Gets the hand used to place the furniture.

```java
final EquipmentSlot getHand()
```

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

### NexoMetrics Initialization Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoMetrics.html

The `initializeMetrics` method is used to initialize the metrics. It returns Unit.

```java
final Unit initializeMetrics()
```

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

### ItemBuilder Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/ItemBuilder.html

Constructors for initializing an ItemBuilder with different starting points.

```APIDOC
## Constructors

### ItemBuilder(Material material)
Initializes an ItemBuilder with a specific material.

### ItemBuilder(WrappedMMOItem wrapped)
Initializes an ItemBuilder from a WrappedMMOItem.

### ItemBuilder(WrappedCrucibleItem wrapped)
Initializes an ItemBuilder from a WrappedCrucibleItem.

### ItemBuilder(ItemBuilder itemBuilder)
Creates a copy of an existing ItemBuilder.

### ItemBuilder(ItemStack itemStack)
Initializes an ItemBuilder from an existing ItemStack.
```

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

### FurnitureBed Methods

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBed.html

Details the methods available for the FurnitureBed class.

```APIDOC
## FurnitureBed Methods

### getOffset()

Returns the offset vector of the bed.

### getSkipNight()

Returns whether night skipping is enabled for the bed.

### getResetPhantoms()

Returns whether phantom resetting is enabled for the bed.

### offset(Float yaw)

Offset rotated around the baseEntity's yaw.

Parameters:
    `yaw` - Yaw of baseEntity

Returns:
    Rotated offset vector
```

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

### Get NEXO_WOOD_SOUNDS Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/blocksounds/BlockSounds.Companion.html

Retrieves the list of sound names for Nexo wood blocks.

```java
final List<String> getNEXO_WOOD_SOUNDS()
```

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

### JukeboxPlayable Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/jukebox_playable/JukeboxPlayable.html

Provides documentation for the different ways to instantiate a JukeboxPlayable object.

```APIDOC
## JukeboxPlayable Constructors

### JukeboxPlayable(ConfigurationSection jukeboxSection, Key soundId)

**Description**: Constructs a JukeboxPlayable object using a ConfigurationSection and a sound ID.

### JukeboxPlayable(Map<String, Object> jukeboxMap, Key soundId)

**Description**: Constructs a JukeboxPlayable object using a Map of objects and a sound ID.

### JukeboxPlayable(Integer comparatorOutput, Integer range, Float lengthInSeconds, Component description, Key soundId)

**Description**: Constructs a JukeboxPlayable object with specific parameters for comparator output, range, length, description, and sound ID.
```

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

### Get ChorusBlockMechanic by Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a ChorusBlockMechanic instance from a Block object.

```java
final static ChorusBlockMechanic chorusBlockMechanic(Block	block)
```

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

### enable Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/libs/CommandAPIManager.html

Enables the command management system.

```java
 final Unit enable()
```

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

### getString Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/timers/Timer.html

Gets a string representation of the timer's state.

```java
final String getString()
```

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

### Get ConvertSettings Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/converter/Converter.OraxenConverter.html

Retrieves the boolean value indicating if settings should be converted.

```java
final Boolean getConvertSettings()
```

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

### Get Probability Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/drops/Loot.html

Retrieves the drop probability of the Loot object.

```java
final Double getProbability()
```

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

### recipesShowcase Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/inventories/InventoryManager.html

Displays a GUI showcasing recipes, optionally filtered. This method is final and returns a Gui object.

```java
final Gui recipesShowcase(Integer page, List<CustomRecipe> filteredRecipes)

```

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

### uploadPack Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/LobFileServer.html

Initiates the upload of a pack. Returns a CompletableFuture that completes when the upload is done.

```java
CompletableFuture<Void> uploadPack()
```

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

### Get ItemStack Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/drops/Loot.html

Retrieves the ItemStack managed by the Loot object.

```java
final ItemStack getItemStack()
```

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

### Get Limited Placing Information

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the limited placing configuration for a furniture item.

```java
final LimitedPlacing getLimitedPlacing()
```

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

### createInventory Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/builders/WorkbenchBuilder.html

Abstract method to create an inventory for the workbench, taking a player and an inventory title as parameters.

```java
Inventory createInventory(Player	plauer, Component	inventoryTitle) 
```

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

### BlockSounds Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/blocksounds/BlockSounds.html

Initializes a new instance of the BlockSounds class with the specified configuration section.

```APIDOC
## BlockSounds Constructor

### Description
Initializes a new instance of the BlockSounds class using a `ConfigurationSection`.

### Constructor
`BlockSounds(ConfigurationSection section)`
```

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

### breakTimeProgress Method (Get)

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/breaker/FurnitureBreakerManager.ActiveBreakerData.html

Retrieves the current progress of breaking the furniture.

```APIDOC
## breakTimeProgress Method (Get)

### Description
Returns the current progress of breaking the furniture as a `Double`.

### Method
`final Double breakTimeProgress()`

### Returns
- **Double** - The current break time progress.
```

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

### Get Materials

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/breaker/ToolTypeSpeedModifier.html

Retrieves the set of materials associated with this speed modifier.

```java
final Set<Material> materials()
```

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

### uploadPack

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/server/PolymathServer.html

Initiates the upload process for the game pack.

```APIDOC
## uploadPack

### Description
Initiates the asynchronous upload process for the game pack to the server.

### Method
N/A (This is a method call, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **CompletableFuture<Void>** - A future that completes when the upload is finished.

### Response Example
```json
{
  "example": "Upload initiated successfully."
}
```
```

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

### atleast

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/VersionUtil.html

Checks if the current server version is at least the specified version string.

```APIDOC
## atleast

### Description
Checks if the current server version is at least the specified version string.

### Method Signature
`final static Boolean atleast(String versionString)`
```

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

### Get Key List

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/NexoYamlKt.html

Retrieves a List of Key objects from a ConfigurationSection.

```java
final static List<Key> getKeyList(ConfigurationSection $self, String key)

```

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

### Get NMS Version

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/NMSHandlers.html

Retrieves the current NMS version string.

```APIDOC
## getVersion

### Description
Retrieves the current NMS version string.

### Method
`public String getVersion()`

### Returns
- `String`: The current NMS version.
```

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

### onPlayerEquipVanilla Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/customarmor/CustomArmorListener.html

Handles the PlayerArmorChangeEvent, specifically when a player equips vanilla armor.

```java
final Unit onPlayerEquipVanilla(PlayerArmorChangeEvent $self) 
```

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

### Get Blockstate Component

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/IItemUtils.html

Retrieves the blockstate component of an ItemStack as a Map.

```java
Map<String, String> blockstateComponent(ItemStack itemStack)
```

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

### onPlacingFurniture Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/listeners/FurnitureSoundListener.html

Handles the NexoFurniturePlaceEvent when placing furniture.

```java
final Unit onPlacingFurniture(NexoFurniturePlaceEvent
 $self) 
```

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

### Get NMS Version

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/NMSHandlers.html

Retrieves the current NMS version string.

```java
final String getVersion()
```

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

### WrappedMMOItem Constructor with Type, ID, Level, Tier, and Cache

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/mmoitems/WrappedMMOItem.html

Constructor for WrappedMMOItem that initializes with type, ID, level, tier, and cache settings.

```java
WrappedMMOItem(Type type, String id, Integer level, ItemTier tier, Boolean cache)
```

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

### Get VANILLA_STONE_SOUNDS Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/blocksounds/BlockSounds.Companion.html

Retrieves the list of sound names for vanilla stone blocks.

```java
final List<String> getVANILLA_STONE_SOUNDS()
```

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

### Get StringBlockMechanic by Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a StringBlockMechanic instance from a Block object.

```java
final static StringBlockMechanic stringMechanic(Block	block)
```

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

### LightMechanic Constructor with Parameters

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/light/LightMechanic.html

Initializes a LightMechanic instance with a list of light blocks, toggleable status, and model information. Use this constructor for programmatic creation of light mechanics.

```java
LightMechanic(List<LightBlock> lightBlocks, Boolean toggleable, String _toggledModel, Key _toggledItemModel)
```

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

### ItemBuilder Getters

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/ItemBuilder.html

Provides examples of getter methods for various item properties.

```java
final Map<PersistentDataSpace<?, ?>, Object> getPersistentDataMap()

```

```java
final PersistentDataContainer getPersistentDataContainer()

```

```java
final Map<Enchantment, Integer> getEnchantments()

```

```java
final NexoMeta getNexoMeta()

```

```java
final Material getType()

```

```java
final Integer getAmount()

```

```java
final Color getColor()

```

```java
final Key getTrimPattern()

```

```java
final PotionType getBasePotionType()

```

```java
final List<PotionEffect> getCustomPotionEffects()

```

```java
final Boolean getUnbreakable()

```

```java
final Set<ItemFlag> getItemFlags()

```

```java
final Multimap<Attribute, AttributeModifier> getAttributeModifiers()

```

```java
final Integer getCustomModelData()

```

```java
final Component getDisplayName()

```

```java
final List<Component> getLore()

```

```java
final ItemStack getFinalItemStack()

```

```java
final FoodComponent getFoodComponent()

```

```java
final ToolComponent getToolComponent()

```

```java
final Boolean getEnchantmentGlintOverride()

```

```java
final Integer getMaxStackSize()

```

```java
final Component getItemName()

```

```java
final Boolean getFireResistant()

```

```java
final Boolean getHideToolTip()

```

```java
final ItemRarity getRarity()

```

```java
final Integer getDurability()

```

```java
final Boolean isDamagedOnBlockBreak()

```

```java
final Boolean isDamagedOnEntityHit()

```

```java
final JukeboxPlayableComponent getJukeboxPlayable()

```

```java
final EquippableComponent getEquippable()

```

```java
final Boolean isGlider()

```

```java
final UseCooldownComponent getUseCooldown()

```

```java
final ItemStack getUseRemainder()

```

```java
final Tag<DamageType> getDamageResistant()

```

```java
final NamespacedKey getTooltipStyle()

```

```java
final NamespacedKey getItemModel()

```

```java
final Map<String, String> getBlockStates()

```

```java
final Integer getEnchantable()

```

```java
final Object getConsumableComponent()

```

```java
final Object getRepairableComponent()

```

```java
final Boolean getCache()

```

```java
final CustomModelDataComponent getCustomModelDataComponent()

```

```java
final TooltipDisplay getTooltipDisplay()

```

```java
final Key getTrimPatternKey()

```

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

### Get NoteBlockMechanic by Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/api/NexoBlocks.html

Obtain a NoteBlockMechanic instance from a Block object.

```java
final static NoteBlockMechanic noteBlockMechanic(Block	block)
```

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

### createInventory Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/builders/CookingBuilder.html

Creates the inventory for the cooking builder.

```java
Inventory createInventory(Player	plaver, Component	inventoryTitle)
```

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

### RadiusLimitation

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/limitedplacing/LimitedPlacing.RadiusLimitation.html

Provides methods to get the radius and amount limitations for placing.

```APIDOC
## Class: RadiusLimitation

### Description
Represents a limitation on placing objects within a specified radius and quantity.

### Methods

#### getRadius

##### Description
Retrieves the maximum radius allowed for placing.

##### Returns
- `Integer` - The radius limitation.

#### getAmount

##### Description
Retrieves the maximum amount of objects that can be placed.

##### Returns
- `Integer` - The amount limitation.
```

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

### Download Required Pack Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/pack/PackDownloader.html

Initiates the asynchronous download of required packs. Returns a CompletableFuture that completes when the download is finished.

```java
 final CompletableFuture<Void> downloadRequiredPack()
```
```

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

### Get Barrier Data Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/hitbox/BarrierHitbox.html

Retrieves the Waterlogged state of the barrier.

```java
final Waterlogged getBarrierData()
```

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

### FurnitureBaseEntity Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureBaseEntity.html

The constructor for FurnitureBaseEntity, initializing it with an ItemDisplay and a FurnitureMechanic.

```java
FurnitureBaseEntity(ItemDisplay baseEntity, FurnitureMechanic mechanic)

```

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

### Get Breakable Component

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the breakable component if the furniture can be broken.

```java
final Breakable getBreakable()
```

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

### LightMechanic Constructor with ConfigurationSection

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/light/LightMechanic.html

Initializes a LightMechanic instance using a ConfigurationSection. This constructor is used for loading light configurations from external sources.

```java
LightMechanic(ConfigurationSection section)
```

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

### Get Restricted Rotation

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the restricted rotation configuration for the furniture.

```java
final FurnitureMechanic.RestrictedRotation getRestrictedRotation()
```

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

### Instance Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureFactory.Companion.html

Retrieves the singleton instance of FurnitureFactory.

```java
final FurnitureFactory instance()
```

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

### Get Rotatable Component

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the rotatable component if the furniture can be rotated.

```java
final Rotatable getRotatable()
```

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

### plugin

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/CompatibilityProvider.html

Retrieves the plugin instance associated with this compatibility provider.

```APIDOC
## plugin

### Description
Retrieves the plugin instance associated with this compatibility provider.

### Method
GET

### Endpoint
/compatibility/plugin

### Returns
- **T**: The plugin instance.
```

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

### Get Barrier Data

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/IFurniturePacketManager.Companion.html

Retrieves the barrier data for furniture hitboxes.

```java
final Waterlogged getBARRIER_DATA()

```

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

### EmptyFurniturePacketManager Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/nms/EmptyFurniturePacketManager.html

Initializes a new instance of the EmptyFurniturePacketManager class.

```APIDOC
## EmptyFurniturePacketManager()

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

### Constructor
EmptyFurniturePacketManager()
```

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

### onJoin Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/listeners/RecipeEventManager.html

Handles the event when a player joins the game.

```java
final Unit onJoin(PlayerJoinEvent $self)
```

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

### Get Furniture Properties

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureMechanic.html

Retrieves the core properties of the furniture item.

```java
final FurnitureProperties getProperties()
```

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

### Get Bounding Boxes Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/FurnitureSubEntity.html

Returns the list of bounding boxes for the furniture sub-entity.

```java
final List<BoundingBox> getBoundingBoxes()
```

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

### Get West Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the west direction.

```java
final String getWestBlock()
```

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

### Get East Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the east direction.

```java
final String getEastBlock()
```

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

### NexoPlugin Methods

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/NexoPlugin.html

This section details the public methods available in the NexoPlugin class, including lifecycle methods, configuration managers, and utility functions.

```APIDOC
## NexoPlugin Methods

### Description
Provides access to various managers and utility functions within the NexoMC plugin.

### Methods

- **getFoliaLib()**: Returns the FoliaLib instance.
- **onLoad()**: Lifecycle method called when the plugin is loaded.
- **onEnable()**: Lifecycle method called when the plugin is enabled.
- **onDisable()**: Lifecycle method called when the plugin is disabled.
- **reloadConfigs()**: Reloads the plugin's configurations.
- **configsManager()**: Returns the ConfigsManager instance.
- **resourceManager()**: Returns the ResourceManager instance.
- **resourceManager(ResourceManager resourceManager)**: Sets the ResourceManager instance.
- **converter()**: Returns the Converter instance.
- **fontManager()**: Returns the FontManager instance.
- **fontManager(FontManager fontManager)**: Sets the FontManager instance.
- **soundManager()**: Returns the SoundManager instance.
- **soundManager(SoundManager soundManager)**: Sets the SoundManager instance.
- **breakerManager()**: Returns the BreakerManager instance.
- **invManager()**: Returns the InventoryManager instance.
- **packGenerator()**: Returns the PackGenerator instance.
- **packGenerator(PackGenerator packGenerator)**: Sets the PackGenerator instance.
- **packServer()**: Returns the NexoPackServer instance.
- **packServer(NexoPackServer server)**: Sets the NexoPackServer instance.
- **clickActionManager()**: Returns the ClickActionManager instance.
- **instance()**: Returns the static instance of NexoPlugin.
```

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

### Get South Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the south direction.

```java
final String getSouthBlock()
```

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

### FurnitureBedListener Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBedListener.html

Constructor for FurnitureBedListener. Initializes the listener with the player and the furniture bed involved.

```java
FurnitureBedListener(Player bedPlayer, FurnitureBed bed)
```

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

### Get North Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the north direction.

```java
final String getNorthBlock()
```

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

### FurnitureSeat Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/seats/FurnitureSeat.html

Constructors for the FurnitureSeat class.

```APIDOC
## FurnitureSeat Constructors

### FurnitureSeat(Map<String, Object> offset)

### FurnitureSeat(String offset)

### FurnitureSeat(Vector offset)
```

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

### Get Strip Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/logstrip/LogStripping.html

Retrieves the NoteBlock that represents the stripped log.

```java
final NoteBlock getStripBlock()
```

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

### Pack Info Configuration

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Processes pack information from a ConfigurationSection for the NexoMeta instance.

```java
final Unit packInfo(ConfigurationSection packSection)
```

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

### Get Z Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the Z-axis direction.

```java
final String getZBlock()
```

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

### loadNexoLibs

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/NexoLibsLoader.html

Loads the necessary Nexo libraries for the plugin. This method should be called during the plugin's initialization phase.

```APIDOC
## loadNexoLibs

### Description
Loads the necessary Nexo libraries for the plugin. This method should be called during the plugin's initialization phase.

### Method
`static void`

### Signature
`loadNexoLibs(JavaPlugin plugin)`

### Parameters
#### Path Parameters
- **plugin** (JavaPlugin) - Required - The main plugin instance.
```

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

### FurnitureBed Constructor with Vector and Booleans

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBed.html

Initializes a FurnitureBed instance with specific offset, skipNight, and resetPhantoms values.

```java
FurnitureBed(Vector offset, Boolean skipNight, Boolean resetPhantoms)
```

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

### Get Strip Mechanic

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/logstrip/LogStripping.html

Retrieves the NoteBlockMechanic associated with the stripping action.

```java
final NoteBlockMechanic getStripMechanic()
```

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

### build Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/mmoitems/WrappedMMOItem.html

Builds and returns the ItemStack representation of the wrapped MMOItem.

```java
final ItemStack build()
```

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

### Get X Block

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/directional/DirectionalBlock.html

Retrieves the block identifier for the X-axis direction.

```java
final String getXBlock()
```

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

### Get Disable Enchanting

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Checks if enchanting is disabled for the NexoMeta instance.

```java
final Boolean getDisableEnchanting()
```

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

### ConsoleAction Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/actions/impl/command/ConsoleAction.html

Initializes a new instance of the ConsoleAction class with the specified ActionMeta.

```APIDOC
## ConsoleAction Constructor

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

### Signature
`ConsoleAction(ActionMeta<Player> meta)`

### Parameters
* **meta** (ActionMeta<Player>) - The metadata associated with the action.
```

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

### Get Excluded From Commands

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Checks if the NexoMeta instance is excluded from commands.

```java
final Boolean getExcludedFromCommands()
```

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

### LogStripping Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/logstrip/LogStripping.html

Initializes a new instance of the LogStripping class with the specified configuration section.

```java
LogStripping(ConfigurationSection logStripSection)
```

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

### Get Excluded From Inventory

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Checks if the NexoMeta instance is excluded from inventory.

```java
final Boolean getExcludedFromInventory()
```

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

### furnitureSpawns Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/drops/Drop.html

Manages spawning loot for furniture entities.

```java
final Unit furnitureSpawns(ItemDisplay baseEntity, ItemStack itemInHand)
```

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

### BlockSounds Constructor

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/blocksounds/BlockSounds.html

Initializes a new instance of the BlockSounds class using a ConfigurationSection.

```java
BlockSounds(ConfigurationSection section)
```

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

### Get ItemBuilder trim pattern

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/ItemBuilder.html

Retrieves the trim pattern of the ItemBuilder.

```java
final TrimPattern getTrimPattern()
```

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

### NoteBlockMechanicFactory Methods

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/custom_block/noteblock/NoteBlockMechanicFactory.html

This section details the methods available in the NoteBlockMechanicFactory class for retrieving configuration and mechanic instances.

```APIDOC
## getToolTypes

### Description
Retrieves the list of tool types associated with NoteBlock mechanics.

### Method
```java
final List<String> getToolTypes()
```

## getReimplementNoteblockFeatures

### Description
Checks if the NoteBlock features are reimplemented.

### Method
```java
final Boolean getReimplementNoteblockFeatures()
```

## getBLOCK_PER_VARIATION

### Description
Retrieves a map of block variations to their corresponding NoteBlock mechanics.

### Method
```java
final Int2ObjectOpenHashMap<NoteBlockMechanic> getBLOCK_PER_VARIATION()
```

## generateBlockState

### Description
Generates the BlockState for a NoteBlock.

### Method
```java
final BlockState generateBlockState()
```

## getMechanic (String itemID)

### Description
Retrieves a NoteBlockMechanic based on its item ID.

### Method
```java
NoteBlockMechanic getMechanic(String itemID)
```

## getMechanic (ItemStack itemStack)

### Description
Retrieves a NoteBlockMechanic based on an ItemStack.

### Method
```java
NoteBlockMechanic getMechanic(ItemStack itemStack)
```

## getMechanic (BlockData blockData)

### Description
Retrieves a NoteBlockMechanic based on BlockData.

### Method
```java
final NoteBlockMechanic getMechanic(BlockData blockData)
```

## parse

### Description
Parses a ConfigurationSection to create a NoteBlockMechanic.

### Method
```java
NoteBlockMechanic parse(ConfigurationSection section)
```
```

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

### Get Model

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/items/NexoMeta.html

Retrieves the primary model key for the NexoMeta instance.

```java
final Key getModel()
```

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

### FurnitureBed Constructors

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/mechanics/furniture/bed/FurnitureBed.html

Details the available constructors for the FurnitureBed class.

```APIDOC
## FurnitureBed Constructors

### FurnitureBed(String bedString)

Creates a FurnitureBed instance from a string representation.

### FurnitureBed(Vector offset, Boolean skipNight, Boolean resetPhantoms)

Creates a FurnitureBed instance with specified offset, skipNight, and resetPhantoms values.
```

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

### Get Glyph from Placeholder

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves a Glyph based on a placeholder string.

```java
final Glyph glyphFromPlaceholder(String word)
```

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

### ItemsView create() Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/utils/inventories/ItemsView.html

Method to create a PaginatedGui instance.

```java
final PaginatedGui create()

```

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

### Get Tab Completions

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves the set of tab completion strings.

```java
final ObjectOpenHashSet<String> getTabcompletions()
```

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

### enable Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/compatibilities/CompatibilityProvider.html

Enables the compatibility provider for a specific plugin, identified by its name. Accepts a String argument for the plugin name.

```java
final Unit enable(String	pluginName)
```

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

### Get Unicode Glyph Map

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves the map of Unicode glyphs.

```java
final Object2ObjectOpenHashMap<Character, String> getUnicodeGlyphMap()
```

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

### fromRecipe Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/CustomRecipe.Companion.html

Converts a Bukkit Recipe to a CustomRecipe.

```java
final CustomRecipe fromRecipe(Recipe bukkitRecipe)
```

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

### Get Placeholder Glyph Map

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontManager.html

Retrieves the map of placeholder glyphs.

```java
final Object2ObjectOpenHashMap<String, Glyph> getPlaceholderGlyphMap()
```

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

### Get Plugin Instance

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/configs/ResourceManager.html

Retrieves the JavaPlugin instance associated with this ResourceManager.

```java
final JavaPlugin getPlugin()
```

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

### instance Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/recipes/listeners/RecipeEventManager.html

Returns the singleton instance of RecipeEventManager.

```java
final static RecipeEventManager instance()
```

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

### Get Converter Resource

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/configs/ResourceManager.html

Retrieves the converter resource managed by the ResourceManager.

```java
final ResourceManager.Resource getConverter()
```

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

### onJoin Method

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/fonts/FontListener.html

Handles the PlayerJoinEvent when a player joins the server.

```java
final Unit onJoin(PlayerJoinEvent	$self)
```

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

### Get Mechanics Resource

Source: https://jd.nexomc.com/1.8/com/nexomc/nexo/configs/ResourceManager.html

Retrieves the mechanics resource managed by the ResourceManager.

```java
final ResourceManager.Resource getMechanics()
```
Tokens:
Raw