Inheritance diagram for pocketmine\item\WritableBook:

Collaboration diagram for pocketmine\item\WritableBook:

Public Member Functions
	__clone ()

	__toString ()

	addPage (int $pageId)

	canBePlaced ()

	canStackWith (Item $other)

	clearCustomBlockData ()

	clearCustomName ()

	clearNamedTag ()

	deletePage (int $pageId)

	equals (Item $item, bool $checkDamage=true, bool $checkCompound=true)

	equalsExact (Item $other)

	getAttackPoints ()

	getBlock (?int $clickedFace=null)

	getBlockToolHarvestLevel ()

	getBlockToolType ()

	getCanDestroy ()

	getCanPlaceOn ()

	getCooldownTag ()

	getCooldownTicks ()

	getCount ()

	getCustomBlockData ()

	getCustomName ()

	getDefensePoints ()

	getEnchantability ()

	getEnchantmentTags ()

	getFuelResidue ()

	getFuelTime ()

	getLore ()

	getMaxStackSize ()

	getMiningEfficiency (bool $isCorrectTool)

	getName ()

	getNamedTag ()

	getPages ()

	getPageText (int $pageId)

	getStateId ()

	getTypeId ()

	getVanillaName ()

	hasCustomBlockData ()

	hasCustomName ()

	hasNamedTag ()

	insertPage (int $pageId, string $pageText="")

	isFireProof ()

	isNull ()

	jsonSerialize ()

	keepOnDeath ()

	nbtSerialize (int $slot=-1)

	onAttackEntity (Entity $victim, array &$returnedItems)

	onClickAir (Player $player, Vector3 $directionVector, array &$returnedItems)

	onDestroyBlock (Block $block, array &$returnedItems)

	onInteractBlock (Player $player, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, array &$returnedItems)

	onInteractEntity (Player $player, Entity $entity, Vector3 $clickVector)

	onReleaseUsing (Player $player, array &$returnedItems)

	onTickWorn (Living $entity)

	pageExists (int $pageId)

	pop (int $count=1)

	setCanDestroy (array $canDestroy)

	setCanPlaceOn (array $canPlaceOn)

	setCount (int $count)

	setCustomBlockData (CompoundTag $compound)

	setCustomName (string $name)

	setKeepOnDeath (bool $keepOnDeath)

	setLore (array $lines)

	setNamedTag (CompoundTag $tag)

	setPages (array $pages)

	setPageText (int $pageId, string $pageText)

	swapPages (int $pageId1, int $pageId2)

Static Public Member Functions
static	legacyJsonDeserialize (array $data)

static	nbtDeserialize (CompoundTag $tag)

Public Attributes
const	TAG_BLOCK_ENTITY_TAG = "BlockEntityTag"

const	TAG_DISPLAY = "display"

const	TAG_DISPLAY_LORE = "Lore"

const	TAG_DISPLAY_NAME = "Name"

const	TAG_ENCH = "ench"

const	TAG_KEEP_ON_DEATH = "minecraft:keep_on_death"

const	TAG_PAGE_PHOTONAME = "photoname"

const	TAG_PAGE_TEXT = "text"

const	TAG_PAGES = "pages"

Protected Member Functions
	describeState (RuntimeDataDescriber $w)

	deserializeCompoundTag (CompoundTag $tag)

	serializeCompoundTag (CompoundTag $tag)

Protected Attributes
CompoundTag	$blockEntityTag = null

array	$canDestroy = []

array	$canPlaceOn = []

int	$count = 1

string	$customName = ""

bool	$keepOnDeath = false

array	$lore = []

Detailed Description

Definition at line 26 of file WritableBook.php.

Member Function Documentation

◆ __clone()

pocketmine\item\Item::__clone ( )

inherited

Definition at line 767 of file Item.php.

◆ __toString()

pocketmine\item\Item::__toString ( )

finalinherited

Definition at line 696 of file Item.php.

◆ addPage()

pocketmine\item\WritableBookBase::addPage ( int $pageId )

inherited

Adds a new page with the given page ID. Creates a new page for every page between the given ID and existing pages that doesn't yet exist.

Returns: $this

Definition at line 87 of file WritableBookBase.php.

◆ canBePlaced()

pocketmine\item\Item::canBePlaced ( )

finalinherited

Definition at line 484 of file Item.php.

◆ canStackWith()

pocketmine\item\Item::canStackWith ( Item $other )

finalinherited

Returns whether this item could stack with the given item (ignoring stack size and count).

Definition at line 685 of file Item.php.

◆ clearCustomBlockData()

pocketmine\item\Item::clearCustomBlockData ( )

inherited

Returns: $this

Definition at line 128 of file Item.php.

◆ clearCustomName()

pocketmine\item\Item::clearCustomName ( )

inherited

Returns: $this

Definition at line 166 of file Item.php.

◆ clearNamedTag()

pocketmine\item\Item::clearNamedTag ( )

inherited

Removes the Item's NBT.

Returns: $this

Exceptions

NbtException

Definition at line 279 of file Item.php.

◆ deletePage()

pocketmine\item\WritableBookBase::deletePage ( int $pageId )

inherited

Deletes an existing page with the given page ID.

Returns: $this

Definition at line 103 of file WritableBookBase.php.

◆ describeState()

pocketmine\item\Item::describeState ( RuntimeDataDescriber $w )

protectedinherited

Describes state properties of the item, such as colour, skull type, etc. This allows associating basic extra data with the item at runtime in a more efficient format than NBT.

Reimplemented in pocketmine\item\Banner, pocketmine\item\CoralFan, pocketmine\item\Dye, pocketmine\item\GoatHorn, pocketmine\item\ItemBlock, pocketmine\item\Medicine, pocketmine\item\Potion, pocketmine\item\SplashPotion, and pocketmine\item\SuspiciousStew.

Definition at line 513 of file Item.php.

◆ deserializeCompoundTag()

pocketmine\item\WritableBookBase::deserializeCompoundTag ( CompoundTag $tag )

protectedinherited

Exceptions

NbtException

Reimplemented from pocketmine\item\Item.

Reimplemented in pocketmine\item\WrittenBook.

Definition at line 163 of file WritableBookBase.php.

◆ equals()

pocketmine\item\Item::equals	(	Item	$item,
		bool	$checkDamage = true,
		bool	$checkCompound = true )

finalinherited

Compares an Item to this Item and check if they match.

Parameters

bool $checkDamage

Deprecated

Parameters

bool $checkCompound Whether to verify that the items' NBT match.

Definition at line 677 of file Item.php.

◆ equalsExact()

pocketmine\item\Item::equalsExact ( Item $other )

finalinherited

Returns whether the specified item stack has the same ID, damage, NBT and count as this item stack.

Definition at line 692 of file Item.php.

◆ getAttackPoints()

pocketmine\item\Item::getAttackPoints ( )

inherited

Returns how many points of damage this item will deal to an entity when used as a weapon.

Reimplemented in pocketmine\item\Axe, pocketmine\item\Pickaxe, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 551 of file Item.php.

◆ getBlock()

pocketmine\item\Item::getBlock ( ?int $clickedFace = null )

inherited

Returns the block corresponding to this Item.

Reimplemented in pocketmine\item\Bamboo, pocketmine\item\BeetrootSeeds, pocketmine\item\Carrot, pocketmine\item\CocoaBeans, pocketmine\item\CoralFan, pocketmine\item\GlowBerries, pocketmine\item\ItemBlock, pocketmine\item\ItemBlockWallOrFloor, pocketmine\item\MelonSeeds, pocketmine\item\PitcherPod, pocketmine\item\Potato, pocketmine\item\PumpkinSeeds, pocketmine\item\Redstone, pocketmine\item\StringItem, pocketmine\item\SweetBerries, pocketmine\item\TorchflowerSeeds, and pocketmine\item\WheatSeeds.

Definition at line 491 of file Item.php.

Referenced by pocketmine\block\Cake\onInteract().

Here is the caller graph for this function:

◆ getBlockToolHarvestLevel()

pocketmine\item\Item::getBlockToolHarvestLevel ( )

inherited

Returns the harvesting power that this tool has. This affects what blocks it can mine when the tool type matches the mined block. This should return 1 for non-tiered tools, and the tool tier for tiered tools.

See also: BlockBreakInfo::getToolHarvestLevel()

Reimplemented in pocketmine\item\Axe, pocketmine\item\Pickaxe, pocketmine\item\Shears, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 577 of file Item.php.

◆ getBlockToolType()

pocketmine\item\Item::getBlockToolType ( )

inherited

Returns what type of block-breaking tool this is. Blocks requiring the same tool type as the item will break faster (except for blocks requiring no tool, which break at the same speed regardless of the tool used)

Reimplemented in pocketmine\item\Axe, pocketmine\item\Hoe, pocketmine\item\Pickaxe, pocketmine\item\Shears, pocketmine\item\Shovel, and pocketmine\item\Sword.

Definition at line 566 of file Item.php.

◆ getCanDestroy()

pocketmine\item\Item::getCanDestroy ( )

inherited

Returns: string[] @phpstan-return array<string, string>

Definition at line 216 of file Item.php.

◆ getCanPlaceOn()

pocketmine\item\Item::getCanPlaceOn ( )

inherited

Returns: string[] @phpstan-return array<string, string>

Definition at line 198 of file Item.php.

◆ getCooldownTag()

pocketmine\item\Item::getCooldownTag ( )

inherited

Returns a tag that identifies a group of items that should have cooldown at the same time regardless of their state or type. When cooldown starts, any other items with the same cooldown tag can't be used until the cooldown expires. Such behaviour can be seen in goat horns and shields.

If tag is null, item state id will be used to store cooldown.

See also: ItemCooldownTags

Reimplemented in pocketmine\item\ChorusFruit, pocketmine\item\EnderPearl, and pocketmine\item\GoatHorn.

Definition at line 667 of file Item.php.

Referenced by pocketmine\player\Player\resetItemCooldown().

Here is the caller graph for this function:

◆ getCooldownTicks()

pocketmine\item\Item::getCooldownTicks ( )

inherited

Returns the number of ticks a player must wait before activating this item again.

Reimplemented in pocketmine\item\ChorusFruit, pocketmine\item\EnderPearl, and pocketmine\item\GoatHorn.

Definition at line 653 of file Item.php.

◆ getCount()

pocketmine\item\Item::getCount ( )

inherited

Definition at line 411 of file Item.php.

◆ getCustomBlockData()

pocketmine\item\Item::getCustomBlockData ( )

inherited

Definition at line 142 of file Item.php.

◆ getCustomName()

pocketmine\item\Item::getCustomName ( )

inherited

Definition at line 150 of file Item.php.

◆ getDefensePoints()

pocketmine\item\Item::getDefensePoints ( )

inherited

Returns how many armor points can be gained by wearing this item.

Reimplemented in pocketmine\item\Armor.

Definition at line 558 of file Item.php.

◆ getEnchantability()

pocketmine\item\Item::getEnchantability ( )

inherited

Returns the value that defines how enchantable the item is.

The higher an item's enchantability is, the more likely it will be to gain high-level enchantments or multiple enchantments upon being enchanted in an enchanting table.

Reimplemented in pocketmine\item\Armor, and pocketmine\item\TieredTool.

Definition at line 480 of file Item.php.

◆ getEnchantmentTags()

pocketmine\item\Item::getEnchantmentTags ( )

inherited

Returns tags that represent the type of item being enchanted and are used to determine what enchantments can be applied to this item during in-game enchanting (enchanting table, anvil, fishing, etc.).

See also: ItemEnchantmentTags; ItemEnchantmentTagRegistry; AvailableEnchantmentRegistry

Returns: string[]

Definition at line 470 of file Item.php.

◆ getFuelResidue()

pocketmine\item\Item::getFuelResidue ( )

inherited

Returns an item after burning fuel

Reimplemented in pocketmine\item\LiquidBucket.

Definition at line 534 of file Item.php.

◆ getFuelTime()

pocketmine\item\Item::getFuelTime ( )

inherited

Returns the time in ticks which the item will fuel a furnace for.

Reimplemented in pocketmine\item\Bamboo, pocketmine\item\Banner, pocketmine\item\BlazeRod, pocketmine\item\Boat, pocketmine\item\Bow, pocketmine\item\Bowl, pocketmine\item\Coal, pocketmine\item\CoralFan, pocketmine\item\ItemBlock, pocketmine\item\ItemBlockWallOrFloor, pocketmine\item\LiquidBucket, pocketmine\item\Stick, and pocketmine\item\TieredTool.

Definition at line 527 of file Item.php.

◆ getLore()

pocketmine\item\Item::getLore ( )

inherited

Returns: string[]

Definition at line 174 of file Item.php.

◆ getMaxStackSize()

pocketmine\item\WritableBookBase::getMaxStackSize ( )

inherited

Returns the highest amount of this item which will fit into one inventory slot.

Reimplemented from pocketmine\item\Item.

Reimplemented in pocketmine\item\WrittenBook.

Definition at line 140 of file WritableBookBase.php.

◆ getMiningEfficiency()

pocketmine\item\Item::getMiningEfficiency ( bool $isCorrectTool )

inherited

Definition at line 581 of file Item.php.

◆ getName()

pocketmine\item\Item::getName ( )

finalinherited

Returns the name of the item, or the custom name if it is set.

Definition at line 450 of file Item.php.

◆ getNamedTag()

pocketmine\item\Item::getNamedTag ( )

inherited

Returns a tree of Tag objects representing the Item's NBT. If the item does not have any NBT, an empty CompoundTag object is returned to allow the caller to manipulate and apply back to the item.

Definition at line 252 of file Item.php.

◆ getPages()

pocketmine\item\WritableBookBase::getPages ( )

inherited

Returns an array containing all pages of this book.

Returns: WritableBookPage[]

Definition at line 149 of file WritableBookBase.php.

◆ getPageText()

pocketmine\item\WritableBookBase::getPageText ( int $pageId )

inherited

Returns a string containing the content of a page (which could be empty), or null if the page doesn't exist.

Exceptions

OutOfRangeException if requesting a nonexisting page

Definition at line 63 of file WritableBookBase.php.

◆ getStateId()

pocketmine\item\Item::getStateId ( )

finalinherited

Definition at line 499 of file Item.php.

◆ getTypeId()

pocketmine\item\Item::getTypeId ( )

finalinherited

Definition at line 495 of file Item.php.

◆ getVanillaName()

pocketmine\item\Item::getVanillaName ( )

inherited

Returns the vanilla name of the item, disregarding custom names.

Definition at line 457 of file Item.php.

◆ hasCustomBlockData()

pocketmine\item\Item::hasCustomBlockData ( )

inherited

Definition at line 121 of file Item.php.

◆ hasCustomName()

pocketmine\item\Item::hasCustomName ( )

inherited

Definition at line 146 of file Item.php.

◆ hasNamedTag()

pocketmine\item\Item::hasNamedTag ( )

inherited

Returns whether this Item has a non-empty NBT.

Definition at line 244 of file Item.php.

◆ insertPage()

pocketmine\item\WritableBookBase::insertPage	(	int	$pageId,
		string	$pageText = "" )

inherited

Inserts a new page with the given text and moves other pages upwards.

Returns: $this

Definition at line 114 of file WritableBookBase.php.

◆ isFireProof()

pocketmine\item\Item::isFireProof ( )

inherited

Returns whether this item can survive being dropped into lava, or fire.

Reimplemented in pocketmine\item\Armor, pocketmine\item\ItemBlock, and pocketmine\item\TieredTool.

Definition at line 544 of file Item.php.

static pocketmine\item\Item::legacyJsonDeserialize ( array $data )

staticfinalinherited

Deserializes item JSON data produced by json_encode()ing Item instances in older versions of PocketMine-MP. This method exists solely to allow upgrading old JSON data stored by plugins.

Parameters

mixed[] $data

Exceptions

SavedDataLoadingException

Definition at line 715 of file Item.php.

◆ nbtDeserialize()

static pocketmine\item\Item::nbtDeserialize ( CompoundTag $tag )

staticinherited

Deserializes an Item from an NBT CompoundTag

Exceptions

SavedDataLoadingException

Definition at line 754 of file Item.php.

pocketmine\item\Item::onInteractEntity	(	Player	$player,
		Entity	$entity,
		Vector3	$clickVector )

inherited

Called when a player uses the item to interact with entity, for example by using a name tag.

Parameters

Vector3 $clickVector The exact position of the click (absolute coordinates)

Returns: bool whether some action took place

Reimplemented in pocketmine\item\NameTag.

Definition at line 646 of file Item.php.

◆ onReleaseUsing()

pocketmine\item\Item::onReleaseUsing	(	Player	$player,
		array &	$returnedItems )

inherited

Called when a player is using this item and releases it. Used to handle bow shoot actions. Returns whether the item was changed, for example count decrease or durability change.

Parameters

Item[] &$returnedItems Items to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Bow.

Definition at line 610 of file Item.php.

◆ onTickWorn()

pocketmine\item\Item::onTickWorn ( Living $entity )

inherited

Called when this item is being worn by an entity. Returns whether it did something.

Reimplemented in pocketmine\item\TurtleHelmet.

Definition at line 636 of file Item.php.

◆ pageExists()

pocketmine\item\WritableBookBase::pageExists ( int $pageId )

inherited

Returns whether the given page exists in this book.

Definition at line 54 of file WritableBookBase.php.

◆ pop()

pocketmine\item\Item::pop ( int $count = 1 )

inherited

Pops an item from the stack and returns it, decreasing the stack count of this item stack by one.

Returns: static A clone of this itemstack containing the amount of items that were removed from this stack.

Exceptions

InvalidArgumentException if trying to pop more items than are on the stack

Definition at line 430 of file Item.php.

Here is the caller graph for this function:

◆ serializeCompoundTag()

pocketmine\item\WritableBookBase::serializeCompoundTag ( CompoundTag $tag )

protectedinherited

Reimplemented from pocketmine\item\Item.

Definition at line 183 of file WritableBookBase.php.

◆ setCanDestroy()

pocketmine\item\Item::setCanDestroy ( array $canDestroy )

inherited

Parameters

string[] $canDestroy

Definition at line 223 of file Item.php.

◆ setCanPlaceOn()

pocketmine\item\Item::setCanPlaceOn ( array $canPlaceOn )

inherited

Parameters

string[] $canPlaceOn

Definition at line 205 of file Item.php.

◆ setCount()

pocketmine\item\Item::setCount ( int $count )

inherited

Returns: $this

Definition at line 418 of file Item.php.

◆ setCustomBlockData()

pocketmine\item\Item::setCustomBlockData ( CompoundTag $compound )

inherited

Returns: $this

Definition at line 136 of file Item.php.

◆ setCustomName()

pocketmine\item\Item::setCustomName ( string $name )

inherited

Returns: $this

Definition at line 157 of file Item.php.

◆ setKeepOnDeath()

pocketmine\item\Item::setKeepOnDeath ( bool $keepOnDeath )

inherited

Definition at line 237 of file Item.php.

◆ setLore()

pocketmine\item\Item::setLore ( array $lines )

inherited

Parameters

string[] $lines

Returns: $this

Definition at line 183 of file Item.php.

◆ setNamedTag()

pocketmine\item\Item::setNamedTag ( CompoundTag $tag )

inherited

Sets the Item's NBT from the supplied CompoundTag object.

Returns: $this

Exceptions

NbtException

Definition at line 263 of file Item.php.

◆ setPages()

pocketmine\item\WritableBookBase::setPages ( array $pages )

inherited

Parameters

WritableBookPage[] $pages

Returns: $this

Definition at line 158 of file WritableBookBase.php.

◆ setPageText()

pocketmine\item\WritableBookBase::setPageText	(	int	$pageId,
		string	$pageText )

inherited

Sets the text of a page in the book. Adds the page if the page does not yet exist.

Returns: $this

Definition at line 72 of file WritableBookBase.php.

◆ swapPages()

pocketmine\item\WritableBookBase::swapPages	(	int	$pageId1,
		int	$pageId2 )

inherited

Switches the text of two pages with each other.

Returns: bool indicating success

Exceptions

OutOfRangeException if either of the pages does not exist

Definition at line 131 of file WritableBookBase.php.

Member Data Documentation

◆ $blockEntityTag

WritableBook.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __clone()

◆ __toString()

◆ addPage()

◆ canBePlaced()

◆ canStackWith()

◆ clearCustomBlockData()

◆ clearCustomName()

◆ clearNamedTag()

◆ deletePage()

◆ describeState()

◆ deserializeCompoundTag()

◆ equals()

◆ equalsExact()

◆ getAttackPoints()

◆ getBlock()

◆ getBlockToolHarvestLevel()

◆ getBlockToolType()

◆ getCanDestroy()

◆ getCanPlaceOn()

◆ getCooldownTag()

◆ getCooldownTicks()

◆ getCount()

◆ getCustomBlockData()

◆ getCustomName()

◆ getDefensePoints()

◆ getEnchantability()

◆ getEnchantmentTags()

◆ getFuelResidue()

◆ getFuelTime()

◆ getLore()

◆ getMaxStackSize()

◆ getMiningEfficiency()

◆ getName()

◆ getNamedTag()

◆ getPages()

◆ getPageText()

◆ getStateId()

◆ getTypeId()

◆ getVanillaName()

◆ hasCustomBlockData()

◆ hasCustomName()

◆ hasNamedTag()

◆ insertPage()

◆ isFireProof()

◆ isNull()

◆ jsonSerialize()

◆ keepOnDeath()

◆ legacyJsonDeserialize()

◆ nbtDeserialize()

◆ nbtSerialize()

◆ onAttackEntity()

◆ onClickAir()

◆ onDestroyBlock()

◆ onInteractBlock()

◆ onInteractEntity()

◆ onReleaseUsing()

◆ onTickWorn()

◆ pageExists()

◆ pop()

◆ serializeCompoundTag()

◆ setCanDestroy()

◆ setCanPlaceOn()

◆ setCount()

◆ setCustomBlockData()

◆ setCustomName()

◆ setKeepOnDeath()

◆ setLore()

◆ setNamedTag()

◆ setPages()

◆ setPageText()

◆ swapPages()

Member Data Documentation

◆ $blockEntityTag