diff --git a/src/event/entity/EntityExplodeEvent.php b/src/event/entity/EntityExplodeEvent.php index fc4e63bf1..fa69d2fbf 100644 --- a/src/event/entity/EntityExplodeEvent.php +++ b/src/event/entity/EntityExplodeEvent.php @@ -31,7 +31,11 @@ use pocketmine\utils\Utils; use pocketmine\world\Position; /** - * Called when a entity explodes + * Called when an entity explodes, after the explosion's impact has been calculated. + * No changes have been made to the world at this stage. + * + * @see ExplosionPrimeEvent + * * @phpstan-extends EntityEvent */ class EntityExplodeEvent extends EntityEvent implements Cancellable{ @@ -47,7 +51,8 @@ class EntityExplodeEvent extends EntityEvent implements Cancellable{ protected $yield; /** - * @param Block[] $blocks + * @param Block[] $blocks + * @param float $yield 0-100 */ public function __construct(Entity $entity, Position $position, array $blocks, float $yield){ $this->entity = $entity; @@ -64,6 +69,8 @@ class EntityExplodeEvent extends EntityEvent implements Cancellable{ } /** + * Returns a list of blocks destroyed by the explosion. + * * @return Block[] */ public function getBlockList() : array{ @@ -71,6 +78,8 @@ class EntityExplodeEvent extends EntityEvent implements Cancellable{ } /** + * Sets the blocks destroyed by the explosion. + * * @param Block[] $blocks */ public function setBlockList(array $blocks) : void{ @@ -78,10 +87,18 @@ class EntityExplodeEvent extends EntityEvent implements Cancellable{ $this->blocks = $blocks; } + /** + * Returns the percentage chance of drops from each block destroyed by the explosion. + * @return float 0-100 + */ public function getYield() : float{ return $this->yield; } + /** + * Sets the percentage chance of drops from each block destroyed by the explosion. + * @param float $yield 0-100 + */ public function setYield(float $yield) : void{ if($yield < 0.0 || $yield > 100.0){ throw new \InvalidArgumentException("Yield must be in range 0.0 - 100.0"); diff --git a/src/event/entity/ExplosionPrimeEvent.php b/src/event/entity/ExplosionPrimeEvent.php index 68bec6fa4..cffc44a34 100644 --- a/src/event/entity/ExplosionPrimeEvent.php +++ b/src/event/entity/ExplosionPrimeEvent.php @@ -28,7 +28,11 @@ use pocketmine\event\Cancellable; use pocketmine\event\CancellableTrait; /** - * Called when a entity decides to explode + * Called when an entity decides to explode, before the explosion's impact is calculated. + * This allows changing the force of the explosion and whether it will destroy blocks. + * + * @see EntityExplodeEvent + * * @phpstan-extends EntityEvent */ class ExplosionPrimeEvent extends EntityEvent implements Cancellable{