Package org.quiltmc.qsl.frozenblock.misc.datafixerupper.api

package org.quiltmc.qsl.frozenblock.misc.datafixerupper.api

Custom DataFixerUpper API

This API lets you register a DataFixer for your own mod, letting you use Minecraft's built-in "old save compatibility" system without bodges!

Here is an example simple use of this API: 


 // the latest version of the mod's data
 // this should match the version of the last schema added!
 // note that the default data version is 0, meaning that you can upgrade
 //  from a version that did not have a fixer
 //  (by registering a schema for upgrading from version 0 to version 1)
 public static final int CURRENT_DATA_VERSION = 1;

 public static void initialize(ModContainer mod) {
     // create a builder
     var builder = new QuiltDataFixerBuilder(CURRENT_DATA_VERSION);
     // add the "base" version 0 schema
     builder.addSchema(0, QuiltDataFixes.BASE_SCHEMA);
     // add a schema for upgrading from version 0 to version 1
     Schema schemaV1 = builder.addSchema(1, IdentifierNormalizingSchema::new)
     // add fixes to the schema - for example, an item rename (identifier change)
     SimpleFixes.addItemRenameFix(builder, "Rename cool_item to awesome_item",
         new Identifier("mymod", "cool_item"),
         new Identifier("mymod", "awesome_item"),
         schemaV1);

     // register the fixer!
     // this will create either an unoptimized fixer or an optimized fixer,
     //  depending on the game configuration
     QuiltDataFixes.buildAndRegisterFixer(mod, builder);
 }
See Also:
  • Classes
    Class
    Description
    EmptySchema
    Represents an empty Schema, having no parent and containing no type definitions.
    FirstSchema
    Represents a Schema that has no parent.
    QuiltDataFixerBuilder
    An extended variant of the DataFixerBuilder class, which provides an extra method.
    QuiltDataFixes
    Provides methods to register custom DataFixers.
    SimpleFixes
    Provides methods to add common DataFixes to DataFixerBuilders.