Fabric Wiki

User Tools

Site Tools

Trace: • fabric.mod.json
tutorial:custom_model

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
tutorial:custom_model [2023/06/25 21:41] – fix typo (EntType -> EnvType) andrew6ranttutorial:custom_model [2023/12/31 21:40] – [Sprites] Missed `int`s gudenau
Line 22: Line 22:
             new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("minecraft:block/furnace_top"))             new SpriteIdentifier(SpriteAtlasTexture.BLOCK_ATLAS_TEXTURE, new Identifier("minecraft:block/furnace_top"))
     };     };
-    private Sprite[] SPRITES = new Sprite[2];+    private final Sprite[] sprites = new Sprite[SPRITE_IDS.length]; 
 + 
 +    // Some constants to avoid magic numbers, these need to match the SPRITE_IDS 
 +    private static final int SPRITE_SIDE = 0; 
 +    private static final int SPRITE_TOP = 1; 
 </code> </code>
  
Line 35: Line 40:
     @Override     @Override
     public Collection<Identifier> getModelDependencies() {     public Collection<Identifier> getModelDependencies() {
-        return Collections.emptyList(); // This model does not depend on other models.+        return List.of(); // This model does not depend on other models.
     }     }
  
     @Override     @Override
-    public Collection<SpriteIdentifier> getTextureDependencies(Function<Identifier, UnbakedModel> unbakedModelGetter, Set<Pair<String, String>> unresolvedTextureReferences) { +    public void setParents(Function<Identifier, UnbakedModel> modelLoader) { 
-        return Arrays.asList(SPRITE_IDS); // The textures this model (and all its model dependencies, and their dependencies, etc...!) depends on.+        // This is related to model parents, it's not required for our use case
     }     }
  
Line 47: Line 52:
     public BakedModel bake(ModelLoader loader, Function<SpriteIdentifier, Sprite> textureGetter, ModelBakeSettings rotationContainer, Identifier modelId) {     public BakedModel bake(ModelLoader loader, Function<SpriteIdentifier, Sprite> textureGetter, ModelBakeSettings rotationContainer, Identifier modelId) {
         // Get the sprites         // Get the sprites
-        for(int i = 0; i < 2; ++i) { +        for(int i = 0; i < SPRITE_IDS.length; ++i) { 
-            SPRITES[i] = textureGetter.apply(SPRITE_IDS[i]);+            sprites[i] = textureGetter.apply(SPRITE_IDS[i]);
         }         }
         // Build the mesh using the Renderer API         // Build the mesh using the Renderer API
Line 56: Line 61:
  
         for(Direction direction : Direction.values()) {         for(Direction direction : Direction.values()) {
-            int spriteIdx = direction == Direction.UP || direction == Direction.DOWN ? 1 : 0;+            // UP and DOWN share the Y axis 
 +            int spriteIdx = direction == Direction.UP || direction == Direction.DOWN ? SPRITE_TOP : SPRITE_SIDE;
             // Add a new face to the mesh             // Add a new face to the mesh
             emitter.square(direction, 0.0f, 0.0f, 1.0f, 1.0f, 0.0f);             emitter.square(direction, 0.0f, 0.0f, 1.0f, 1.0f, 0.0f);
             // Set the sprite of the face, must be called after .square()             // Set the sprite of the face, must be called after .square()
             // We haven't specified any UV coordinates, so we want to use the whole texture. BAKE_LOCK_UV does exactly that.             // We haven't specified any UV coordinates, so we want to use the whole texture. BAKE_LOCK_UV does exactly that.
-            emitter.spriteBake(0, SPRITES[spriteIdx], MutableQuadView.BAKE_LOCK_UV);+            emitter.spriteBake(sprites[spriteIdx], MutableQuadView.BAKE_LOCK_UV);
             // Enable texture usage             // Enable texture usage
-            emitter.spriteColor(0, -1, -1, -1, -1);+            emitter.color(-1, -1, -1, -1);
             // Add the quad to the mesh             // Add the quad to the mesh
             emitter.emit();             emitter.emit();
Line 72: Line 78:
     }     }
 </code> </code>
- 
-Note that the type parameter "''Pair''" in ''getTextureDependencies'' method is ''com.mojang.datafixers.util.Pair'' instead of ''net.minecraft.util.Pair''. 
  
 ==== BakedModel methods ==== ==== BakedModel methods ====
Line 81: Line 85:
     public List<BakedQuad> getQuads(BlockState state, Direction face, Random random) {     public List<BakedQuad> getQuads(BlockState state, Direction face, Random random) {
         // Don't need because we use FabricBakedModel instead. However, it's better to not return null in case some mod decides to call this function.         // Don't need because we use FabricBakedModel instead. However, it's better to not return null in case some mod decides to call this function.
-        return Collections.emptyList();+        return List.of();
     }     }
  
Line 106: Line 110:
     @Override     @Override
     public Sprite getParticleSprite() {     public Sprite getParticleSprite() {
-        return SPRITES[1]; // Block break particle, let's use furnace_top+        return sprites[SPRITE_TOP]; // Block break particle, let's use furnace_top
     }     }
  
Line 132: Line 136:
                  
         // We just render the mesh         // We just render the mesh
-        renderContext.meshConsumer().accept(mesh);+        mesh.outputTo(context.getEmitter());
     }     }
  
Line 141: Line 145:
 } }
 </code> </code>
 +
 +Note: Make sure you override the ''FabricBakedModel'' methods, the interface has ''default'' implementations!
  
 ===== Registering the model ===== ===== Registering the model =====
-Let's first write a ''ModelResourceProvider'', an interface that allows you to provide an ''UnbakedModel'' before the game tries to load it from JSON. Have a look at [[https://github.com/FabricMC/fabric/blob/1.16/fabric-models-v0/src/main/java/net/fabricmc/fabric/api/client/model/ModelResourceProvider.java|the documentation]] for more details. The important part is that ''loadModelResource()'' will be called for every model. +In order for the model to be rendered in game we need to register it. In order to register it you need to create a ''ModelLoadingPlugin'':
- +
-Let's register the model under the name ''tutorial:block/four_sided_furnace''.+
 <code java> <code java>
 @Environment(EnvType.CLIENT) @Environment(EnvType.CLIENT)
-public class TutorialModelProvider implements ModelResourceProvider { +public class TutorialModelLoadingPlugin impelements ModelLoadingPlugin { 
-    public static final Identifier FOUR_SIDED_FURNACE_MODEL = new Identifier("tutorial:block/four_sided_furnace");+    public static final ModelIdentifier FOUR_SIDED_FURNACE_MODEL = new ModelIdentifier("tutorial", "four_sided_furnace", ""); 
     @Override     @Override
-    public UnbakedModel loadModelResource(Identifier identifier, ModelProviderContext modelProviderContext) throws ModelProviderException { +    public void onInitializeModelLoader(Context pluginContext) { 
-        if(identifier.equals(FOUR_SIDED_FURNACE_MODEL)) { +        // We want to add our model when the models are loaded 
-            return new FourSidedFurnaceModel(); +        pluginContext.modifyModelOnLoad().register((original, context) -> { 
-        } else { +            // This is called for every model that is loaded, so make sure we only target ours 
-            return null; +            if(context.id().equals(FOUR_SIDED_FURNACE_MODEL)) { 
-        }+                return new FourSidedFurnaceModel(); 
 +            } else { 
 +                // If we don't modify the model we just return the original as-is 
 +                return original; 
 +            } 
 +        });
     }     }
 } }
 </code> </code>
  
-Now we have to register this class in the client initializer, the entry point for client-specific code.+Then you need to register the plugin we just created:
 <code java> <code java>
 @Environment(EnvType.CLIENT) @Environment(EnvType.CLIENT)
Line 167: Line 177:
     @Override     @Override
     public void onInitializeClient() {     public void onInitializeClient() {
-        ModelLoadingRegistry.INSTANCE.registerResourceProvider(rm -> new TutorialModelProvider()); +        ModelLoadingPlugin.register(new TutorialModelLoadingPlugin()); 
-        + 
         /* Other client-specific initialization */         /* Other client-specific initialization */
     }     }
Line 228: Line 238:
     @Override     @Override
     public void emitItemQuads(ItemStack itemStack, Supplier<Random> supplier, RenderContext renderContext) {     public void emitItemQuads(ItemStack itemStack, Supplier<Random> supplier, RenderContext renderContext) {
-        renderContext.meshConsumer().accept(mesh);+        mesh.outputTo(context.getEmitter());
     }     }
 </code> </code>
Line 238: Line 248:
 public class TutorialModelProvider implements ModelResourceProvider { public class TutorialModelProvider implements ModelResourceProvider {
     public static final FourSidedFurnaceModel FOUR_SIDED_FURNACE_MODEL = new FourSidedFurnaceModel();     public static final FourSidedFurnaceModel FOUR_SIDED_FURNACE_MODEL = new FourSidedFurnaceModel();
-    public static final Identifier FOUR_SIDED_FURNACE_MODEL_BLOCK = new Identifier("tutorial:block/four_sided_furnace"); +    public static final ModelIdentifier FOUR_SIDED_FURNACE_MODEL_BLOCK = new ModelIdentifier("tutorial", "four_sided_furnace", ""); 
-    public static final Identifier FOUR_SIDED_FURNACE_MODEL_ITEM = new Identifier("tutorial:item/four_sided_furnace");+    public static final ModelIdentifier FOUR_SIDED_FURNACE_MODEL_ITEM = new ModelIdentifier("tutorial", "four_sided_furnace", "inventory");
  
     @Override     @Override
tutorial/custom_model.txt · Last modified: 2024/04/27 08:58 by florens