PlayerInteractEvent Class Reference

Public Member Functions
	__construct (Player $player, Item $item, Vector3 $block, $face, $action=PlayerInteractEvent::RIGHT_CLICK_BLOCK)
	getAction ()
	getItem ()
	getBlock ()
	getTouchVector ()
	getFace ()
Public Member Functions inherited from PlayerEvent
	getPlayer ()
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()
Public Member Functions inherited from Cancellable
	isCancelled ()
	setCancelled ($forceCancel=false)

Data Fields
const	LEFT_CLICK_BLOCK = 0
const	RIGHT_CLICK_BLOCK = 1
const	LEFT_CLICK_AIR = 2
const	RIGHT_CLICK_AIR = 3
const	PHYSICAL = 4

Static Public Attributes
static	$handlerList = null

Protected Attributes
	$blockTouched
	$touchVector
	$blockFace
	$item
	$action
Protected Attributes inherited from PlayerEvent
	$player
Protected Attributes inherited from Event
	$eventName = null

Detailed Description

Called when a player interacts or touches a block (including air?)

Constructor & Destructor Documentation

__construct()

__construct	(	Player	$player,
		Item	$item,
		Vector3	$block,
			$face,
			$action = PlayerInteractEvent::RIGHT_CLICK_BLOCK
	)

PlayerInteractEvent constructor.

Parameters

Player	$player
Item	$item
Vector3	$block
	$face
int	$action

                                                                                                                                  {
        if($block instanceof Block){
            $this->blockTouched = $block;
            $this->touchVector = new Vector3(0, 0, 0);
        }else{
            $this->touchVector = $block;
            $this->blockTouched = Block::get(0, 0, new Position(0, 0, 0, $player->level));
        }
        $this->player = $player;
        $this->item = $item;
        $this->blockFace = (int) $face;
        $this->action = (int) $action;
    }

Member Function Documentation

getAction()

getAction

(

)

Returns

int

                               {
        return $this->action;
    }

getBlock()

getBlock

(

)

Returns

Block

                              {
        return $this->blockTouched;
    }

getFace()

getFace

(

)

Returns

int

                             {
        return $this->blockFace;
    }

getItem()

getItem

(

)

Returns

Item

                             {
        return $this->item;
    }

getTouchVector()

getTouchVector

(

)

Returns

Vector3

                                    {
        return $this->touchVector;
    }

Field Documentation

$action

$action

protected

$blockFace

$blockFace

protected

$blockTouched

$blockTouched

protected

$handlerList

$handlerList = null

static

$item

$item

protected

$touchVector

$touchVector

protected

LEFT_CLICK_AIR

const LEFT_CLICK_AIR = 2

LEFT_CLICK_BLOCK

const LEFT_CLICK_BLOCK = 0

PHYSICAL

const PHYSICAL = 4

RIGHT_CLICK_AIR

const RIGHT_CLICK_AIR = 3

RIGHT_CLICK_BLOCK

const RIGHT_CLICK_BLOCK = 1

---

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

• src/pocketmine/event/player/PlayerInteractEvent.php