Class QuestBook

constructor

• new QuestBook(id, title, body, options, iconPath?): QuestBook

• Parameters

  • id: string

    The unique id of the QuestBook.
  • title: string | RawMessage

    Title of the QuestBook.
  • body: string | RawMessage

    Body of the QuestBook.
  • options: QuestBookOptions

    Options of the quest book.
  • OptionaliconPath: string

    The icon of the book. It should be the path from the root of the resource pack.

    Example

    texture/gui/example_pic
    Copy

  Returns QuestBook

body

OptionaliconPath

texture/gui/example_pic
Copy

Readonlyid

options

title

addQuest

• addQuest(quest, message?): void

• Add a quest.

  Parameters

  • quest: Quest
  • Optionalmessage: string | RawMessage

    Optional information will be sent to world.

  Returns void

display

• display(player, backTo?): void

• Display the book to the player.

  Parameters

  • player: Player
  • OptionalbackTo: QuestBoard | QuestBookCategory

    The screen player should return to after closing the form.

  Returns void

getQuest

• getQuest(id): undefined | Quest

• Get the quest by id.

  Parameters

  • id: string

  Returns undefined | Quest

getQuests

• getQuests(): Quest[]

• Get all quests.

  Returns Quest[]