Dungeon Category
Dungeon Category
Category that groups multiple dungeon instances for display in a global menu.
Campos
| Campo | Tipo | Padrão | Descrição | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
instances | List<DungeonCategorySlot> | empty | List of static dungeon instances in this category
|
| Campo | Tipo | Padrão | Descrição |
|---|---|---|---|
dungeonInstance | Ref<DungeonInstanceEntry> | — | Reference to the dungeon instance |
criteria | List<Criteria> | empty | Criteria to check if the player has unlocked this instance |
unlockedItem | Item | — | Item shown when unlocked |
unlockedName | Var<String> | <green>{dungeon_name} | Name when unlockedPlaceholdersCores |
unlockLore | List<Var<String>> | — | Lore when unlockedPlaceholdersCoresVárias linhas |
lockedItem | Item | — | Item shown when locked |
lockedName | Var<String> | <red>Locked | Name when lockedPlaceholdersCores |
lockLore | List<Var<String>> | — | Lore when lockedPlaceholdersCoresVárias linhas |
How to use it
A category is a list of slots, one per dungeon, shown by a Dungeon Global Menu. Each slot sets the item, name and lore of the dungeon in the menu, in an unlocked and a locked version.
In names and lore, {dungeon_name}, {players} and {max} are replaced, and PlaceholderAPI placeholders work. A slot is shown unlocked when the criteria of the slot match the player (an empty list always matches), and locked otherwise. A locked slot cannot be opened, and the criteria are checked again when the player clicks. Dungeons are ordered by the categoryPriority of each instance.
The lore fields of a slot are unlockLore and lockLore. They were called unlockedLore and lockedLore before Dungeon 1.2: a page saved with the old names still reads its text, and if a slot holds both the old and the new key the new one wins, whatever their order in the file. The page is written with the new names only.