Added StructureGrowEvent (#4354)

This event is currently fired for tree and bamboo growth. Its intended use is for any plant growth that affects multiple blocks at once.

TODO: We could explore using this for cacti and sugarcane?
This commit is contained in:
Colin
2021-08-25 15:05:30 +02:00
committed by GitHub
parent 6e68e99ec0
commit 4189fbdaef
8 changed files with 66 additions and 11 deletions

View File

@ -36,11 +36,11 @@ class BirchTree extends Tree{
$this->superBirch = $superBirch;
}
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random) : void{
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random, bool $callEvent = false) : void{
$this->treeHeight = $random->nextBoundedInt(3) + 5;
if($this->superBirch){
$this->treeHeight += 5;
}
parent::placeObject($world, $x, $y, $z, $random);
parent::placeObject($world, $x, $y, $z, $random, $callEvent);
}
}

View File

@ -33,8 +33,8 @@ class OakTree extends Tree{
parent::__construct(VanillaBlocks::OAK_LOG(), VanillaBlocks::OAK_LEAVES());
}
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random) : void{
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random, bool $callEvent = false) : void{
$this->treeHeight = $random->nextBoundedInt(3) + 4;
parent::placeObject($world, $x, $y, $z, $random);
parent::placeObject($world, $x, $y, $z, $random, $callEvent);
}
}

View File

@ -39,9 +39,9 @@ class SpruceTree extends Tree{
return $this->treeHeight - $random->nextBoundedInt(3);
}
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random) : void{
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random, bool $callEvent = false) : void{
$this->treeHeight = $random->nextBoundedInt(4) + 6;
parent::placeObject($world, $x, $y, $z, $random);
parent::placeObject($world, $x, $y, $z, $random, $callEvent);
}
protected function placeCanopy(int $x, int $y, int $z, Random $random, BlockTransaction $transaction) : void{

View File

@ -28,6 +28,7 @@ use pocketmine\block\Leaves;
use pocketmine\block\Sapling;
use pocketmine\block\utils\TreeType;
use pocketmine\block\VanillaBlocks;
use pocketmine\event\block\StructureGrowEvent;
use pocketmine\utils\Random;
use pocketmine\world\BlockTransaction;
use pocketmine\world\ChunkManager;
@ -51,10 +52,11 @@ abstract class Tree{
/**
* @param TreeType|null $type default oak
* @param bool $callEvent set this parameter to true to allow the calling of the BlockSproutEvent when the tree grows
*
* @throws \InvalidArgumentException
*/
public static function growTree(ChunkManager $world, int $x, int $y, int $z, Random $random, ?TreeType $type = null) : void{
public static function growTree(ChunkManager $world, int $x, int $y, int $z, Random $random, ?TreeType $type = null, bool $callEvent = false) : void{
/** @var null|Tree $tree */
$tree = null;
$type = $type ?? TreeType::OAK();
@ -78,7 +80,7 @@ abstract class Tree{
}
if($tree !== null and $tree->canPlaceObject($world, $x, $y, $z, $random)){
$tree->placeObject($world, $x, $y, $z, $random);
$tree->placeObject($world, $x, $y, $z, $random, $callEvent);
}
}
@ -100,11 +102,19 @@ abstract class Tree{
return true;
}
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random) : void{
public function placeObject(ChunkManager $world, int $x, int $y, int $z, Random $random, bool $callEvent = false) : void{
$transaction = new BlockTransaction($world);
$this->placeTrunk($x, $y, $z, $random, $this->generateChunkHeight($random), $transaction);
$this->placeCanopy($x, $y, $z, $random, $transaction);
if($callEvent){
$ev = new StructureGrowEvent($world->getBlockAt($x, $y, $z), $transaction);
$ev->call();
if($ev->isCancelled()){
return;
}
}
$transaction->apply(); //TODO: handle return value on failure
}