Implement firework rocket & firework star (#5455)

Co-authored-by: Dylan T <[email protected]>
Co-authored-by: ipad54 <[email protected]>

Author: 3 people

src/data/bedrock/FireworkRocketTypeIdMap.php

@@ -0,0 +1,45 @@
+<?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\data\bedrock;
+
+use pocketmine\item\FireworkRocketType;
+use pocketmine\utils\SingletonTrait;
+
+final class FireworkRocketTypeIdMap{
+	use SingletonTrait;
+	/** @phpstan-use IntSaveIdMapTrait<FireworkRocketType> */
+	use IntSaveIdMapTrait;
+
+	private function __construct(){
+		foreach(FireworkRocketType::cases() as $case){
+			$this->register(match($case){
+				FireworkRocketType::SMALL_BALL => FireworkRocketTypeIds::SMALL_BALL,
+				FireworkRocketType::LARGE_BALL => FireworkRocketTypeIds::LARGE_BALL,
+				FireworkRocketType::STAR => FireworkRocketTypeIds::STAR,
+				FireworkRocketType::CREEPER => FireworkRocketTypeIds::CREEPER,
+				FireworkRocketType::BURST => FireworkRocketTypeIds::BURST,
+			}, $case);
+		}
+	}
+}

src/data/bedrock/FireworkRocketTypeIds.php

@@ -0,0 +1,32 @@
+<?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\data\bedrock;
+
+final class FireworkRocketTypeIds{
+	public const SMALL_BALL = 0;
+	public const LARGE_BALL = 1;
+	public const STAR = 2;
+	public const CREEPER = 3;
+	public const BURST = 4;
+}

src/data/bedrock/item/ItemSerializerDeserializerRegistrar.php

@@ -40,6 +40,7 @@
 use pocketmine\data\bedrock\SuspiciousStewTypeIdMap;
 use pocketmine\item\Banner;
 use pocketmine\item\Dye;
+use pocketmine\item\FireworkStar;
 use pocketmine\item\GoatHorn;
 use pocketmine\item\Item;
 use pocketmine\item\Medicine;
@@ -246,6 +247,7 @@ private function register1to1ItemMappings() : void{
 		$this->map1to1Item(Ids::EYE_ARMOR_TRIM_SMITHING_TEMPLATE, Items::EYE_ARMOR_TRIM_SMITHING_TEMPLATE());
 		$this->map1to1Item(Ids::FEATHER, Items::FEATHER());
 		$this->map1to1Item(Ids::FERMENTED_SPIDER_EYE, Items::FERMENTED_SPIDER_EYE());
+		$this->map1to1Item(Ids::FIREWORK_ROCKET, Items::FIREWORK_ROCKET());
 		$this->map1to1Item(Ids::FIRE_CHARGE, Items::FIRE_CHARGE());
 		$this->map1to1Item(Ids::FISHING_ROD, Items::FISHING_ROD());
 		$this->map1to1Item(Ids::FLINT, Items::FLINT());
@@ -501,6 +503,14 @@ function(Bed $block, int $meta) : void{
 	 * in a unified manner.
 	 */
 	private function register1to1ItemWithMetaMappings() : void{
+		$this->map1to1ItemWithMeta(
+			Ids::FIREWORK_STAR,
+			Items::FIREWORK_STAR(),
+			function(FireworkStar $item, int $meta) : void{
+				// Colors will be defined by CompoundTag deserialization.
+			},
+			fn(FireworkStar $item) => DyeColorIdMap::getInstance()->toInvertedId($item->getExplosion()->getFlashColor())
+		);
 		$this->map1to1ItemWithMeta(
 			Ids::GOAT_HORN,
 			Items::GOAT_HORN(),

src/entity/animation/FireworkParticlesAnimation.php

@@ -0,0 +1,41 @@
+<?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\entity\animation;
+
+use pocketmine\entity\object\FireworkRocket;
+use pocketmine\network\mcpe\protocol\ActorEventPacket;
+use pocketmine\network\mcpe\protocol\types\ActorEvent;
+
+final class FireworkParticlesAnimation implements Animation{
+
+	public function __construct(
+		private FireworkRocket $entity
+	){}
+
+	public function encode() : array{
+		return [
+			ActorEventPacket::create($this->entity->getId(), ActorEvent::FIREWORK_PARTICLES, 0)
+		];
+	}
+}

src/entity/object/FireworkRocket.php

@@ -0,0 +1,204 @@
+<?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\entity\object;
+
+use pocketmine\entity\animation\FireworkParticlesAnimation;
+use pocketmine\entity\Entity;
+use pocketmine\entity\EntitySizeInfo;
+use pocketmine\entity\Explosive;
+use pocketmine\entity\Living;
+use pocketmine\entity\Location;
+use pocketmine\entity\NeverSavedWithChunkEntity;
+use pocketmine\event\entity\EntityDamageByEntityEvent;
+use pocketmine\event\entity\EntityDamageEvent;
+use pocketmine\item\FireworkRocket as FireworkItem;
+use pocketmine\item\FireworkRocketExplosion;
+use pocketmine\math\VoxelRayTrace;
+use pocketmine\nbt\tag\CompoundTag;
+use pocketmine\nbt\tag\ListTag;
+use pocketmine\network\mcpe\protocol\types\CacheableNbt;
+use pocketmine\network\mcpe\protocol\types\entity\EntityIds;
+use pocketmine\network\mcpe\protocol\types\entity\EntityMetadataCollection;
+use pocketmine\network\mcpe\protocol\types\entity\EntityMetadataProperties;
+use pocketmine\utils\Utils;
+use pocketmine\world\sound\FireworkCrackleSound;
+use pocketmine\world\sound\FireworkLaunchSound;
+use function count;
+use function sqrt;
+
+class FireworkRocket extends Entity implements Explosive, NeverSavedWithChunkEntity{
+
+	public static function getNetworkTypeId() : string{ return EntityIds::FIREWORKS_ROCKET; }
+
+	protected int $maxFlightTimeTicks;
+
+	/** @var FireworkRocketExplosion[] */
+	protected array $explosions = [];
+
+	/**
+	 * @param FireworkRocketExplosion[] $explosions
+	 */
+	public function __construct(Location $location, int $maxFlightTimeTicks, array $explosions, ?CompoundTag $nbt = null){
+		if($maxFlightTimeTicks < 0){
+			throw new \InvalidArgumentException("Life ticks cannot be negative");
+		}
+		$this->maxFlightTimeTicks = $maxFlightTimeTicks;
+		$this->setExplosions($explosions);
+
+		parent::__construct($location, $nbt);
+	}
+
+	protected function getInitialSizeInfo() : EntitySizeInfo{ return new EntitySizeInfo(0.25, 0.25); }
+
+	protected function getInitialDragMultiplier() : float{ return 0.0; }
+
+	protected function getInitialGravity() : float{ return 0.0; }
+
+	/**
+	 * Returns the total number of ticks the firework will fly for before it explodes.
+	 */
+	public function getMaxFlightTimeTicks() : int{
+		return $this->maxFlightTimeTicks;
+	}
+
+	/**
+	 * Sets the total number of ticks the firework will fly for before it explodes.
+	 *
+	 * @return $this
+	 */
+	public function setMaxFlightTimeTicks(int $maxFlightTimeTicks) : self{
+		if($maxFlightTimeTicks < 0){
+			throw new \InvalidArgumentException("Max flight time ticks cannot be negative");
+		}
+		$this->maxFlightTimeTicks = $maxFlightTimeTicks;
+		return $this;
+	}
+
+	/**
+	 * @return FireworkRocketExplosion[]
+	 */
+	public function getExplosions() : array{
+		return $this->explosions;
+	}
+
+	/**
+	 * @param FireworkRocketExplosion[] $explosions
+	 *
+	 * @return $this
+	 */
+	public function setExplosions(array $explosions) : self{
+		Utils::validateArrayValueType($explosions, function(FireworkRocketExplosion $_) : void{});
+		$this->explosions = $explosions;
+		return $this;
+	}
+
+	protected function onFirstUpdate(int $currentTick) : void{
+		parent::onFirstUpdate($currentTick);
+
+		$this->broadcastSound(new FireworkLaunchSound());
+	}
+
+	protected function entityBaseTick(int $tickDiff = 1) : bool{
+		$hasUpdate = parent::entityBaseTick($tickDiff);
+
+		if(!$this->isFlaggedForDespawn()){
+			//Don't keep accelerating long-lived fireworks - this gets very rapidly out of control and makes the server
+			//die. Vanilla fireworks will only live for about 52 ticks maximum anyway, so this only makes sure plugin
+			//created fireworks don't murder the server
+			if($this->ticksLived < 60){
+				$this->addMotion($this->motion->x * 0.15, 0.04, $this->motion->z * 0.15);
+			}
+
+			if($this->ticksLived >= $this->maxFlightTimeTicks){
+				$this->flagForDespawn();
+				$this->explode();
+			}
+		}
+
+		return $hasUpdate;
+	}
+
+	public function explode() : void{
+		if(($explosionCount = count($this->explosions)) !== 0){
+			$this->broadcastAnimation(new FireworkParticlesAnimation($this));
+			foreach($this->explosions as $explosion){
+				$this->broadcastSound($explosion->getType()->getExplosionSound());
+				if($explosion->willTwinkle()){
+					$this->broadcastSound(new FireworkCrackleSound());
+				}
+			}
+
+			$force = ($explosionCount * 2) + 5;
+			$world = $this->getWorld();
+			foreach($world->getCollidingEntities($this->getBoundingBox()->expandedCopy(5, 5, 5), $this) as $entity){
+				if(!$entity instanceof Living){
+					continue;
+				}
+
+				$position = $entity->getPosition();
+				$distance = $position->distanceSquared($this->location);
+				if($distance > 25){
+					continue;
+				}
+
+				//cast two rays - one to the entity's feet and another to halfway up its body (according to Java, anyway)
+				//this seems like it'd miss some cases but who am I to argue with vanilla logic :>
+				$height = $entity->getBoundingBox()->getYLength();
+				for($i = 0; $i < 2; $i++){
+					$target = $position->add(0, 0.5 * $i * $height, 0);
+					foreach(VoxelRayTrace::betweenPoints($this->location, $target) as $blockPos){
+						if($world->getBlock($blockPos)->calculateIntercept($this->location, $target) !== null){
+							continue 2; //obstruction, try another path
+						}
+					}
+
+					//no obstruction
+					$damage = $force * sqrt((5 - $position->distance($this->location)) / 5);
+					$ev = new EntityDamageByEntityEvent($this, $entity, EntityDamageEvent::CAUSE_ENTITY_EXPLOSION, $damage);
+					$entity->attack($ev);
+					break;
+				}
+			}
+		}
+	}
+
+	public function canBeCollidedWith() : bool{
+		return false;
+	}
+
+	protected function syncNetworkData(EntityMetadataCollection $properties) : void{
+		parent::syncNetworkData($properties);
+
+		$explosions = new ListTag();
+		foreach($this->explosions as $explosion){
+			$explosions->push($explosion->toCompoundTag());
+		}
+		$fireworksData = CompoundTag::create()
+			->setTag(FireworkItem::TAG_FIREWORK_DATA, CompoundTag::create()
+				->setTag(FireworkItem::TAG_EXPLOSIONS, $explosions)
+			);
+
+		$properties->setCompoundTag(EntityMetadataProperties::FIREWORK_ITEM, new CacheableNbt($fireworksData));
+	}
+}

src/event/player/PlayerDeathEvent.php

@@ -26,6 +26,7 @@
 use pocketmine\block\BlockTypeIds;
 use pocketmine\entity\Living;
 use pocketmine\entity\object\FallingBlock;
+use pocketmine\entity\object\FireworkRocket;
 use pocketmine\entity\projectile\Trident;
 use pocketmine\event\entity\EntityDamageByBlockEvent;
 use pocketmine\event\entity\EntityDamageByChildEntityEvent;
@@ -164,7 +165,9 @@ public static function deriveMessage(string $name, ?EntityDamageEvent $deathCaus
 			case EntityDamageEvent::CAUSE_ENTITY_EXPLOSION:
 				if($deathCause instanceof EntityDamageByEntityEvent){
 					$e = $deathCause->getDamager();
-					if($e instanceof Living){
+					if($e instanceof FireworkRocket){
+						return KnownTranslationFactory::death_attack_fireworks($name);
+					}elseif($e instanceof Living){
 						return KnownTranslationFactory::death_attack_explosion_player($name, $e->getDisplayName());
 					}
 				}