Saltar al contenido principal

Quest Category

Quest Category

Defines a quest category. A category groups quests together in the codex. Categories can be nested via [parent] to create sub-categories. To add quests to this category, use [QuestAssignmentEntry]. To configure the menu for this category, use [CategoryMenuEntry]. Example: quest_category: category: "main_quests" title: "<gold>Main Story" icon: GOLDEN_SWORD order: 0 quest_category: category: "side_quests" title: "<aqua>Side Quests" icon: BOOK parent: "main_quests" order: 1

Campos

CampoTipoPredeterminadoDescripción
categoryString—Unique category identifier (lowercase, no spaces).
titleString—Display title shown in the codex menu.PlaceholdersColores
iconItem—Item used as the category icon in menus.
parentString—Parent category name. Leave empty for a top-level category.
orderInt0Display order (lower = first). Categories with the same order are sorted alphabetically.
activeCriteriaList<Criteria>emptyCriteria required for this category to be visible.
completedCriteriaList<Criteria>emptyCriteria required for this category to be marked as completed.
blockedMessageString—Message shown when the category is locked (player does not meet active criteria).PlaceholdersColoresVarias líneas
activeMessageString—Message shown when the category is in progress.PlaceholdersColoresVarias líneas
completedMessageString—Message shown when the category is completed.PlaceholdersColoresVarias líneas
hideWhenLockedBooleanfalseWhether to hide this category when locked.

How to use it​

category is the identifier used everywhere else: by Quest Assignment entries, Category Menus, /tw codex <category> and placeholders. Keep it lowercase without spaces. Names are matched without regard to case.

  • parent nests the category. Only top-level categories (empty parent) appear on the main menu, and a category lists the quests of its sub-categories too.
  • order sorts categories, lower first. A category with 0 comes after those with a number, and ties are sorted by category.
  • activeCriteria decides when the category is open. When they do not match, the category is blocked and blockedMessage is shown in its lore, and hideWhenLocked hides it altogether.
  • completedCriteria marks it completed, with completedMessage. Otherwise activeMessage is shown.