feat/Enchantment/VeinMine

[illyrius666]

Description

How Has This Been Tested?

• Unit tests
• Integration tests
• Manual testing
• Other (please describe)

Checklist:

• Follow style guidelines of this project.
• Perform self-review of the code.
• Comment on hard-to-understand areas.
• Update documentation accordingly.
• Ensure changes generate no new warnings.
• Add tests proving the fix is effective, or the feature works.
• Verify new and existing unit tests pass locally.
• Ensure dependent changes are merged and published.

Additional context:

[Copilot]

Pull Request Overview

This PR introduces a new VeinMine enchantment that allows players to mine connected ore blocks of the same type in a single action. The implementation includes refactoring of enchantment description display logic across all enchantments and code extraction in PickupEnchantment for better reusability.

Key changes:

• New VeinMine enchantment with BFS-based connected block detection for ore veining
• Refactored enchantment display names using new utility functions snakeToProperCase() and displayName()
• Extracted item transfer logic in PickupEnchantment to transferItemEntitiesToInventory() for potential reuse

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/main/kotlin/org/xodium/vanillaplus/enchantments/VeinMineEnchantment.kt	Implements new vein mining enchantment with BFS algorithm for finding connected ore blocks, durability handling, and integration with PickupEnchantment
src/main/kotlin/org/xodium/vanillaplus/utils/ExtUtils.kt	Adds utility functions for converting snake_case to title case and creating enchantment display names
src/main/kotlin/org/xodium/vanillaplus/enchantments/PickupEnchantment.kt	Refactors item transfer logic into reusable function and updates to use new display name utility
src/main/kotlin/org/xodium/vanillaplus/enchantments/ReplantEnchantment.kt	Updates to use new displayName() utility instead of manual string formatting
src/main/kotlin/org/xodium/vanillaplus/enchantments/NimbusEnchantment.kt	Refactors speed multiplier calculation to use map lookup and updates to new display name utility
src/main/kotlin/org/xodium/vanillaplus/enchantments/NightVisionEnchantment.kt	Updates to use new displayName() utility
src/main/kotlin/org/xodium/vanillaplus/modules/PlayerModule.kt	Integrates VeinMine enchantment handler into BlockBreakEvent
src/main/kotlin/org/xodium/vanillaplus/VanillaPlusBootstrap.kt	Registers VeinMine enchantment and adds to tradeable enchantments tag
.idea/libraries/Gradle__io_papermc_paper_paper_api_1_21_10_R0_1_SNAPSHOT.xml	Removes duplicate sources entry from IDE library configuration

Files not reviewed (1)

• .idea/libraries/Gradle__io_papermc_paper_paper_api_1_21_10_R0_1_SNAPSHOT.xml: Language not supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The vein mining functionality doesn't account for the player's hunger/exhaustion. When blocks are broken in survival mode, the player should get exhausted based on the number of blocks mined. Currently, only the first block (from the event) will apply exhaustion naturally, but the additional blocks broken by vein mining won't trigger the normal exhaustion mechanics. Consider adding exhaustion for each additional block mined using player.exhaustion.

Suggested change

	// Apply exhaustion for each additional block broken
	player.exhaustion += 0.005F

[Copilot]

If SPEED_MODIFIER[enchantLevel] returns null (for invalid enchant levels), the function returns early without resetting the speed. This means an entity with an invalid enchant level would retain whatever speed it previously had. Consider providing a default value: SPEED_MODIFIER[enchantLevel] ?: 1.0 to ensure the speed is always set to a valid value.

Suggested change

	attribute?.baseValue = DEFAULT_FLY_SPEED * (SPEED_MODIFIER[enchantLevel] ?: return)
	attribute?.baseValue = DEFAULT_FLY_SPEED * (SPEED_MODIFIER[enchantLevel] ?: 1.0)

[Copilot]

The displayName() extension function lacks documentation. Consider adding KDoc to explain its purpose, parameters, and return value. For example:

/**
 * Converts the enchantment key to a human-readable display name Component.
 * The key value is converted from snake_case to Title Case.
 * @return A Component containing the formatted display name.
 */

Suggested change

	/** Extension function specifically for enchantment keys */
	/**
	* Converts the enchantment key to a human-readable display name Component.
	* The key value is converted from snake_case to Proper Case with spaces.
	* @receiver TypedKey<Enchantment> The enchantment key to convert.
	* @return A Component containing the formatted display name.
	*/

[Copilot]

When the tool breaks (currentDamage >= maxDurability), the loop breaks but the damage is still applied to the item in lines 93-96. This could result in the item having damage equal to or exceeding its max durability but not being destroyed. The item should be properly destroyed when it reaches max durability, or the damage application should be capped at maxDurability - 1.

Suggested change

	damageableMeta.damage = currentDamage
	val maxDurability = itemInHand.type.maxDurability.toInt()
	damageableMeta.damage = minOf(currentDamage, maxDurability - 1)

[Copilot]

The code handling item pickup in VeinMineEnchantment duplicates the logic from PickupEnchantment. Consider using PickupEnchantment.transferItemEntitiesToInventory() which was refactored for reuse. However, since this code works with drops directly from getDrops() rather than Item entities, you would need to either:

1. Create a separate utility for transferring ItemStacks to inventory
2. Keep the current implementation but extract it to a shared utility function

The current implementation is functionally correct but creates maintenance overhead by duplicating the transfer logic.