feat/PlayerModule/ReplantEnchantment

[illyrius666]

Description

How Has This Been Tested?

This pull request introduces a new custom enchantment, "Replant", and integrates it into the plugin's lifecycle and player module. The most important changes are the addition of the enchantment's definition and registry, the implementation of automatic crop replanting when harvesting with enchanted tools, and the necessary interface and event handling updates to support these features.

New Enchantment System

• Added ReplantEnchantment, a custom enchantment that enables automatic crop replanting when used with hoes. The enchantment is registered with proper tags for tradeability, non-treasure status, and enchanting table availability (src/main/kotlin/org/xodium/vanillaplus/enchantments/ReplantEnchantment.kt, src/main/kotlin/org/xodium/vanillaplus/VanillaPlusBootstrap.kt). [1] [2]

• Introduced EnchantmentInterface to standardize enchantment creation, initialization, and registry access, facilitating future expansion of custom enchantments (src/main/kotlin/org/xodium/vanillaplus/interfaces/EnchantmentInterface.kt).

Player Module Enhancements

• Implemented an event handler for BlockBreakEvent that checks for the "Replant" enchantment on the player's tool and automatically replants fully grown crops after harvesting (src/main/kotlin/org/xodium/vanillaplus/modules/PlayerModule.kt).

• Added imports and references for new classes and interfaces to support the replanting logic and enchantment checks (src/main/kotlin/org/xodium/vanillaplus/modules/PlayerModule.kt). [1] [2]

Miscellaneous

• Updated the project dictionary to include new terminology related to the changes, such as "ageable" and "veinmine" (.idea/dictionaries/project.xml). [1] [2]

• 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 pull request introduces a new custom "Replant" enchantment that automatically replants crops when harvesting with an enchanted hoe. The implementation includes enchantment registration via a new bootstrap system, an interface for standardizing custom enchantments, and event-driven replanting logic.

Key Changes:

• Added VanillaPlusBootstrap class to handle plugin bootstrapping and custom enchantment registration during Paper's lifecycle events
• Created EnchantmentInterface to standardize custom enchantment implementation with key, initialization, and registry access methods
• Implemented replanting functionality in PlayerModule that detects fully-grown crops and replants them after harvest when using an enchanted hoe

Reviewed Changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/main/kotlin/org/xodium/vanillaplus/VanillaPlusBootstrap.kt	New bootstrap class that registers the Replant enchantment during plugin initialization and assigns it to appropriate enchantment tags (tradeable, non-treasure, enchanting table)
src/main/kotlin/org/xodium/vanillaplus/interfaces/EnchantmentInterface.kt	New interface defining the contract for custom enchantments with methods for initialization and registry access
src/main/kotlin/org/xodium/vanillaplus/enchantments/ReplantEnchantment.kt	Implementation of the Replant enchantment with configuration for costs, level, weight, and active equipment slots
src/main/kotlin/org/xodium/vanillaplus/modules/PlayerModule.kt	Added BlockBreakEvent handler and replant logic to automatically replant fully-grown crops after 2 ticks when using enchanted tools; includes whitespace formatting improvements to existing event handlers
build.gradle.kts	Configured the bootstrap class in the Paper plugin configuration to enable lifecycle event handling
.idea/dictionaries/project.xml	Added project-specific terms "ageable" and "veinmine" to the dictionary

Files not reviewed (1)

• .idea/dictionaries/project.xml: Language not supported

---

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

[Copilot]

The code checks event.player.inventory.itemInMainHand but doesn't verify if this was actually the item used to break the block. Players can break blocks with their off-hand as well. Consider checking both main hand and off-hand, or use a more reliable method to determine which hand was used for breaking the block.

Suggested change

	replant(event.block, event.player.inventory.itemInMainHand)
	val mainHand = event.player.inventory.itemInMainHand
	val offHand = event.player.inventory.itemInOffHand
	// Prefer main hand if both have the enchantment, but check both
	if (mainHand.hasItemMeta() && mainHand.itemMeta.hasEnchant(ReplantEnchantment.get())) {
	replant(event.block, mainHand)
	} else if (offHand.hasItemMeta() && offHand.itemMeta.hasEnchant(ReplantEnchantment.get())) {
	replant(event.block, offHand)
	}

[Copilot]

The documentation refers to "Drift enchantment" but this interface is generic and used for all enchantments, including the "Replant" enchantment. The documentation should be updated to be generic (e.g., "Initializes the enchantment.")

Suggested change

	* Initializes the Drift enchantment.
	* Initializes the enchantment.

[Copilot]

The replant logic directly replaces the block type without considering whether the block was actually broken. If the BlockBreakEvent is cancelled by another plugin with lower priority, this could still replant the crop. Consider adding ignoreCancelled = true to the EventHandler annotation to prevent this issue.

Suggested change

	@EventHandler
	@EventHandler(ignoreCancelled = true)

[Copilot]

There's a potential race condition in the replanting logic. The code schedules a task to run 2 ticks later that sets block.type = blockType, but it doesn't verify that the block is actually AIR after the break event completes. If another plugin or event modifies the block during the delay, or if the BlockBreakEvent gets cancelled after this handler runs, this could overwrite that change or place a crop in an unexpected location. Consider checking if (block.type == Material.AIR) before setting the block type in the delayed task.

Suggested change

	block.type = blockType
	block.blockData = ageable.apply { age = 0 }
	if (block.type == Material.AIR) {
	block.type = blockType
	block.blockData = ageable.apply { age = 0 }
	}

[Copilot]

[nitpick] The function checks if the tool has the Replant enchantment on a hoe, but doesn't verify that the block being broken is actually a crop that should be replanted. While the cast to Ageable will return null for non-ageable blocks, some ageable blocks like saplings or stems might not be appropriate for this enchantment. Consider adding validation to ensure only appropriate crop blocks (e.g., wheat, carrots, potatoes, beetroots, etc.) are replanted, or document that all ageable blocks are intentionally supported.

[Copilot]

[nitpick] The enchantment check doesn't verify that the tool is a hoe. While the enchantment is registered to only appear on hoes (in VanillaPlusBootstrap.kt), players could theoretically use commands or other means to add this enchantment to non-hoe items. Consider adding a check to ensure the tool is a hoe before attempting to replant, or document that this is intentionally allowed for any tool with the enchantment.

Suggested change

	if (ageable.age < ageable.maximumAge) return
	if (ageable.age < ageable.maximumAge) return
	// Only allow hoes to trigger replant
	if (tool.type !in setOf(
	Material.WOODEN_HOE,
	Material.STONE_HOE,
	Material.IRON_HOE,
	Material.GOLDEN_HOE,
	Material.DIAMOND_HOE,
	Material.NETHERITE_HOE
	)) return

[Copilot]

[nitpick] Using a 2-tick delay for replanting may be fragile. The block break event processes synchronously, and the drops/block state changes happen during event processing. A 2-tick delay might not be sufficient in all cases (e.g., with lag or other plugins modifying the block). Consider using a 1-tick delay (which is typically sufficient for the block to be fully processed) or adding validation that the block is AIR before replanting to ensure the break was successful.

Suggested change

	val blockType = block.type
	block.type = blockType
	block.blockData = ageable.apply { age = 0 }
	},
	2,
	// Only replant if the block is AIR (i.e., was actually broken)
	if (block.type == Material.AIR) {
	block.type = block.type // restore the crop type
	block.blockData = ageable.apply { age = 0 }
	}
	},
	1,