PocketMine-MP 5.21.2 git-a6534ecbbbcf369264567d27e5ed70f7f5be9816
Loading...
Searching...
No Matches
pocketmine\item\enchantment\Enchantment Class Reference
+ Inheritance diagram for pocketmine\item\enchantment\Enchantment:
+ Collaboration diagram for pocketmine\item\enchantment\Enchantment:

Public Member Functions

 __construct (private Translatable|string $name, private int $rarity, private int $maxLevel, ?\Closure $minEnchantingPower=null, private int $enchantingPowerRange=50)
 
 getMaxEnchantingPower (int $level)
 
 getMaxLevel ()
 
 getMinEnchantingPower (int $level)
 
 getName ()
 
 getRarity ()
 
 isCompatibleWith (Enchantment $other)
 

Detailed Description

Manages enchantment type data.

Definition at line 37 of file Enchantment.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\item\enchantment\Enchantment::__construct ( private Translatable|string $name,
private int $rarity,
private int $maxLevel,
?\Closure $minEnchantingPower = null,
private int $enchantingPowerRange = 50 )

@phpstan-param null|(\Closure(int $level) : int) $minEnchantingPower

Parameters
int$enchantingPowerRangeValue used to calculate the maximum enchanting power (minEnchantingPower + enchantingPowerRange)

Definition at line 49 of file Enchantment.php.

Member Function Documentation

◆ getMaxEnchantingPower()

pocketmine\item\enchantment\Enchantment::getMaxEnchantingPower ( int $level)

Returns the maximum enchanting power value allowed for the particular level of the enchantment to be available in an enchanting table.

Enchanting power is a random value based on the number of bookshelves around an enchanting table and the enchantability of the item being enchanted. It is only used when determining the available enchantments for the enchantment options.

Definition at line 112 of file Enchantment.php.

◆ getMaxLevel()

pocketmine\item\enchantment\Enchantment::getMaxLevel ( )

Returns the maximum level of this enchantment that can be found on an enchantment table.

Definition at line 81 of file Enchantment.php.

◆ getMinEnchantingPower()

pocketmine\item\enchantment\Enchantment::getMinEnchantingPower ( int $level)

Returns the minimum enchanting power value required for the particular level of the enchantment to be available in an enchanting table.

Enchanting power is a random value based on the number of bookshelves around an enchanting table and the enchantability of the item being enchanted. It is only used when determining the available enchantments for the enchantment options.

Definition at line 100 of file Enchantment.php.

◆ getName()

pocketmine\item\enchantment\Enchantment::getName ( )

Returns a translation key for this enchantment's name.

Definition at line 67 of file Enchantment.php.

◆ getRarity()

pocketmine\item\enchantment\Enchantment::getRarity ( )

Returns an int constant indicating how rare this enchantment type is.

Definition at line 74 of file Enchantment.php.

◆ isCompatibleWith()

pocketmine\item\enchantment\Enchantment::isCompatibleWith ( Enchantment $other)

Returns whether this enchantment can be applied to the item along with the given enchantment.

Definition at line 88 of file Enchantment.php.


The documentation for this class was generated from the following file: