From aa7d55e21d88c1ea9593b43a1204ebf0ea7504b6 Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Sun, 19 Jan 2020 18:07:54 +0000 Subject: [PATCH] level/generator: populate missing return type information --- .../level/generator/biome/BiomeSelector.php | 3 ++ .../level/generator/noise/Noise.php | 2 ++ .../level/generator/object/BigTree.php | 9 ++++++ .../level/generator/object/BirchTree.php | 9 ++++++ .../level/generator/object/OakTree.php | 9 ++++++ src/pocketmine/level/generator/object/Ore.php | 8 +++++ .../level/generator/object/Pond.php | 6 ++++ .../level/generator/object/SpruceTree.php | 9 ++++++ .../level/generator/object/TallGrass.php | 9 ++++++ .../level/generator/object/Tree.php | 29 +++++++++++++++++++ .../level/generator/populator/Ore.php | 2 ++ .../level/generator/populator/Pond.php | 15 ++++++++++ .../level/generator/populator/TallGrass.php | 4 +++ .../level/generator/populator/Tree.php | 4 +++ 14 files changed, 118 insertions(+) diff --git a/src/pocketmine/level/generator/biome/BiomeSelector.php b/src/pocketmine/level/generator/biome/BiomeSelector.php index ee7a85811e..190877ba82 100644 --- a/src/pocketmine/level/generator/biome/BiomeSelector.php +++ b/src/pocketmine/level/generator/biome/BiomeSelector.php @@ -52,6 +52,9 @@ abstract class BiomeSelector{ */ abstract protected function lookup(float $temperature, float $rainfall) : int; + /** + * @return void + */ public function recalculate(){ $this->map = new \SplFixedArray(64 * 64); diff --git a/src/pocketmine/level/generator/noise/Noise.php b/src/pocketmine/level/generator/noise/Noise.php index 46a7f5059b..66d7818356 100644 --- a/src/pocketmine/level/generator/noise/Noise.php +++ b/src/pocketmine/level/generator/noise/Noise.php @@ -405,6 +405,8 @@ abstract class Noise{ * @param float $x * @param float $y * @param float $z + * + * @return void */ public function setOffset($x, $y, $z){ $this->offsetX = $x; diff --git a/src/pocketmine/level/generator/object/BigTree.php b/src/pocketmine/level/generator/object/BigTree.php index 4ccf9be564..63ad74e5b7 100644 --- a/src/pocketmine/level/generator/object/BigTree.php +++ b/src/pocketmine/level/generator/object/BigTree.php @@ -35,6 +35,15 @@ class BigTree extends Tree{ return false; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z, Random $random){ } diff --git a/src/pocketmine/level/generator/object/BirchTree.php b/src/pocketmine/level/generator/object/BirchTree.php index c4e8ef0237..7e75e230ac 100644 --- a/src/pocketmine/level/generator/object/BirchTree.php +++ b/src/pocketmine/level/generator/object/BirchTree.php @@ -40,6 +40,15 @@ class BirchTree extends Tree{ $this->superBirch = $superBirch; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z, Random $random){ $this->treeHeight = $random->nextBoundedInt(3) + 5; if($this->superBirch){ diff --git a/src/pocketmine/level/generator/object/OakTree.php b/src/pocketmine/level/generator/object/OakTree.php index 47865de7ee..ca3530d54e 100644 --- a/src/pocketmine/level/generator/object/OakTree.php +++ b/src/pocketmine/level/generator/object/OakTree.php @@ -36,6 +36,15 @@ class OakTree extends Tree{ $this->type = Wood::OAK; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z, Random $random){ $this->treeHeight = $random->nextBoundedInt(3) + 4; parent::placeObject($level, $x, $y, $z, $random); diff --git a/src/pocketmine/level/generator/object/Ore.php b/src/pocketmine/level/generator/object/Ore.php index ad1f5da3c0..711af8ca90 100644 --- a/src/pocketmine/level/generator/object/Ore.php +++ b/src/pocketmine/level/generator/object/Ore.php @@ -49,6 +49,14 @@ class Ore{ return $level->getBlockIdAt($x, $y, $z) === Block::STONE; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z){ $clusterSize = $this->type->clusterSize; $angle = $this->random->nextFloat() * M_PI; diff --git a/src/pocketmine/level/generator/object/Pond.php b/src/pocketmine/level/generator/object/Pond.php index 41af141f16..987fa74263 100644 --- a/src/pocketmine/level/generator/object/Pond.php +++ b/src/pocketmine/level/generator/object/Pond.php @@ -43,6 +43,12 @@ class Pond{ return false; } + /** + * @param ChunkManager $level + * @param Vector3 $pos + * + * @return void + */ public function placeObject(ChunkManager $level, Vector3 $pos){ } diff --git a/src/pocketmine/level/generator/object/SpruceTree.php b/src/pocketmine/level/generator/object/SpruceTree.php index 78a8578b87..e6ed799ce6 100644 --- a/src/pocketmine/level/generator/object/SpruceTree.php +++ b/src/pocketmine/level/generator/object/SpruceTree.php @@ -39,6 +39,15 @@ class SpruceTree extends Tree{ $this->treeHeight = 10; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z, Random $random){ $this->treeHeight = $random->nextBoundedInt(4) + 6; diff --git a/src/pocketmine/level/generator/object/TallGrass.php b/src/pocketmine/level/generator/object/TallGrass.php index 695b879ade..ef591a6172 100644 --- a/src/pocketmine/level/generator/object/TallGrass.php +++ b/src/pocketmine/level/generator/object/TallGrass.php @@ -31,6 +31,15 @@ use function count; class TallGrass{ + /** + * @param ChunkManager $level + * @param Vector3 $pos + * @param Random $random + * @param int $count + * @param int $radius + * + * @return void + */ public static function growGrass(ChunkManager $level, Vector3 $pos, Random $random, int $count = 15, int $radius = 10){ $arr = [ [Block::DANDELION, 0], diff --git a/src/pocketmine/level/generator/object/Tree.php b/src/pocketmine/level/generator/object/Tree.php index 30570feb6c..7431103861 100644 --- a/src/pocketmine/level/generator/object/Tree.php +++ b/src/pocketmine/level/generator/object/Tree.php @@ -49,6 +49,16 @@ abstract class Tree{ /** @var int */ public $treeHeight = 7; + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * @param int $type + * + * @return void + */ public static function growTree(ChunkManager $level, int $x, int $y, int $z, Random $random, int $type = 0){ switch($type){ case Sapling::SPRUCE: @@ -100,6 +110,15 @@ abstract class Tree{ return true; } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * + * @return void + */ public function placeObject(ChunkManager $level, int $x, int $y, int $z, Random $random){ $this->placeTrunk($level, $x, $y, $z, $random, $this->treeHeight - 1); @@ -123,6 +142,16 @@ abstract class Tree{ } } + /** + * @param ChunkManager $level + * @param int $x + * @param int $y + * @param int $z + * @param Random $random + * @param int $trunkHeight + * + * @return void + */ protected function placeTrunk(ChunkManager $level, int $x, int $y, int $z, Random $random, int $trunkHeight){ // The base dirt block $level->setBlockIdAt($x, $y - 1, $z, Block::DIRT); diff --git a/src/pocketmine/level/generator/populator/Ore.php b/src/pocketmine/level/generator/populator/Ore.php index a5b472fa51..a2d962c17b 100644 --- a/src/pocketmine/level/generator/populator/Ore.php +++ b/src/pocketmine/level/generator/populator/Ore.php @@ -48,6 +48,8 @@ class Ore extends Populator{ /** * @param OreType[] $types + * + * @return void */ public function setOreTypes(array $types){ $this->oreTypes = $types; diff --git a/src/pocketmine/level/generator/populator/Pond.php b/src/pocketmine/level/generator/populator/Pond.php index 48b40a5e86..4cac529730 100644 --- a/src/pocketmine/level/generator/populator/Pond.php +++ b/src/pocketmine/level/generator/populator/Pond.php @@ -49,14 +49,29 @@ class Pond extends Populator{ } } + /** + * @param int $waterOdd + * + * @return void + */ public function setWaterOdd(int $waterOdd){ $this->waterOdd = $waterOdd; } + /** + * @param int $lavaOdd + * + * @return void + */ public function setLavaOdd(int $lavaOdd){ $this->lavaOdd = $lavaOdd; } + /** + * @param int $lavaSurfaceOdd + * + * @return void + */ public function setLavaSurfaceOdd(int $lavaSurfaceOdd){ $this->lavaSurfaceOdd = $lavaSurfaceOdd; } diff --git a/src/pocketmine/level/generator/populator/TallGrass.php b/src/pocketmine/level/generator/populator/TallGrass.php index 5c110ead92..020fb9a114 100644 --- a/src/pocketmine/level/generator/populator/TallGrass.php +++ b/src/pocketmine/level/generator/populator/TallGrass.php @@ -37,6 +37,8 @@ class TallGrass extends Populator{ /** * @param int $amount + * + * @return void */ public function setRandomAmount($amount){ $this->randomAmount = $amount; @@ -44,6 +46,8 @@ class TallGrass extends Populator{ /** * @param int $amount + * + * @return void */ public function setBaseAmount($amount){ $this->baseAmount = $amount; diff --git a/src/pocketmine/level/generator/populator/Tree.php b/src/pocketmine/level/generator/populator/Tree.php index 93763c8882..c5a44fad7c 100644 --- a/src/pocketmine/level/generator/populator/Tree.php +++ b/src/pocketmine/level/generator/populator/Tree.php @@ -49,6 +49,8 @@ class Tree extends Populator{ /** * @param int $amount + * + * @return void */ public function setRandomAmount($amount){ $this->randomAmount = $amount; @@ -56,6 +58,8 @@ class Tree extends Populator{ /** * @param int $amount + * + * @return void */ public function setBaseAmount($amount){ $this->baseAmount = $amount;