Class ItemBookComponentBeta

Optional Readonly Betaauthor

Readonly Betacontents

Readonly BetaisSigned

Readonly BetapageCount

Readonly BetarawContents

Optional Readonly Betatitle

Static Readonly BetacomponentId

getPageContent

• getPageContent(pageIndex: number): undefined | string
  Beta

  Parameters

  • pageIndex: number

    The index of the page.

  Returns undefined | string

  The content of the page if a valid index is provided and it is in string format, otherwise returns undefined.

  Remarks

  Gets the string format content of a page for a given index.

  Throws

  This function can throw errors.

  InvalidItemStackError

getRawPageContent

• getRawPageContent(pageIndex: number): undefined | RawMessage
  Beta

  Parameters

  • pageIndex: number

    The index of the page.

  Returns undefined | RawMessage

  The content of the page if a valid index is provided and it is in RawMessage format, otherwise returns undefined.

  Remarks

  Gets the RawMessage format content of a page for a given index.

  Throws

  This function can throw errors.

  InvalidItemStackError

insertPage

• insertPage(
      pageIndex: number,
      content: string | RawMessage | (string | RawMessage)[],
  ): void
  Beta

  Parameters

  • pageIndex: number

    The index of the page.
  • content: string | RawMessage | (string | RawMessage)[]

    The content to set for the page. Can be a single string or RawMessage or an array of strings and/or RawMessages

  Returns void

  Remarks

  Inserts a page at a given index. Empty pages will be created if the index is greater than the current book size. Pages have a maximum limit of 256 characters for strings as well as the JSON representation of a RawMessage. Books have a maximum limit of 50 pages.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  BookError

  BookPageContentError

  InvalidItemStackError

removePage

• removePage(pageIndex: number): void
  Beta

  Parameters

  • pageIndex: number

    The index of the page.

  Returns void

  Remarks

  Removes a page at a given index. Existing pages following this page will be moved backward to fill the empty space.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  InvalidItemStackError

setContents

• setContents(contents: (string | RawMessage | (string | RawMessage)[])[]): void
  Beta

  Parameters

  • contents: (string | RawMessage | (string | RawMessage)[])[]

    An array of each page's contents. Each page can be a single string or RawMessage or an array of strings and/or RawMessages.

  Returns void

  Remarks

  Sets the contents of the book's pages. Pre-existing pages will be cleared. Pages have a maximum limit of 256 characters for strings as well as the JSON representation of a RawMessage. Books have a maximum limit of 50 pages.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  BookError

  BookPageContentError

  InvalidItemStackError

setPageContent

• setPageContent(
      pageIndex: number,
      content: string | RawMessage | (string | RawMessage)[],
  ): void
  Beta

  Parameters

  • pageIndex: number

    The index of the page.
  • content: string | RawMessage | (string | RawMessage)[]

    The content to set for the page. Can be a single string or RawMessage or an array of strings and/or RawMessages

  Returns void

  Remarks

  Sets or creates the content of a specific page. Empty pages will be created if the index is greater than the current book size. Pages have a maximum limit of 256 characters for strings as well as the JSON representation of a RawMessage. Books have a maximum limit of 50 pages.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  BookError

  BookPageContentError

  InvalidItemStackError

signBook

• signBook(title: string, author: string): void
  Beta

  Parameters

  • title: string

    The title to give the book.
  • author: string

    The name of the book's author.

  Returns void

  Remarks

  Signs a book giving it a title and author name. Once signed players can no longer directly edit the book. Titles have a maximum character limit of 16.

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  BookError

  InvalidEntityError

  InvalidItemStackError