Cauldron Class Reference

Public Member Functions
	__construct (Level $level, CompoundTag $nbt)
	getPotionId ()
	setPotionId ($potionId)
	hasPotion ()
	getSplashPotion ()
	setSplashPotion ($bool)
	getCustomColor ()
	getCustomColorRed ()
	getCustomColorGreen ()
	getCustomColorBlue ()
	isCustomColor ()
	setCustomColor ($r, $g=0xff, $b=0xff)
	clearCustomColor ()
	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
	)

Cauldron constructor.

Parameters

Level	$level
CompoundTag	$nbt

                                                               {
        if(!isset($nbt->PotionId) or !($nbt->PotionId instanceof ShortTag)){
            $nbt->PotionId = new ShortTag("PotionId", 0xffff);
        }
        if(!isset($nbt->SplashPotion) or !($nbt->SplashPotion instanceof ByteTag)){
            $nbt->SplashPotion = new ByteTag("SplashPotion", 0);
        }
        if(!isset($nbt->Items) or !($nbt->Items instanceof ListTag)){
            $nbt->Items = new ListTag("Items", []);
        }
        parent::__construct($level, $nbt);
    }

Member Function Documentation

clearCustomColor()

clearCustomColor

(

)

                                      {
        if(isset($this->namedtag->CustomColor)){
            unset($this->namedtag->CustomColor);
        }
        $this->onChanged();
    }

getCustomColor()

getCustomColor

(

)

Returns

null|Color

                                    {//
        if($this->isCustomColor()){
            $color = $this->namedtag["CustomColor"];
            $green = ($color >> 8) & 0xff;
            $red = ($color >> 16) & 0xff;
            $blue = ($color) & 0xff;
            return Color::getRGB($red, $green, $blue);
        }
        return null;
    }

getCustomColorBlue()

getCustomColorBlue

(

)

Returns

int

                                        {
        return ($this->namedtag["CustomColor"]) & 0xff;
    }

getCustomColorGreen()

getCustomColorGreen

(

)

Returns

int

                                         {
        return ($this->namedtag["CustomColor"] >> 8) & 0xff;
    }

getCustomColorRed()

getCustomColorRed

(

)

Returns

int

                                       {
        return ($this->namedtag["CustomColor"] >> 16) & 0xff;
    }

getPotionId()

getPotionId

(

)

Returns

mixed|null

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

getSpawnCompound()

getSpawnCompound

(

)

Returns

CompoundTag

                                      {
        $nbt = new CompoundTag("", [
            new StringTag("id", Tile::CAULDRON),
            new IntTag("x", (Int) $this->x),
            new IntTag("y", (Int) $this->y),
            new IntTag("z", (Int) $this->z),
            new ShortTag("PotionId", $this->namedtag["PotionId"]),
            new ByteTag("SplashPotion", $this->namedtag["SplashPotion"]),
            new ListTag("Items", $this->namedtag["Items"])//unused?
        ]);

        if($this->getPotionId() === 0xffff and $this->isCustomColor()){
            $nbt->CustomColor = $this->namedtag->CustomColor;
        }
        return $nbt;
    }

getSplashPotion()

getSplashPotion

(

)

Returns

bool

                                     {
        return ($this->namedtag["SplashPotion"] == true);
    }

hasPotion()

hasPotion

(

)

Returns

bool

                               {
        return $this->namedtag["PotionId"] !== 0xffff;
    }

isCustomColor()

isCustomColor

(

)

Returns

bool

                                   {
        return isset($this->namedtag->CustomColor);
    }

setCustomColor()

setCustomColor	(		$r,
			$g = 0xff,
			$b = 0xff
	)

Parameters

	$r
int	$g
int	$b

                                                            {
        if($r instanceof Color){
            $color = ($r->getRed() << 16 | $r->getGreen() << 8 | $r->getBlue()) & 0xffffff;
        }else{
            $color = ($r << 16 | $g << 8 | $b) & 0xffffff;
        }
        $this->namedtag->CustomColor = new IntTag("CustomColor", $color);
        $this->onChanged();
    }

setPotionId()

setPotionId

(

$potionId

)

Parameters

$potionId

                                          {
        $this->namedtag->PotionId = new ShortTag("PotionId", $potionId);
        $this->onChanged();
    }

setSplashPotion()

setSplashPotion

(

$bool

)

Parameters

$bool

                                          {
        $this->namedtag->SplashPotion = new ByteTag("SplashPotion", ($bool == true) ? 1 : 0);
        $this->onChanged();
    }

---

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

• src/pocketmine/tile/Cauldron.php