PocketMine-MP 5.28.3 git-d5a1007c80fcee27feb2251cf5dcf1ad5a59a85c
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
pocketmine\item\WrittenBook Class Reference
+ Inheritance diagram for pocketmine\item\WrittenBook:
+ Collaboration diagram for pocketmine\item\WrittenBook:

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 ()
 
 getAuthor ()
 
 getBlock (?int $clickedFace=null)
 
 getBlockToolHarvestLevel ()
 
 getBlockToolType ()
 
 getCanDestroy ()
 
 getCanPlaceOn ()
 
 getCooldownTag ()
 
 getCooldownTicks ()
 
 getCount ()
 
 getCustomBlockData ()
 
 getCustomName ()
 
 getDefensePoints ()
 
 getEnchantability ()
 
 getEnchantmentTags ()
 
 getFuelResidue ()
 
 getFuelTime ()
 
 getGeneration ()
 
 getLore ()
 
 getMaxStackSize ()
 
 getMiningEfficiency (bool $isCorrectTool)
 
 getName ()
 
 getNamedTag ()
 
 getPages ()
 
 getPageText (int $pageId)
 
 getStateId ()
 
 getTitle ()
 
 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)
 
 setAuthor (string $authorName)
 
 setCanDestroy (array $canDestroy)
 
 setCanPlaceOn (array $canPlaceOn)
 
 setCount (int $count)
 
 setCustomBlockData (CompoundTag $compound)
 
 setCustomName (string $name)
 
 setGeneration (int $generation)
 
 setKeepOnDeath (bool $keepOnDeath)
 
 setLore (array $lines)
 
 setNamedTag (CompoundTag $tag)
 
 setPages (array $pages)
 
 setPageText (int $pageId, string $pageText)
 
 setTitle (string $title)
 
 swapPages (int $pageId1, int $pageId2)
 

Static Public Member Functions

static legacyJsonDeserialize (array $data)
 
static nbtDeserialize (CompoundTag $tag)
 

Public Attributes

const GENERATION_COPY = 1
 
const GENERATION_COPY_OF_COPY = 2
 
const GENERATION_ORIGINAL = 0
 
const GENERATION_TATTERED = 3
 
const TAG_AUTHOR = "author"
 
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_GENERATION = "generation"
 
const TAG_KEEP_ON_DEATH = "minecraft:keep_on_death"
 
const TAG_PAGE_PHOTONAME = "photoname"
 
const TAG_PAGE_TEXT = "text"
 
const TAG_PAGES = "pages"
 
const TAG_TITLE = "title"
 

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 32 of file WrittenBook.php.

Member Function Documentation

◆ __clone()

pocketmine\item\Item::__clone ( )
inherited

Definition at line 770 of file Item.php.

◆ __toString()

pocketmine\item\Item::__toString ( )
finalinherited

Definition at line 699 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 487 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 688 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 282 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 516 of file Item.php.

◆ deserializeCompoundTag()

pocketmine\item\WrittenBook::deserializeCompoundTag ( CompoundTag $tag)
protected
Exceptions
NbtException

Reimplemented from pocketmine\item\WritableBookBase.

Definition at line 117 of file WrittenBook.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$checkCompoundWhether to verify that the items' NBT match.

Definition at line 680 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 695 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 554 of file Item.php.

◆ getAuthor()

pocketmine\item\WrittenBook::getAuthor ( )

Returns the author of this book. This is not a reliable way to get the name of the player who signed this book. The author can be set to anything when signing a book.

Definition at line 78 of file WrittenBook.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 494 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 580 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 569 of file Item.php.

◆ getCanDestroy()

pocketmine\item\Item::getCanDestroy ( )
inherited
Returns
string[] @phpstan-return array<string, string>

Definition at line 217 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 670 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, pocketmine\item\GoatHorn, and pocketmine\item\IceBomb.

Definition at line 656 of file Item.php.

◆ getCount()

pocketmine\item\Item::getCount ( )
inherited

Definition at line 414 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 561 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 483 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 473 of file Item.php.

◆ getFuelResidue()

pocketmine\item\Item::getFuelResidue ( )
inherited

Returns an item after burning fuel

Reimplemented in pocketmine\item\LiquidBucket.

Definition at line 537 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 530 of file Item.php.

◆ getGeneration()

pocketmine\item\WrittenBook::getGeneration ( )

Returns the generation of the book. Generations higher than 1 can not be copied.

Definition at line 55 of file WrittenBook.php.

◆ getLore()

pocketmine\item\Item::getLore ( )
inherited
Returns
string[]

Definition at line 174 of file Item.php.

◆ getMaxStackSize()

pocketmine\item\WrittenBook::getMaxStackSize ( )

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

Reimplemented from pocketmine\item\WritableBookBase.

Definition at line 47 of file WrittenBook.php.

◆ getMiningEfficiency()

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

Definition at line 584 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 453 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 255 of file Item.php.

◆ getPages()

pocketmine\item\WritableBookBase::getPages ( )
inherited

Returns an array containing all pages of this book.

Returns
WritableBookPage[]

Definition at line 150 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 502 of file Item.php.

◆ getTitle()

pocketmine\item\WrittenBook::getTitle ( )

Returns the title of this book.

Definition at line 99 of file WrittenBook.php.

◆ getTypeId()

pocketmine\item\Item::getTypeId ( )
finalinherited

Definition at line 498 of file Item.php.

◆ getVanillaName()

pocketmine\item\Item::getVanillaName ( )
inherited

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

Definition at line 460 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 247 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 115 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 547 of file Item.php.

◆ isNull()

pocketmine\item\Item::isNull ( )
inherited

Definition at line 446 of file Item.php.

◆ jsonSerialize()

pocketmine\item\Item::jsonSerialize ( )
inherited

@phpstan-return never

Definition at line 706 of file Item.php.

◆ keepOnDeath()

pocketmine\item\Item::keepOnDeath ( )
inherited

Returns whether players will retain this item on death. If a non-player dies it will be excluded from the drops.

Definition at line 235 of file Item.php.

◆ legacyJsonDeserialize()

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 718 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 757 of file Item.php.

◆ nbtSerialize()

pocketmine\item\Item::nbtSerialize ( int $slot = -1)
inherited

Serializes the item to an NBT CompoundTag

Parameters
int$slotoptional, the inventory slot of the item

Definition at line 749 of file Item.php.

◆ onAttackEntity()

pocketmine\item\Item::onAttackEntity ( Entity $victim,
array & $returnedItems )
inherited

Called when this item is used to attack an entity. Usually used to update durability.

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

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

Definition at line 631 of file Item.php.

◆ onClickAir()

pocketmine\item\Item::onClickAir ( Player $player,
Vector3 $directionVector,
array & $returnedItems )
inherited

Called when a player uses the item on air, for example throwing a projectile. Returns whether the item was changed, for example count decrease or durability change.

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

Reimplemented in pocketmine\item\Armor, pocketmine\item\GoatHorn, and pocketmine\item\ProjectileItem.

Definition at line 603 of file Item.php.

◆ onDestroyBlock()

pocketmine\item\Item::onDestroyBlock ( Block $block,
array & $returnedItems )
inherited

Called when this item is used to destroy a block. Usually used to update durability.

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

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

Definition at line 622 of file Item.php.

◆ onInteractBlock()

pocketmine\item\Item::onInteractBlock ( Player $player,
Block $blockReplace,
Block $blockClicked,
int $face,
Vector3 $clickVector,
array & $returnedItems )
inherited

Called when a player uses this item on a block.

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

Reimplemented in pocketmine\item\Bucket, pocketmine\item\EndCrystal, pocketmine\item\FireCharge, pocketmine\item\FlintSteel, pocketmine\item\GlassBottle, pocketmine\item\LiquidBucket, pocketmine\item\PaintingItem, and pocketmine\item\SpawnEgg.

Definition at line 593 of file Item.php.

◆ onInteractEntity()

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$clickVectorThe exact position of the click (absolute coordinates)
Returns
bool whether some action took place

Reimplemented in pocketmine\item\NameTag.

Definition at line 649 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[]&$returnedItemsItems to be added to the target's inventory (or dropped, if the inventory is full)

Reimplemented in pocketmine\item\Bow.

Definition at line 613 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 639 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 433 of file Item.php.

Referenced by pocketmine\block\Bamboo\onInteract(), pocketmine\block\BambooSapling\onInteract(), pocketmine\block\BaseBigDripleaf\onInteract(), pocketmine\block\Cake\onInteract(), pocketmine\block\CocoaBlock\onInteract(), pocketmine\block\Crops\onInteract(), pocketmine\block\DoublePitcherCrop\onInteract(), pocketmine\block\GlowLichen\onInteract(), pocketmine\block\Jukebox\onInteract(), pocketmine\block\Lectern\onInteract(), pocketmine\block\NetherVines\onInteract(), pocketmine\block\PinkPetals\onInteract(), pocketmine\block\PitcherCrop\onInteract(), pocketmine\block\Sapling\onInteract(), pocketmine\block\SmallDripleaf\onInteract(), pocketmine\block\Sugarcane\onInteract(), pocketmine\block\SweetBerryBush\onInteract(), pocketmine\block\TNT\onInteract(), pocketmine\block\TorchflowerCrop\onInteract(), pocketmine\item\EndCrystal\onInteractBlock(), pocketmine\item\FireCharge\onInteractBlock(), pocketmine\item\GlassBottle\onInteractBlock(), and pocketmine\item\NameTag\onInteractEntity().

+ Here is the caller graph for this function:

◆ serializeCompoundTag()

pocketmine\item\WrittenBook::serializeCompoundTag ( CompoundTag $tag)
protected

Reimplemented from pocketmine\item\WritableBookBase.

Definition at line 124 of file WrittenBook.php.

◆ setAuthor()

pocketmine\item\WrittenBook::setAuthor ( string $authorName)

Sets the author of this book.

Returns
$this

Definition at line 87 of file WrittenBook.php.

◆ setCanDestroy()

pocketmine\item\Item::setCanDestroy ( array $canDestroy)
inherited
Parameters
string[]$canDestroy

Definition at line 224 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 421 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.

◆ setGeneration()

pocketmine\item\WrittenBook::setGeneration ( int $generation)

Sets the generation of a book.

Returns
$this

Definition at line 64 of file WrittenBook.php.

◆ setKeepOnDeath()

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

Definition at line 239 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 266 of file Item.php.

◆ setPages()

pocketmine\item\WritableBookBase::setPages ( array $pages)
inherited
Parameters
WritableBookPage[]$pages
Returns
$this

Definition at line 159 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.

◆ setTitle()

pocketmine\item\WrittenBook::setTitle ( string $title)

Sets the author of this book.

Returns
$this

Definition at line 108 of file WrittenBook.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 132 of file WritableBookBase.php.

Member Data Documentation

◆ $blockEntityTag

CompoundTag pocketmine\item\Item::$blockEntityTag = null
protectedinherited

TODO: this needs to die in a fire

Definition at line 88 of file Item.php.

◆ $canDestroy

array pocketmine\item\Item::$canDestroy = []
protectedinherited

Definition at line 99 of file Item.php.

◆ $canPlaceOn

array pocketmine\item\Item::$canPlaceOn = []
protectedinherited

Definition at line 94 of file Item.php.

◆ $count

int pocketmine\item\Item::$count = 1
protectedinherited

Definition at line 80 of file Item.php.

◆ $customName

string pocketmine\item\Item::$customName = ""
protectedinherited

Definition at line 84 of file Item.php.

◆ $keepOnDeath

bool pocketmine\item\Item::$keepOnDeath = false
protectedinherited

Definition at line 101 of file Item.php.

◆ $lore

array pocketmine\item\Item::$lore = []
protectedinherited

Definition at line 86 of file Item.php.

◆ GENERATION_COPY

const pocketmine\item\WrittenBook::GENERATION_COPY = 1

Definition at line 35 of file WrittenBook.php.

◆ GENERATION_COPY_OF_COPY

const pocketmine\item\WrittenBook::GENERATION_COPY_OF_COPY = 2

Definition at line 36 of file WrittenBook.php.

◆ GENERATION_ORIGINAL

const pocketmine\item\WrittenBook::GENERATION_ORIGINAL = 0

Definition at line 34 of file WrittenBook.php.

◆ GENERATION_TATTERED

const pocketmine\item\WrittenBook::GENERATION_TATTERED = 3

Definition at line 37 of file WrittenBook.php.

◆ TAG_AUTHOR

const pocketmine\item\WrittenBook::TAG_AUTHOR = "author"

Definition at line 40 of file WrittenBook.php.

◆ TAG_BLOCK_ENTITY_TAG

const pocketmine\item\Item::TAG_BLOCK_ENTITY_TAG = "BlockEntityTag"
inherited

Definition at line 68 of file Item.php.

◆ TAG_DISPLAY

const pocketmine\item\Item::TAG_DISPLAY = "display"
inherited

Definition at line 67 of file Item.php.

◆ TAG_DISPLAY_LORE

const pocketmine\item\Item::TAG_DISPLAY_LORE = "Lore"
inherited

Definition at line 71 of file Item.php.

◆ TAG_DISPLAY_NAME

const pocketmine\item\Item::TAG_DISPLAY_NAME = "Name"
inherited

Definition at line 70 of file Item.php.

◆ TAG_ENCH

const pocketmine\item\Item::TAG_ENCH = "ench"
inherited

Definition at line 63 of file Item.php.

◆ TAG_GENERATION

const pocketmine\item\WrittenBook::TAG_GENERATION = "generation"

Definition at line 39 of file WrittenBook.php.

◆ TAG_KEEP_ON_DEATH

const pocketmine\item\Item::TAG_KEEP_ON_DEATH = "minecraft:keep_on_death"
inherited

Definition at line 73 of file Item.php.

◆ TAG_PAGE_PHOTONAME

const pocketmine\item\WritableBookBase::TAG_PAGE_PHOTONAME = "photoname"
inherited

Definition at line 39 of file WritableBookBase.php.

◆ TAG_PAGE_TEXT

const pocketmine\item\WritableBookBase::TAG_PAGE_TEXT = "text"
inherited

Definition at line 38 of file WritableBookBase.php.

◆ TAG_PAGES

const pocketmine\item\WritableBookBase::TAG_PAGES = "pages"
inherited

Definition at line 37 of file WritableBookBase.php.

◆ TAG_TITLE

const pocketmine\item\WrittenBook::TAG_TITLE = "title"

Definition at line 41 of file WrittenBook.php.

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