Use 'enchanting' terminology

'enchant' just didn't feel right, being a verb.
All these things pertain to the act of enchanting.

This is now also consistent with CraftingTransaction etc. The ship already sailed on EnchantInventory, which will have to be renamed at a later datte. However, that was already inconsistent with 'enchanting table', so that's the odd one out here.
This commit is contained in:
Dylan K. Taylor
2023-08-23 16:14:17 +01:00
parent bf668c0f6c
commit 1504fdca24
10 changed files with 44 additions and 44 deletions

View File

@ -27,7 +27,7 @@ use pocketmine\block\inventory\EnchantInventory;
use pocketmine\event\Cancellable;
use pocketmine\event\CancellableTrait;
use pocketmine\event\Event;
use pocketmine\item\enchantment\EnchantOption;
use pocketmine\item\enchantment\EnchantingOption;
use pocketmine\player\Player;
use pocketmine\utils\Utils;
use function count;
@ -36,36 +36,36 @@ use function count;
* Called when a player inserts an item into an enchanting table's input slot.
* The options provided by the event will be shown on the enchanting table menu.
*/
class PlayerEnchantOptionsRequestEvent extends PlayerEvent implements Cancellable{
class PlayerEnchantingOptionsRequestEvent extends PlayerEvent implements Cancellable{
use CancellableTrait;
/**
* @param EnchantOption[] $options
* @param EnchantingOption[] $options
*/
public function __construct(
Player $player,
private readonly EnchantInventory $enchantInventory,
private readonly EnchantInventory $inventory,
private array $options
){
$this->player = $player;
}
public function getEnchantInventory() : EnchantInventory{
return $this->enchantInventory;
public function getInventory() : EnchantInventory{
return $this->inventory;
}
/**
* @return EnchantOption[]
* @return EnchantingOption[]
*/
public function getOptions() : array{
return $this->options;
}
/**
* @param EnchantOption[] $options
* @param EnchantingOption[] $options
*/
public function setOptions(array $options) : void{
Utils::validateArrayValueType($options, function(EnchantOption $_) : void{ });
Utils::validateArrayValueType($options, function(EnchantingOption $_) : void{ });
if(($optionCount = count($options)) > 3){
throw new \LogicException("The maximum number of options for an enchanting table is 3, but $optionCount have been passed");
}

View File

@ -25,8 +25,8 @@ namespace pocketmine\event\player;
use pocketmine\event\Cancellable;
use pocketmine\event\CancellableTrait;
use pocketmine\inventory\transaction\EnchantTransaction;
use pocketmine\item\enchantment\EnchantOption;
use pocketmine\inventory\transaction\EnchantingTransaction;
use pocketmine\item\enchantment\EnchantingOption;
use pocketmine\item\Item;
use pocketmine\player\Player;
@ -38,8 +38,8 @@ class PlayerItemEnchantEvent extends PlayerEvent implements Cancellable{
public function __construct(
Player $player,
private readonly EnchantTransaction $transaction,
private readonly EnchantOption $option,
private readonly EnchantingTransaction $transaction,
private readonly EnchantingOption $option,
private readonly Item $inputItem,
private readonly Item $outputItem,
private readonly int $cost
@ -50,14 +50,14 @@ class PlayerItemEnchantEvent extends PlayerEvent implements Cancellable{
/**
* Returns the inventory transaction involved in this enchant event.
*/
public function getTransaction() : EnchantTransaction{
public function getTransaction() : EnchantingTransaction{
return $this->transaction;
}
/**
* Returns the enchantment option used.
*/
public function getOption() : EnchantOption{
public function getOption() : EnchantingOption{
return $this->option;
}