Advancements
These types give a mod advancements: triggers its own server code fires, and the advancement files that use them, written by its data generator. Use them in place of each loader’s criteria trigger registration and of hand-written advancement files, whose formats differ between Minecraft versions.
At a glance
Section titled “At a glance”| Type | Summary | Status | Since | Side | Thread |
|---|---|---|---|---|---|
AdvancementData |
One advancement, built in code and written by a mod’s data generator. | Experimental | 2.7.0 | both | any |
AdvancementTrigger |
A mod’s criteria trigger, fired for a player to meet the advancement criteria that use it. | Experimental | 2.7.0 | server | server |
AdvancementTriggers |
Registers criteria triggers that a mod fires itself. | Experimental | 2.7.0 | both | setup |
Quick start
Section titled “Quick start”In a class your mod’s initializer loads, so the field runs during initialization:
static final AdvancementTrigger GREW_TREE = AdvancementTriggers.register(id("grew_tree"));In your mod’s Fabric data generator, with pack from fabricDataGenerator.createPack():
AdvancementData grewMaple = AdvancementData.builder(id("husbandry/grew_maple")) .parent(Ids.of("minecraft", "husbandry/plant_seed")) .icon(Items.OAK_SAPLING) .title("Maple Syrup Someday") .description("Grow a maple from a sapling") .trigger("grew_maple", GREW_TREE, id("maple")) .build();pack.addProvider((FabricDataOutput output) -> AdvancementData.provider(output, List.of(grewMaple)));Then, in the server code that sees a player grow a maple, with player, that ServerPlayer:
GREW_TREE.fire(player, id("maple"));AdvancementTriggers and AdvancementTrigger
Section titled “AdvancementTriggers and AdvancementTrigger”AdvancementTrigger: Experimental · Since 2.7.0 · Side: server · Thread: server
AdvancementTriggers: Experimental · Since 2.7.0 · Side: both · Thread: setup
AdvancementTriggers#register adds a criteria trigger under the mod’s own ID, and
AdvancementTrigger#fire credits a player. An advancement file names the trigger in a
criterion, with an optional subject:
{ "criteria": { "grew_maple": { "trigger": "mymod:grew_tree", "conditions": { "subject": "mymod:maple" } } }}- One trigger serves many advancements: one per species, each naming its species as the subject.
- A criterion’s
subjectthat is not a valid ID fails the advancement when the server loads it. - The server’s log names the advancement whose
subjectis not a valid ID. - The trigger reads no
playercondition, which vanilla triggers accept.
Performance
Section titled “Performance”- Fire the trigger from the code that already decides the player earned it, with no check of your own first.
AdvancementData
Section titled “AdvancementData”Experimental · Since 2.7.0 · Side: both · Thread: any
AdvancementData builds one advancement in code and writes its file through the data
generator, so players without the mod see the whole advancement on a server.
In the Fabric data generator’s lang provider, with builder, its translation builder, and
advancements, the list given to AdvancementData#provider:
for (AdvancementData advancement : advancements) { builder.add(advancement.titleKey(), advancement.title()); builder.add(advancement.descriptionKey(), advancement.description());}A root for a mod’s own tab, with MAPLE_SAPLINGS, the mod’s item tag:
AdvancementData root = AdvancementData.builder(id("root")) .icon(Items.OAK_SAPLING) .title("Maples") .description("Find a maple sapling") .background(Ids.of("minecraft", "textures/block/moss_block.png")) .hasItemIn("sapling", MAPLE_SAPLINGS) .build();See also
Section titled “See also”- Item events: picking up an item, a place to fire a trigger.
- Movement and block events: a tree grown from a mod’s sapling, another place to fire one.
- Registration and ids:
Ids, for building a subject from a namespace and a path.