BlockMetadataStore Class Reference

Public Member Functions
	__construct (Level $owningLevel)
	disambiguate (Metadatable $block, $metadataKey)
	getMetadata ($block, $metadataKey)
	hasMetadata ($block, $metadataKey)
	removeMetadata ($block, $metadataKey, Plugin $owningPlugin)
	setMetadata ($block, $metadataKey, MetadataValue $newMetadatavalue)
Public Member Functions inherited from MetadataStore
	setMetadata ($subject, $metadataKey, MetadataValue $newMetadataValue)
	getMetadata ($subject, $metadataKey)
	hasMetadata ($subject, $metadataKey)
	removeMetadata ($subject, $metadataKey, Plugin $owningPlugin)
	disambiguate (Metadatable $subject, $metadataKey)

Constructor & Destructor Documentation

__construct()

__construct

(

Level

$owningLevel

)

BlockMetadataStore constructor.

Parameters

Level

$owningLevel

                                                   {
        $this->owningLevel = $owningLevel;
    }

Member Function Documentation

disambiguate()

disambiguate	(	Metadatable	$block,
			$metadataKey
	)

Parameters

Metadatable	$block
string	$metadataKey

Returns

string

                                                                  {
        if(!($block instanceof Block)){
            throw new \InvalidArgumentException("Argument must be a Block instance");
        }

        return $block->x . ":" . $block->y . ":" . $block->z . ":" . $metadataKey;
    }

getMetadata()

getMetadata	(		$block,
			$metadataKey
	)

Parameters

mixed	$block
string	$metadataKey

Returns

MetadataValue[]

                                                     {
        if(!($block instanceof Block)){
            throw new \InvalidArgumentException("Object must be a Block");
        }
        if($block->getLevel() === $this->owningLevel){
            return parent::getMetadata($block, $metadataKey);
        }else{
            throw new \InvalidStateException("Block does not belong to world " . $this->owningLevel->getName());
        }
    }

hasMetadata()

hasMetadata	(		$block,
			$metadataKey
	)

Parameters

mixed	$block
string	$metadataKey

Returns

bool

                                                     {
        if(!($block instanceof Block)){
            throw new \InvalidArgumentException("Object must be a Block");
        }
        if($block->getLevel() === $this->owningLevel){
            return parent::hasMetadata($block, $metadataKey);
        }else{
            throw new \InvalidStateException("Block does not belong to world " . $this->owningLevel->getName());
        }
    }

removeMetadata()

removeMetadata	(		$block,
			$metadataKey,
		Plugin	$owningPlugin
	)

Parameters

mixed	$block
string	$metadataKey
Plugin	$owningPlugin

                                                                              {
        if(!($block instanceof Block)){
            throw new \InvalidArgumentException("Object must be a Block");
        }
        if($block->getLevel() === $this->owningLevel){
            parent::removeMetadata($block, $metadataKey, $owningPlugin);
        }else{
            throw new \InvalidStateException("Block does not belong to world " . $this->owningLevel->getName());
        }
    }

setMetadata()

setMetadata	(		$block,
			$metadataKey,
		MetadataValue	$newMetadatavalue
	)

Parameters

mixed	$block
string	$metadataKey
MetadataValue	$newMetadatavalue

                                                                                      {
        if(!($block instanceof Block)){
            throw new \InvalidArgumentException("Object must be a Block");
        }
        if($block->getLevel() === $this->owningLevel){
            parent::setMetadata($block, $metadataKey, $newMetadatavalue);
        }else{
            throw new \InvalidStateException("Block does not belong to world " . $this->owningLevel->getName());
        }
    }

---

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

• src/pocketmine/metadata/BlockMetadataStore.php