pocketmine\event\player\PlayerInteractEvent Class Reference

Inheritance diagram for pocketmine\event\player\PlayerInteractEvent:

Collaboration diagram for pocketmine\event\player\PlayerInteractEvent:

Public Member Functions
	__construct (Player $player, protected Item $item, protected Block $blockTouched, ?Vector3 $touchVector, protected Facing $blockFace, protected int $action=PlayerInteractEvent::RIGHT_CLICK_BLOCK)
	call ()
	getAction ()
	getBlock ()
	getEventName ()
	getFace ()
	getItem ()
	getPlayer ()
	getTouchVector ()
	isCancelled ()
	setUseBlock (bool $useBlock)
	setUseItem (bool $useItem)
	useBlock ()
	useItem ()

Static Public Member Functions
static	hasHandlers ()

Public Attributes
const	LEFT_CLICK_BLOCK = 0
const	RIGHT_CLICK_BLOCK = 1

Protected Attributes
string	$eventName = null
Player	$player
Vector3	$touchVector
bool	$useBlock = true
bool	$useItem = true

Detailed Description

Called when a player interacts or touches a block. This is called for both left click (start break) and right click (use).

Definition at line 38 of file PlayerInteractEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\player\PlayerInteractEvent::__construct	(	Player	$player,
		protected Item	$item,
		protected Block	$blockTouched,
		?Vector3	$touchVector,
		protected Facing	$blockFace,
		protected int	$action = PlayerInteractEvent::RIGHT_CLICK_BLOCK )

Definition at line 49 of file PlayerInteractEvent.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.

getAction()

pocketmine\event\player\PlayerInteractEvent::getAction

(

)

Definition at line 61 of file PlayerInteractEvent.php.

getBlock()

pocketmine\event\player\PlayerInteractEvent::getBlock

(

)

Definition at line 69 of file PlayerInteractEvent.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getFace()

pocketmine\event\player\PlayerInteractEvent::getFace

(

)

Definition at line 77 of file PlayerInteractEvent.php.

getItem()

pocketmine\event\player\PlayerInteractEvent::getItem

(

)

Definition at line 65 of file PlayerInteractEvent.php.

getPlayer()

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

inherited

Definition at line 35 of file PlayerEvent.php.

getTouchVector()

pocketmine\event\player\PlayerInteractEvent::getTouchVector

(

)

Definition at line 73 of file PlayerInteractEvent.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.

setUseBlock()

pocketmine\event\player\PlayerInteractEvent::setUseBlock

(

bool

$useBlock

)

Sets whether the block may react to the interaction. If false, doors, fence gates and trapdoors will not respond, containers will not open, etc.

Definition at line 103 of file PlayerInteractEvent.php.

setUseItem()

pocketmine\event\player\PlayerInteractEvent::setUseItem

(

bool

$useItem

)

Sets whether the used item may react to the interaction. If false, items such as spawn eggs will not activate. This does NOT prevent blocks from being placed - it makes the item behave as if the player is sneaking.

Definition at line 91 of file PlayerInteractEvent.php.

useBlock()

pocketmine\event\player\PlayerInteractEvent::useBlock

(

)

Returns whether the block may react to the interaction. If false, doors, fence gates and trapdoors will not respond, containers will not open, etc.

Definition at line 97 of file PlayerInteractEvent.php.

useItem()

pocketmine\event\player\PlayerInteractEvent::useItem

(

)

Returns whether the item may react to the interaction. If disabled, items such as spawn eggs will not activate. This does NOT prevent blocks from being placed - it makes the item behave as if the player is sneaking.

Definition at line 85 of file PlayerInteractEvent.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.

$touchVector

Vector3 pocketmine\event\player\PlayerInteractEvent::$touchVector

protected

Definition at line 44 of file PlayerInteractEvent.php.

$useBlock

bool pocketmine\event\player\PlayerInteractEvent::$useBlock = true

protected

Definition at line 47 of file PlayerInteractEvent.php.

$useItem

bool pocketmine\event\player\PlayerInteractEvent::$useItem = true

protected

Definition at line 46 of file PlayerInteractEvent.php.

LEFT_CLICK_BLOCK

const pocketmine\event\player\PlayerInteractEvent::LEFT_CLICK_BLOCK = 0

Definition at line 41 of file PlayerInteractEvent.php.

RIGHT_CLICK_BLOCK

const pocketmine\event\player\PlayerInteractEvent::RIGHT_CLICK_BLOCK = 1

Definition at line 42 of file PlayerInteractEvent.php.

---

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

• PlayerInteractEvent.php