Separate use-item action from PlayerInteractEvent

This solves the age-old issue of PlayerInteractEvent firing twice when a player clicks a block with an item in the hand.

API changes:
- Removed PlayerInteractEvent constants LEFT_CLICK_AIR, RIGHT_CLICK_AIR and PHYSICAL.
- PlayerInteractEvent no longer fires when the player right-clicks the air.
- Added new event PlayerItemUseEvent.
This commit is contained in:
Dylan K. Taylor 2018-09-14 16:23:57 +01:00
parent b660bcdb65
commit db2567f965
3 changed files with 71 additions and 4 deletions

View File

@ -54,6 +54,7 @@ use pocketmine\event\player\PlayerGameModeChangeEvent;
use pocketmine\event\player\PlayerInteractEvent;
use pocketmine\event\player\PlayerItemConsumeEvent;
use pocketmine\event\player\PlayerItemHeldEvent;
use pocketmine\event\player\PlayerItemUseEvent;
use pocketmine\event\player\PlayerJoinEvent;
use pocketmine\event\player\PlayerJumpEvent;
use pocketmine\event\player\PlayerKickEvent;
@ -2013,7 +2014,7 @@ class Player extends Human implements CommandSender, ChunkLoader, IPlayer{
$directionVector = $this->getDirectionVector();
$item = $this->inventory->getItemInHand();
$ev = new PlayerInteractEvent($this, $item, null, $directionVector, 0, PlayerInteractEvent::RIGHT_CLICK_AIR);
$ev = new PlayerItemUseEvent($this, $item, $directionVector);
if($this->hasItemCooldown($item)){
$ev->setCancelled();
}

View File

@ -37,9 +37,6 @@ use pocketmine\Player;
class PlayerInteractEvent extends PlayerEvent implements Cancellable{
public const LEFT_CLICK_BLOCK = 0;
public const RIGHT_CLICK_BLOCK = 1;
public const LEFT_CLICK_AIR = 2;
public const RIGHT_CLICK_AIR = 3;
public const PHYSICAL = 4;
/** @var Block */
protected $blockTouched;

View File

@ -0,0 +1,69 @@
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\event\player;
use pocketmine\event\Cancellable;
use pocketmine\item\Item;
use pocketmine\math\Vector3;
use pocketmine\Player;
/**
* Called when a player uses its held item, for example when throwing a projectile.
*/
class PlayerItemUseEvent extends PlayerEvent implements Cancellable{
/** @var Item */
private $item;
/** @var Vector3 */
private $directionVector;
/**
* @param Player $player
* @param Item $item
* @param Vector3 $directionVector
*/
public function __construct(Player $player, Item $item, Vector3 $directionVector){
$this->player = $player;
$this->item = $item;
$this->directionVector = $directionVector;
}
/**
* Returns the item used.
*
* @return Item
*/
public function getItem() : Item{
return $this->item;
}
/**
* Returns the direction the player is aiming when activating this item. Used for projectile direction.
*
* @return Vector3
*/
public function getDirectionVector() : Vector3{
return $this->directionVector;
}
}