Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:structures

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
Next revisionBoth sides next revision
tutorial:structures [2020/09/11 06:47] – 1.16.2 siglongtutorial:structures [2020/11/02 14:17] – Use Biome Modification API in Fabric API siglong
Line 1: Line 1:
-====== Generating Structures ======+====== Adding Structure Features [1.16.3] ======
 We’re going to look at registering and placing structures in your world. We’re going to look at registering and placing structures in your world.
  
Line 7: Line 7:
 The feature handles the process of registering the structure and loading it in when the world is generating. The feature handles the process of registering the structure and loading it in when the world is generating.
 The generator handles the placement of blocks or loading in a structure file if you choose to do so. The generator handles the placement of blocks or loading in a structure file if you choose to do so.
 +
 +Note that this tutorial depends on [[https://github.com/FabricMC/fabric/pull/1097|Biome Modification API in Fabric API]] which is marked as experimental.
 +If the API doesn't work, consider using [[?rev=1599808070|the mixin version]].
  
 ===== Creating a Feature ===== ===== Creating a Feature =====
Line 57: Line 60:
 In this tutorial, we'll use a structure file. In this tutorial, we'll use a structure file.
 It doesn't need to override anything, but does require the following: It doesn't need to override anything, but does require the following:
-  * An Identifier that points to your structure file; use "igloo/top" if you need an example.+  * An identifier that points to your structure file; use ''"igloo/top"'' if you need an example.
   * Some sort of setup method - ''addPieces'' is a good name.   * Some sort of setup method - ''addPieces'' is a good name.
  
Line 103: Line 106:
   private void initializeStructureData(StructureManager structureManager) {   private void initializeStructureData(StructureManager structureManager) {
     Structure structure = structureManager.getStructureOrBlank(this.template);     Structure structure = structureManager.getStructureOrBlank(this.template);
-    StructurePlacementData placementData = (new StructurePlacementData()).setRotation(this.rotation).setMirror(BlockMirror.NONE) +    StructurePlacementData placementData = (new StructurePlacementData()) 
-        .addProcessor(BlockIgnoreStructureProcessor.IGNORE_STRUCTURE_BLOCKS);+      .setRotation(this.rotation) 
 +      .setMirror(BlockMirror.NONE) 
 +      .addProcessor(BlockIgnoreStructureProcessor.IGNORE_STRUCTURE_BLOCKS);
     this.setStructureData(structure, this.pos, placementData);     this.setStructureData(structure, this.pos, placementData);
   }   }
Line 130: Line 135:
  
   * structure   * structure
-  * pieces+  * piece
   * configured structure   * configured structure
  
Line 137: Line 142:
   public static final StructurePieceType MY_PIECE = MyGenerator.MyPiece::new;   public static final StructurePieceType MY_PIECE = MyGenerator.MyPiece::new;
   private static final StructureFeature<DefaultFeatureConfig> MY_STRUCTURE = new MyFeature(DefaultFeatureConfig.CODEC);   private static final StructureFeature<DefaultFeatureConfig> MY_STRUCTURE = new MyFeature(DefaultFeatureConfig.CODEC);
-  public static final ConfiguredStructureFeature<?, ?> MY_CONFIGURED = MY_STRUCTURE.configure(DefaultFeatureConfig.DEFAULT);+  private static final ConfiguredStructureFeature<?, ?> MY_CONFIGURED = MY_STRUCTURE.configure(DefaultFeatureConfig.DEFAULT);
  
   @Override   @Override
Line 148: Line 153:
       .register();       .register();
  
-    BuiltinRegistries.add(BuiltinRegistries.CONFIGURED_STRUCTURE_FEATURE, new Identifier("tutorial", "my_structure"), +    RegistryKey<ConfiguredStructureFeature<?, ?>> myConfigured = RegistryKey.of(Registry.CONFIGURED_STRUCTURE_FEATURE_WORLDGEN, 
-        MY_CONFIGURED);+        new Identifier("tutorial", "my_structure")); 
 +    BuiltinRegistries.add(BuiltinRegistries.CONFIGURED_STRUCTURE_FEATURE, myConfigured.getValue(), MY_CONFIGURED);
   }   }
 } }
 </code> </code>
  
-===== Adding a configured feature to a biome ===== +===== Adding a configured feature to biomes ===== 
-Vanilla features generated in the plain biomes are listed in ''DefaultBiomeFeatures.addPlainsFeatures''. +In this tutorial, we add our structure to all biomes.
-We modify this method to add our structure to the plain biomes.+
  
 <code java> <code java>
-@Mixin(DefaultBiomeFeatures.class) +public class ExampleMod implements ModInitializer { 
-public class DefaultBiomeFeaturesMixin { +  [...] 
-  @Inject(method = "addPlainsFeatures(Lnet/minecraft/world/biome/GenerationSettings$Builder;)V", at = @At("TAIL")) +  
-  private static void addPlainsFeatures(GenerationSettings.Builder builder, CallbackInfo ci) { +  @Override 
-    builder.structureFeature(ExampleMod.MY_CONFIGURED);+  public void onInitialize() { 
 +    [...] 
 + 
 +    BiomeModifications.addStructure(BiomeSelectors.all(), myConfigured);
   }   }
 } }
- 
 </code> </code>
  
 ===== Result ===== ===== Result =====
-You should be met with igloos in the plain biomes.+You should be met with igloos.
 You can use below command to find your structure in the world. You can use below command to find your structure in the world.
  
tutorial/structures.txt · Last modified: 2022/11/05 12:06 by jab125