pocketmine\event\player\PlayerItemEnchantEvent Class Reference

Inheritance diagram for pocketmine\event\player\PlayerItemEnchantEvent:

Collaboration diagram for pocketmine\event\player\PlayerItemEnchantEvent:

Public Member Functions
	__construct (Player $player, private readonly EnchantingTransaction $transaction, private readonly EnchantingOption $option, private readonly Item $inputItem, private readonly Item $outputItem, private readonly int $cost)
	call ()
	getCost ()
	getEventName ()
	getInputItem ()
	getOption ()
	getOutputItem ()
	getPlayer ()
	getTransaction ()
	isCancelled ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null
Player	$player

Detailed Description

Called when a player enchants an item using an enchanting table.

Definition at line 36 of file PlayerItemEnchantEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\player\PlayerItemEnchantEvent::__construct	(	Player	$player,
		private readonly EnchantingTransaction	$transaction,
		private readonly EnchantingOption	$option,
		private readonly Item	$inputItem,
		private readonly Item	$outputItem,
		private readonly int	$cost )

Definition at line 39 of file PlayerItemEnchantEvent.php.

Member Function Documentation

call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

getCost()

pocketmine\event\player\PlayerItemEnchantEvent::getCost

(

)

Returns the number of XP levels and lapis that will be subtracted after enchanting if the player is not in creative mode.

Definition at line 82 of file PlayerItemEnchantEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getInputItem()

pocketmine\event\player\PlayerItemEnchantEvent::getInputItem

(

)

Returns the item to be enchanted.

Definition at line 67 of file PlayerItemEnchantEvent.php.

getOption()

pocketmine\event\player\PlayerItemEnchantEvent::getOption

(

)

Returns the enchantment option used.

Definition at line 60 of file PlayerItemEnchantEvent.php.

getOutputItem()

pocketmine\event\player\PlayerItemEnchantEvent::getOutputItem

(

)

Returns the enchanted item.

Definition at line 74 of file PlayerItemEnchantEvent.php.

getPlayer()

pocketmine\event\player\PlayerEvent::getPlayer ( )

inherited

Definition at line 35 of file PlayerEvent.php.

getTransaction()

pocketmine\event\player\PlayerItemEnchantEvent::getTransaction

(

)

Returns the inventory transaction involved in this enchant event.

Definition at line 53 of file PlayerItemEnchantEvent.php.

hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

inherited

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

Member Data Documentation

$eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

$player

Player pocketmine\event\player\PlayerEvent::$player

protectedinherited

Definition at line 33 of file PlayerEvent.php.

---

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

• PlayerItemEnchantEvent.php