Tree Class Reference

Public Member Functions
	canPlaceObject (ChunkManager $level, $x, $y, $z, Random $random)
	placeObject (ChunkManager $level, $x, $y, $z, Random $random)

Static Public Member Functions
static	growTree (ChunkManager $level, $x, $y, $z, Random $random, $type=0, bool $noBigTree=true)

Data Fields
	$overridable
	$type = 0
	$trunkBlock = Block::LOG
	$leafBlock = Block::LEAVES
	$treeHeight = 7
	$leafType = 0

Protected Member Functions
	placeTrunk (ChunkManager $level, $x, $y, $z, Random $random, $trunkHeight)

Member Function Documentation

canPlaceObject()

canPlaceObject	(	ChunkManager	$level,
			$x,
			$y,
			$z,
		Random	$random
	)

Parameters

ChunkManager	$level
	$x
	$y
	$z
Random	$random

Returns

bool

                                                                                   {
        $radiusToCheck = 0;
        for($yy = 0; $yy < $this->treeHeight + 3; ++$yy){
            if($yy == 1 or $yy === $this->treeHeight){
                ++$radiusToCheck;
            }
            for($xx = -$radiusToCheck; $xx < ($radiusToCheck + 1); ++$xx){
                for($zz = -$radiusToCheck; $zz < ($radiusToCheck + 1); ++$zz){
                    if(!isset($this->overridable[$level->getBlockIdAt($x + $xx, $y + $yy, $z + $zz)])){
                        return false;
                    }
                }
            }
        }

        return true;
    }

growTree()

static growTree ( ChunkManager  $level,   $x,   $y,   $z, Random  $random,   $type = 0, bool  $noBigTree = true  )

static

Parameters

ChunkManager	$level
	$x
	$y
	$z
Random	$random
int	$type
bool	$noBigTree

                                                                                                                       {
        switch($type){
            case Sapling::SPRUCE:
                $tree = new SpruceTree();
                break;
            case Sapling::BIRCH:
                if($random->nextBoundedInt(39) === 0){
                    $tree = new BirchTree(true);
                }else{
                    $tree = new BirchTree();
                }
                break;
            case Sapling::JUNGLE:
                $tree = new JungleTree();
                break;
            case Sapling::ACACIA:
                $tree = new AcaciaTree();
                break;
            case Sapling::DARK_OAK:
                $tree = new DarkOakTree();
                break;
            case Sapling::OAK:
            default:
                if(!$noBigTree and $random->nextRange(0, 9) === 0){
                    $tree = new BigTree();
                }else{
                    $tree = new OakTree();
                }
                break;
        }
        if($tree->canPlaceObject($level, $x, $y, $z, $random)){
            $tree->placeObject($level, $x, $y, $z, $random);
        }
    }

placeObject()

placeObject	(	ChunkManager	$level,
			$x,
			$y,
			$z,
		Random	$random
	)

Parameters

ChunkManager	$level
	$x
	$y
	$z
Random	$random

                                                                                {

        $this->placeTrunk($level, $x, $y, $z, $random, $this->treeHeight - 1);

        for($yy = $y - 3 + $this->treeHeight; $yy <= $y + $this->treeHeight; ++$yy){
            $yOff = $yy - ($y + $this->treeHeight);
            $mid = (int) (1 - $yOff / 2);
            for($xx = $x - $mid; $xx <= $x + $mid; ++$xx){
                $xOff = abs($xx - $x);
                for($zz = $z - $mid; $zz <= $z + $mid; ++$zz){
                    $zOff = abs($zz - $z);
                    if($xOff === $mid and $zOff === $mid and ($yOff === 0 or $random->nextBoundedInt(2) === 0)){
                        continue;
                    }
                    if(!Block::$solid[$level->getBlockIdAt($xx, $yy, $zz)]){
                        $level->setBlockIdAt($xx, $yy, $zz, $this->leafBlock);
                        $level->setBlockDataAt($xx, $yy, $zz, $this->leafType);
                    }
                }
            }
        }
    }

placeTrunk()

placeTrunk ( ChunkManager  $level,   $x,   $y,   $z, Random  $random,   $trunkHeight  )

protected

Parameters

ChunkManager	$level
	$x
	$y
	$z
Random	$random
	$trunkHeight

                                                                                                {
        // The base dirt block
        $level->setBlockIdAt($x, $y - 1, $z, Block::DIRT);

        for($yy = 0; $yy < $trunkHeight; ++$yy){
            $blockId = $level->getBlockIdAt($x, $y + $yy, $z);
            if(isset($this->overridable[$blockId])){
                $level->setBlockIdAt($x, $y + $yy, $z, $this->trunkBlock);
                $level->setBlockDataAt($x, $y + $yy, $z, $this->type);
            }
        }
    }

Field Documentation

$leafBlock

$leafBlock = Block::LEAVES

$leafType

$leafType = 0

$overridable

$overridable

Initial value:

= [
        Block::AIR => true

$treeHeight

$treeHeight = 7

$trunkBlock

$trunkBlock = Block::LOG

$type

$type = 0

---

The documentation for this class was generated from the following file:

• src/pocketmine/level/generator/object/Tree.php