Skip to main content

advancement_definition

Type: misc entry Exact entry ID: advancement_definition

Role

This TypeWriter entry is registered in code with the exact display name Advancement Definition.

Verified fields

Exact fieldTypeField guidance
namespaceStringNamespace of the advancement id. Lowercase letters, digits, '_', '.' and '-' only.
keyStringKey of the advancement id, unique within the namespace. '/' creates a folder.
parentRef<AdvancementDefinitionEntry>Advancement this one hangs under. Leave empty to make it the root of its own tab.
iconMaterialItem shown as the advancement icon.
titleStringTitle shown in the tree and on the toast.
descriptionStringDescription shown under the title in the tree.
frameAdvancementFrameFrame drawn around the icon. Challenges use the ornate frame and a distinct toast.
backgroundStringTab background sprite, e.g. 'minecraft:gui/advancements/backgrounds/stone'. Only used on a root advancement.
showToastBooleanWhether earning this advancement pops a toast on screen.
announceToChatBooleanWhether earning this advancement is announced in chat.
hiddenBooleanWhether this advancement stays hidden in the tree until it is earned. Ignored on a root.
autoGrantBooleanEarn this one as soon as the player plays, with no action. Use it on a root so its tab exists from the start.

In practice

Start with the required fields, save the TypeWriter page, and test this entry in the context that triggers it. Select dynamic values and references from the web interface when a selector is available.

Common issue

If advancement_definition is not available, check the installed extension version, the selected TypeWriter category, the exact identifier, and the extension dependencies. An entry from a Soon extension must not be used as an available feature.

Technical reference

Source moduleSource file
Typewriter-QuestCodexExtension-PublicAdvancementDefinitionEntry.kt