Discovery Codex Open

Open a discovery codex category

AçãoFornecido por Codex

Action entry that opens a discovery codex category for a player. Can be triggered from quests, NPCs, items, or other Typewriter systems.

Campos

Campo	Tipo	Padrão	Descrição
definition	Ref<DiscoveryCodexDefinition>	—	Category to open (reference to a DiscoveryCodexDefinition) DiscoveryCodexDefinition (34) Campo Tipo Padrão Descrição category String — Unique identifier for this discovery category title String — Title displayed at the top of the inventoryPlaceholders rows Int 6 Number of rows for the inventory (1-6) order Int 0 Display order when listing categories icon Item — Icon used when referencing this category iconName String? — Optional custom name for the icon when displayed in menus. Placeholders: {unlocked}, {locked}, {total}, {percent}Placeholders iconLore List<String> empty Optional lore lines for the icon when displayed in menus. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas lockedIconLore List<String> empty Lore to display for the icon when the category is locked. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas background Item? — Optional background filler item itemSlotRange String — Range of slots where discovery items will be displayed (e.g. '1-25') startSlot Int 0 Slot index where items start (0-based) fillByRow Boolean true If true, items fill row by row; otherwise column by column previousButton Item? — Item used for the previous page button previousButtonSlot Int 0 Slot for the previous page button previousButtonName String? — Custom name for the previous page button. Placeholders: {page}, {max_page}, {unlocked}, {locked}, {total}, {percent}Placeholders previousButtonLore List<String> empty Lore for the previous page button. Placeholders: {page}, {max_page}, {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas nextButton Item? — Item used for the next page button nextButtonSlot Int 8 Slot for the next page button nextButtonName String? — Custom name for the next page button. Placeholders: {page}, {max_page}, {unlocked}, {locked}, {total}, {percent}Placeholders nextButtonLore List<String> empty Lore for the next page button. Placeholders: {page}, {max_page}, {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas backButton Item? — Item used for the back button backButtonSlot Int 44 Slot for the back button (default: 44, bottom-right area) backButtonName String? — Custom name for the back buttonPlaceholders backButtonLore List<String> empty Lore for the back buttonPlaceholdersVárias linhas infoButton Item? — Item used for the info button infoButtonSlot Int 4 Slot for the info button infoButtonName String? — Custom name for the info button. Placeholders: {unlocked}, {locked}, {total}, {percent}Placeholders infoButtonLore List<String> empty Lore for the info button. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas parentCategory String? — Optional parent category identifier; if set, this category becomes a sub category criteria List<Criteria> empty Criteria that must be met for this category to be unlocked items List<DiscoveryItemConfig> empty Items contained within this category DiscoveryItemConfig (10) Campo Tipo Padrão Descrição entryId String — Unique identifier for this discovery item item Item — Base item to display in the codex overrideName String? — Optional display name override. Placeholders: {unlocked}, {locked}, {total}, {percent}Placeholders overrideLore List<String> empty Lore to override the item's default lore when unlocked. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas overrideOrder Int? — Display order override lockedLore List<String> empty Lore to display when the item is locked. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas unlockedLore List<String> empty Lore to append when the item is unlocked. Placeholders: {unlocked}, {locked}, {total}, {percent}PlaceholdersVárias linhas criteria List<Criteria> empty Criteria that need to be met for the item to be unlocked (Typewriter facts) lockedItem Item? — Optional item to display when the entry is locked onUnlockTriggers List<Ref<TriggerableEntry>> empty Triggers to fire when this specific item is unlocked by a player guiLayout CodexGuiLayout PAGINATED GUI layout type for the codex menuValores:PAGINATEDSCROLLABLEFRAMESIMPLE onUnlockTriggers List<Ref<TriggerableEntry>> empty Triggers to fire when this category is unlocked by a player baseMenuId String — Entrée open_gui servant de châssis partagé (ex. menu_shell). Vide = la catégorie s'ouvre en inventaire autonome (comportement historique). Renseigné = la catégorie devient un écran du menu global : son propre plan de slots (itemSlotRange/boutons) doit alors tenir dans la zone de contenu du châssis (rows ≤ 3), pas l'inventaire entier.
titleOverride	String	—	Optional title override for the menuPlaceholders
sound	String	—	Sound to play when opening the codex, as a namespaced key such as 'minecraft:item.book.page_turn'. Empty = no sound
soundVolume	Float	1.0	Volume of the opening sound (1.0 = normal)
soundPitch	Float	1.0	Pitch of the opening sound (1.0 = normal)

Campos comuns do TypeWriter (criteria, modifiers, triggers)

Campo	Tipo	Padrão	Descrição
criteria	List<Criteria>	empty	—
modifiers	List<Modifier>	empty	—
triggers	List<Ref<TriggerableEntry>>	empty	—

How to use it

Set definition to a Discovery Codex Category. The menu opens only if the category's criteria are met for the player.

• titleOverride replaces the title of the opened codex (MiniMessage and placeholders). Empty keeps the title of the category.
• sound is a namespaced sound key such as minecraft:item.book.page_turn, played once when the codex opens. Empty plays nothing. An invalid key writes a warning in the console and the codex opens anyway.
• soundVolume (default 1.0, never below 0) and soundPitch (default 1.0, kept between 0.5 and 2) tune that sound.