WritableBookBase

abstract class · pocketmine\item\WritableBookBase · source

Extends Item

Constants

TAG_PAGES

public const TAG_PAGES = "pages"

TAG_PAGE_PHOTONAME

public const TAG_PAGE_PHOTONAME = "photoname"

TAG_PAGE_TEXT

public const TAG_PAGE_TEXT = "text"

Methods

__construct()

public function __construct(\pocketmine\item\ItemIdentifier $identifier, string $name)

addPage()

public function addPage(int $pageId) : self

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.

deletePage()

public function deletePage(int $pageId) : self

Deletes an existing page with the given page ID.

deserializeCompoundTag() protected

protected function deserializeCompoundTag(\pocketmine\nbt\tag\CompoundTag $tag) : void

getMaxStackSize()

public function getMaxStackSize() : int

getPageText()

public function getPageText(int $pageId) : string

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

getPages()

public function getPages() : array

Returns an array containing all pages of this book.

insertPage()

public function insertPage(int $pageId, string $pageText = "") : self

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

pageExists()

public function pageExists(int $pageId) : bool

Returns whether the given page exists in this book.

serializeCompoundTag() protected

protected function serializeCompoundTag(\pocketmine\nbt\tag\CompoundTag $tag) : void

setPageText()

public function setPageText(int $pageId, string $pageText) : self

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

setPages()

public function setPages(array $pages) : self

swapPages()

public function swapPages(int $pageId1, int $pageId2) : bool

Switches the text of two pages with each other.