Typehinted block events API

This commit is contained in:
Dylan K. Taylor
2017-06-27 09:34:15 +01:00
parent 64f2e7587d
commit 276fccf4bb
7 changed files with 84 additions and 28 deletions

View File

@ -28,6 +28,9 @@ use pocketmine\event\Cancellable;
use pocketmine\item\Item;
use pocketmine\Player;
/**
* Called when a player destroys a block somewhere in the world.
*/
class BlockBreakEvent extends BlockEvent implements Cancellable{
public static $handlerList = null;
@ -42,30 +45,56 @@ class BlockBreakEvent extends BlockEvent implements Cancellable{
/** @var Item[] */
protected $blockDrops = [];
public function __construct(Player $player, Block $block, Item $item, $instaBreak = false){
$this->block = $block;
public function __construct(Player $player, Block $block, Item $item, bool $instaBreak = false){
parent::__construct($block);
$this->item = $item;
$this->player = $player;
$this->instaBreak = (bool) $instaBreak;
$this->blockDrops = $player->isSurvival() ? $block->getDrops($item) : [];
$this->instaBreak = $instaBreak;
if($player->isSurvival()){
$this->setDrops($block->getDrops($item));
}
}
public function getPlayer(){
/**
* Returns the player who is destroying the block.
* @return Player
*/
public function getPlayer() : Player{
return $this->player;
}
public function getItem(){
/**
* Returns the item used to destroy the block.
* @return Item
*/
public function getItem() : Item{
return $this->item;
}
public function getInstaBreak(){
/**
* Returns whether the block may be broken in less than the amount of time calculated. This is usually true for
* creative players.
*
* @return bool
*/
public function getInstaBreak() : bool{
return $this->instaBreak;
}
/**
* @param bool $instaBreak
*/
public function setInstaBreak(bool $instaBreak){
$this->instaBreak = $instaBreak;
}
/**
* @return Item[]
*/
public function getDrops(){
public function getDrops() : array{
return $this->blockDrops;
}
@ -73,13 +102,15 @@ class BlockBreakEvent extends BlockEvent implements Cancellable{
* @param Item[] $drops
*/
public function setDrops(array $drops){
$this->blockDrops = $drops;
$this->setDropsVariadic(...$drops);
}
/**
* @param bool $instaBreak
* Variadic hack for easy array member type enforcement.
*
* @param Item[] ...$drops
*/
public function setInstaBreak($instaBreak){
$this->instaBreak = (bool) $instaBreak;
public function setDropsVariadic(Item ...$drops){
$this->blockDrops = $drops;
}
}