PocketMine-MP 5.17.1 git-df4ada81e5d74a14046f27cf44a37dcee69d657e
pocketmine\event\player\PlayerEnchantingOptionsRequestEvent Class Reference
+ Inheritance diagram for pocketmine\event\player\PlayerEnchantingOptionsRequestEvent:
+ Collaboration diagram for pocketmine\event\player\PlayerEnchantingOptionsRequestEvent:

Public Member Functions

 __construct (Player $player, private readonly EnchantInventory $inventory, private array $options)
 
 call ()
 
 getEventName ()
 
 getInventory ()
 
 getOptions ()
 
 getPlayer ()
 
 isCancelled ()
 
 setOptions (array $options)
 

Static Public Member Functions

static hasHandlers ()
 

Protected Attributes

string $eventName = null
 
Player $player
 

Detailed Description

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.

Definition at line 39 of file PlayerEnchantingOptionsRequestEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerEnchantingOptionsRequestEvent::__construct ( Player  $player,
private readonly EnchantInventory  $inventory,
private array  $options 
)
Parameters
EnchantingOption[]$options

Definition at line 45 of file PlayerEnchantingOptionsRequestEvent.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.

◆ getEventName()

pocketmine\event\Event::getEventName ( )
finalinherited

Definition at line 40 of file Event.php.

◆ getInventory()

pocketmine\event\player\PlayerEnchantingOptionsRequestEvent::getInventory ( )

Definition at line 53 of file PlayerEnchantingOptionsRequestEvent.php.

◆ getOptions()

pocketmine\event\player\PlayerEnchantingOptionsRequestEvent::getOptions ( )
Returns
EnchantingOption[]

Definition at line 60 of file PlayerEnchantingOptionsRequestEvent.php.

◆ getPlayer()

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

Definition at line 35 of file PlayerEvent.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.

◆ setOptions()

pocketmine\event\player\PlayerEnchantingOptionsRequestEvent::setOptions ( array  $options)
Parameters
EnchantingOption[]$options

Definition at line 67 of file PlayerEnchantingOptionsRequestEvent.php.

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: