MobSpawner Class Reference

Public Member Functions
	__construct (Level $level, CompoundTag $nbt)
	getEntityId ()
	setEntityId (int $id)
	getSpawnCount ()
	setSpawnCount (int $value)
	getSpawnRange ()
	setSpawnRange (int $value)
	getMinSpawnDelay ()
	setMinSpawnDelay (int $value)
	getMaxSpawnDelay ()
	setMaxSpawnDelay (int $value)
	getDelay ()
	setDelay (int $value)
	getName ()
	canUpdate ()
	onUpdate ()
	getSpawnCompound ()
Public Member Functions inherited from Spawnable
	spawnTo (Player $player)
	__construct (Level $level, CompoundTag $nbt)
	spawnToAll ()
	getSpawnCompound ()
	updateCompoundTag (CompoundTag $nbt, Player $player)
Public Member Functions inherited from Tile
	getSaveId ()
	__construct (Level $level, CompoundTag $nbt)
	getId ()
	saveNBT ()
	getBlock ()
	onUpdate ()
	scheduleUpdate ()
	__destruct ()
	close ()
	getName ()
Public Member Functions inherited from Position
	__construct ($x=0, $y=0, $z=0, Level $level=null)
	asPosition ()
	add ($x, $y=0, $z=0)
	getLevel ()
	setLevel (Level $level=null)
	isValid ()
	getSide ($side, $step=1)
	__toString ()
	setComponents ($x, $y, $z)
	fromObjectAdd (Vector3 $pos, $x, $y, $z)
Public Member Functions inherited from Vector3
	__construct ($x=0, $y=0, $z=0)
	getX ()
	getY ()
	getZ ()
	getFloorX ()
	getFloorY ()
	getFloorZ ()
	getRight ()
	getUp ()
	getForward ()
	getSouth ()
	getWest ()
	add ($x, $y=0, $z=0)
	subtract ($x=0, $y=0, $z=0)
	multiply ($number)
	divide ($number)
	ceil ()
	floor ()
	round ()
	abs ()
	getSide ($side, $step=1)
	asVector3 ()
	distance (Vector3 $pos)
	distanceSquared (Vector3 $pos)
	maxPlainDistance ($x=0, $z=0)
	length ()
	lengthSquared ()
	normalize ()
	dot (Vector3 $v)
	cross (Vector3 $v)
	equals (Vector3 $v)
	getIntermediateWithXValue (Vector3 $v, $x)
	getIntermediateWithYValue (Vector3 $v, $y)
	getIntermediateWithZValue (Vector3 $v, $z)
	setComponents ($x, $y, $z)
	fromObjectAdd (Vector3 $pos, $x, $y, $z)
	__toString ()

Additional Inherited Members
Static Public Member Functions inherited from Tile
static	init ()
static	createTile ($type, Level $level, CompoundTag $nbt,... $args)
static	registerTile ($className)
Static Public Member Functions inherited from Position
static	fromObject (Vector3 $pos, Level $level=null)
Static Public Member Functions inherited from Vector3
static	getOppositeSide ($side)
static	createRandomDirection (Random $random)
Data Fields inherited from Tile
const	BREWING_STAND = "BrewingStand"
const	CHEST = "Chest"
const	DL_DETECTOR = "DayLightDetector"
const	ENCHANT_TABLE = "EnchantTable"
const	FLOWER_POT = "FlowerPot"
const	FURNACE = "Furnace"
const	MOB_SPAWNER = "MobSpawner"
const	SIGN = "Sign"
const	SKULL = "Skull"
const	ITEM_FRAME = "ItemFrame"
const	DISPENSER = "Dispenser"
const	DROPPER = "Dropper"
const	CAULDRON = "Cauldron"
const	HOPPER = "Hopper"
const	BEACON = "Beacon"
const	ENDER_CHEST = "EnderChest"
const	BED = "Bed"
const	DAY_LIGHT_DETECTOR = "DLDetector"
	$chunk
	$name
	$id
	$x
	$y
	$z
	$attach
	$metadata
	$closed = false
	$namedtag
	$tickTimer
Data Fields inherited from Position
	$level = null
Data Fields inherited from Vector3
const	SIDE_DOWN = 0
const	SIDE_UP = 1
const	SIDE_NORTH = 2
const	SIDE_SOUTH = 3
const	SIDE_WEST = 4
const	SIDE_EAST = 5
	$x
	$y
	$z
Static Public Attributes inherited from Tile
static	$tileCount = 1
Protected Member Functions inherited from Spawnable
	onChanged ()
Protected Attributes inherited from Tile
	$lastUpdate
	$server
	$timings

Constructor & Destructor Documentation

__construct()

__construct	(	Level	$level,
		CompoundTag	$nbt
	)

MobSpawner constructor.

Parameters

Level	$level
CompoundTag	$nbt

                                                               {
        if(!isset($nbt->EntityId) or !($nbt->EntityId instanceof IntTag)){
            $nbt->EntityId = new IntTag("EntityId", 0);
        }
        if(!isset($nbt->SpawnCount) or !($nbt->SpawnCount instanceof IntTag)){
            $nbt->SpawnCount = new IntTag("SpawnCount", 4);
        }
        if(!isset($nbt->SpawnRange) or !($nbt->SpawnRange instanceof IntTag)){
            $nbt->SpawnRange = new IntTag("SpawnRange", 4);
        }
        if(!isset($nbt->MinSpawnDelay) or !($nbt->MinSpawnDelay instanceof IntTag)){
            $nbt->MinSpawnDelay = new IntTag("MinSpawnDelay", 200);
        }
        if(!isset($nbt->MaxSpawnDelay) or !($nbt->MaxSpawnDelay instanceof IntTag)){
            $nbt->MaxSpawnDelay = new IntTag("MaxSpawnDelay", 799);
        }
        if(!isset($nbt->Delay) or !($nbt->Delay instanceof IntTag)){
            $nbt->Delay = new IntTag("Delay", mt_rand($nbt->MinSpawnDelay->getValue(), $nbt->MaxSpawnDelay->getValue()));
        }
        parent::__construct($level, $nbt);
        if($this->getEntityId() > 0){
            $this->scheduleUpdate();
        }
    }

Member Function Documentation

canUpdate()

canUpdate

(

)

Returns

bool

                                : bool{
        if($this->getEntityId() === 0) return false;
        $hasPlayer = false;
        $count = 0;
        foreach($this->getLevel()->getEntities() as $e){
            if($e instanceof Player){
                if($e->distance($this->getBlock()) <= 15) $hasPlayer = true;
            }
            if($e::NETWORK_ID == $this->getEntityId()){
                $count++;
            }
        }
        if($hasPlayer and $count < 15){ // Spawn limit = 15
            return true;
        }
        return false;
    }

getDelay()

getDelay

(

)

Returns

null

                              {
        return $this->namedtag["Delay"];
    }

getEntityId()

getEntityId

(

)

Returns

null

                                 {
        return $this->namedtag["EntityId"];
    }

getMaxSpawnDelay()

getMaxSpawnDelay

(

)

Returns

null

                                      {
        return $this->namedtag["MaxSpawnDelay"];
    }

getMinSpawnDelay()

getMinSpawnDelay

(

)

Returns

null

                                      {
        return $this->namedtag["MinSpawnDelay"];
    }

getName()

getName

(

)

Returns

string

                              : string{
        return "Monster Spawner";
    }

getSpawnCompound()

getSpawnCompound

(

)

Returns

CompoundTag

                                      {
        $c = new CompoundTag("", [
            new StringTag("id", Tile::MOB_SPAWNER),
            new IntTag("x", (int) $this->x),
            new IntTag("y", (int) $this->y),
            new IntTag("z", (int) $this->z),
            new IntTag("EntityId", (int) $this->getEntityId())
        ]);

        return $c;
    }

getSpawnCount()

getSpawnCount

(

)

Returns

null

                                   {
        return $this->namedtag["SpawnCount"];
    }

getSpawnRange()

getSpawnRange

(

)

Returns

null

                                   {
        return $this->namedtag["SpawnRange"];
    }

onUpdate()

onUpdate

(

)

Returns

bool

                              {
        if($this->closed === true){
            return false;
        }

        $this->timings->startTiming();

        if(!($this->chunk instanceof Chunk)){
            return false;
        }
        if($this->canUpdate()){
            if($this->getDelay() <= 0){
                $success = 0;
                for($i = 0; $i < $this->getSpawnCount(); $i++){
                    $pos = $this->add(mt_rand() / mt_getrandmax() * $this->getSpawnRange(), mt_rand(-1, 1), mt_rand() / mt_getrandmax() * $this->getSpawnRange());
                    $target = $this->getLevel()->getBlock($pos);
                    $ground = $target->getSide(Vector3::SIDE_DOWN);
                    if($target->getId() == Item::AIR && $ground->isTopFacingSurfaceSolid()){
                        $success++;
                        $this->getLevel()->getServer()->getPluginManager()->callEvent($ev = new EntityGenerateEvent($pos, $this->getEntityId(), EntityGenerateEvent::CAUSE_MOB_SPAWNER));
                        if(!$ev->isCancelled()){
                            $nbt = new CompoundTag("", [
                                "Pos" => new ListTag("Pos", [
                                    new DoubleTag("", $pos->x),
                                    new DoubleTag("", $pos->y),
                                    new DoubleTag("", $pos->z)
                                ]),
                                "Motion" => new ListTag("Motion", [
                                    new DoubleTag("", 0),
                                    new DoubleTag("", 0),
                                    new DoubleTag("", 0)
                                ]),
                                "Rotation" => new ListTag("Rotation", [
                                    new FloatTag("", mt_rand() / mt_getrandmax() * 360),
                                    new FloatTag("", 0)
                                ]),
                            ]);
                            $entity = Entity::createEntity($this->getEntityId(), $this->getLevel(), $nbt);
                            $entity->spawnToAll();
                        }
                    }
                }
                if($success > 0){
                    $this->setDelay(mt_rand($this->getMinSpawnDelay(), $this->getMaxSpawnDelay()));
                }
            }else{
                $this->setDelay($this->getDelay() - 1);
            }
        }

        $this->timings->stopTiming();

        return true;
    }

setDelay()

setDelay

(

int

$value

)

Parameters

int

$value

                                        {
        $this->namedtag->Delay->setValue($value);
    }

setEntityId()

setEntityId

(

int

$id

)

Parameters

int

$id

                                        {
        $this->namedtag->EntityId->setValue($id);
        $this->onChanged();
        $this->scheduleUpdate();
    }

setMaxSpawnDelay()

setMaxSpawnDelay

(

int

$value

)

Parameters

int

$value

                                                {
        $this->namedtag->MaxSpawnDelay->setValue($value);
    }

setMinSpawnDelay()

setMinSpawnDelay

(

int

$value

)

Parameters

int

$value

                                                {
        $this->namedtag->MinSpawnDelay->setValue($value);
    }

setSpawnCount()

setSpawnCount

(

int

$value

)

Parameters

int

$value

                                             {
        $this->namedtag->SpawnCount->setValue($value);
    }

setSpawnRange()

setSpawnRange

(

int

$value

)

Parameters

int

$value

                                             {
        $this->namedtag->SpawnRange->setValue($value);
    }

---

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

• src/pocketmine/tile/MobSpawner.php