Generazione di Modelli di Blocchi 1.21.4

Una guida alla generazione di modelli e stati di blocchi tramite datagen.

WARNING

Questa pagina si applica alla versione 1.21.4. La documentazione delle versioni meno recenti potrebbe essere incompleta.

PREREQUISITI

Assicurati di aver prima completato il processo di configurazione della datagen.

Configurazione

Anzitutto, avremo bisogno di creare il nostro ModelProvider. Crea una classe che extends FabricModelProvider. Implementa entrambi i metodi astratti: generateBlockStateModels e generateItemModels. Infine, crea un costruttore che corrisponda a super.

public class FabricDocsReferenceModelProvider extends FabricModelProvider {
	public FabricDocsReferenceModelProvider(FabricDataOutput output) {
		super(output);
	}

	@Override
	public void generateBlockStateModels(BlockModelGenerators blockStateModelGenerator) {
	}


	@Override
	public void generateItemModels(ItemModelGenerators itemModelGenerator) {
	}

	@Override
	public String getName() {
		return "FabricDocsReference Model Provider";
	}
}

Registra questa classe nella tua DataGeneratorEntrypoint all'interno del metodo onInitializeDataGenerator.

Stati e Modelli dei Blocchi

@Override
public void generateBlockStateModels(BlockStateModelGenerator blockStateModelGenerator) {
}

Per i modelli dei blocchi ci concentreremo soprattutto sul metodo generateBlockStateModels. Nota il parametro BlockStateModelGenerator blockStateModelGenerator - questo oggetto sarà responsabile della generazione di tutti i file JSON. Ecco alcuni esempi utili che puoi usare per generare i tuoi modelli desiderati:

Cubo Intero Semplice

blockStateModelGenerator.createTrivialCube(ModBlocks.STEEL_BLOCK);

Questa è la funzione usata più spesso. Essa genera un file JSON per un semplice modello cube_all di un blocco. Una texture viene usata per tutti e sei le facce, in questo caso useremo steel_block.

{
  "parent": "minecraft:block/cube_all",
  "textures": {
    "all": "fabric-docs-reference:block/steel_block"
  }
}

Essa genera anche un file JSON dei stati del blocco. Poiché non abbiamo alcuna proprietà per gli stati del blocco (per esempio Asse, Orientazione, ...), ci basta una variante che verrà usata ogni volta che il blocco è piazzato.

{
  "variants": {
    "": {
      "model": "fabric-docs-reference:block/steel_block"
    }
  }
}

Scarica Blocco d'Acciaio

Singleton

Il metodo registerSingleton fornisce file JSON di modelli in base al TexturedModel che passi, e una singola variante di stato di blocco.

blockStateModelGenerator.createTrivialBlock(ModBlocks.PIPE_BLOCK, TexturedModel.COLUMN_ALT);

Questo metodo genererà modelli per un cubo normale, che usa il file di texture pipe_block per i lati e pipe_block_top per le facce superiore e inferiore.

{
  "parent": "minecraft:block/cube_column",
  "textures": {
    "end": "fabric-docs-reference:block/pipe_block_top",
    "side": "fabric-docs-reference:block/pipe_block"
  }
}

TIP

Se non sai quale TextureModel dovresti scegliere, apri la classe TexturedModel e dai un'occhiata alle TextureMaps!

Scarica Blocco di Tubatura

Pool di Texture dei Blocchi

blockStateModelGenerator.family(ModBlocks.RUBY_BLOCK)
		.stairs(ModBlocks.RUBY_STAIRS)
		.slab(ModBlocks.RUBY_SLAB)
		.fence(ModBlocks.RUBY_FENCE);

Un altro metodo utile è registerCubeAllModelTexturePool: definisce le texture passandoci il "blocco di base", per poi aggiungerci i "figli", che avranno le stesse texture. In questo caso, abbiamo passato il RUBY_BLOCK, quindi scalini, lastra e staccionata useranno la texture RUBY_BLOCK.

WARNING

Genererà anche un modello JSON per un cubo intero semplice per il "blocco di base" per assicurarsi che il blocco abbia un modello.

Tieni conto di questo se vuoi cambiare il modello di quel blocco in particolare, poiché causerà un errore.

Puoi anche aggiungere una BlockFamily, che genererà modelli per tutti i suoi "figli".

public static final BlockFamily RUBY_FAMILY =
		new BlockFamily.Builder(ModBlocks.RUBY_BLOCK)
		.stairs(ModBlocks.RUBY_STAIRS)
		.slab(ModBlocks.RUBY_SLAB)
		.fence(ModBlocks.RUBY_FENCE)
		.getFamily();

blockStateModelGenerator.family(ModBlocks.RUBY_BLOCK).generateFor(ModBlocks.RUBY_FAMILY);

Scarica Blocco di Rubino

Porte e Botole

blockStateModelGenerator.createDoor(ModBlocks.RUBY_DOOR);
blockStateModelGenerator.createTrapdoor(ModBlocks.RUBY_TRAPDOOR);
// blockStateModelGenerator.registerOrientableTrapdoor(ModBlocks.RUBY_TRAPDOOR);

Le porte e botole funzionano un po' diversamente. Qui, dovrai creare tre nuove texture - due per la porta, e una per la botola.

1. La porta:

• Ha due parti - la metà superiore e quella inferiore. Ciascuna necessita di una texture propria: in questo caso ruby_door_top per la metà superiore e ruby_door_bottom per l'inferiore.
• Il metodo registerDoor() creerà modelli per tutte le orientazioni della porta, sia aperta che chiusa.
• Servirà anche una texture per l'oggetto! Mettila nella cartella assets/mod-id/textures/item/.

2. La botola:

• Qui ti basta una texture sola, in questo caso chiamata ruby_trapdoor. Verrà usata per tutti i lati.
• Poiché il TrapdoorBlock ha una proprietà FACING, puoi usare il metodo commentato per generare file di modello con texture ruotate = la botola sarà "orientabile". Altrimenti avrà lo stesso aspetto in tutte le direzioni.

Scarica Porta e Botola di Rubino

Modelli del Blocco Personalizzati

In questa sezione creeremo i modelli per una Lastra Verticale di Quercia, con texture di un Tronco di Quercia.

I punti 2. - 6. sono dichiarati in una classe ausiliaria interna chiamata CustomBlockStateModelGenerator.

Classe dei Blocchi Personalizzati

Crea un blocco VerticalSlab con una proprietà FACING e una proprietà booleana SINGLE, come nel tutorial degli Stati dei Blocchi. SINGLE indicherà se ci sono entrambe le lastre. Poi dovresti fare override di getOutlineShape e getCollisionShape, cosicché il contorno sia renderizzato correttamente, e il blocco abbia la forma di collisione corretta.

public static final VoxelShape NORTH_SHAPE = Block.box(0.0, 0.0, 0.0, 16.0, 16.0, 8.0);
public static final VoxelShape SOUTH_SHAPE = Block.box(0.0, 0.0, 8.0, 16.0, 16.0, 16.0);
public static final VoxelShape WEST_SHAPE = Block.box(0.0, 0.0, 0.0, 8.0, 16.0, 16.0);
public static final VoxelShape EAST_SHAPE = Block.box(8.0, 0.0, 0.0, 16.0, 16.0, 16.0);

@Override
protected VoxelShape getBlockSupportShape(BlockState state, BlockGetter world, BlockPos pos) {
	boolean type = state.getValue(SINGLE);
	Direction direction = state.getValue(FACING);
	VoxelShape voxelShape;

	if (type) {
		switch (direction) {
			case WEST -> voxelShape = WEST_SHAPE.singleEncompassing();
			case EAST -> voxelShape = EAST_SHAPE.singleEncompassing();
			case SOUTH -> voxelShape = SOUTH_SHAPE.singleEncompassing();
			case NORTH -> voxelShape = NORTH_SHAPE.singleEncompassing();
			default -> throw new MatchException(null, null);
		}

		return voxelShape;
	} else {
		return Shapes.block();
	}
}

@Override
protected VoxelShape getShape(BlockState state, BlockGetter world, BlockPos pos, CollisionContext context) {
	return this.getBlockSupportShape(state, world, pos);
}

@Override
protected VoxelShape getCollisionShape(BlockState state, BlockGetter world, BlockPos pos, CollisionContext context) {
	return this.getBlockSupportShape(state, world, pos);
}

Fai anche override del metodo canReplace(), altrimenti non potresti rendere la lastra un blocco intero.

@Override
protected boolean canBeReplaced(BlockState state, BlockPlaceContext context) {
	Direction direction = state.getValue(FACING);

	if (context.getItemInHand().is(this.asItem()) && state.getValue(SINGLE)) {
		if (context.replacingClickedOnBlock()) {
			return context.getClickedFace().getOpposite() == direction;
		}
	}

	return false;
}

Tutto fatto! Ora puoi testare il blocco e piazzarlo nel gioco.

Modello di Blocco Genitore

Ora creiamo un modello di blocco genitore. Esso determinerà la dimensione, posizione nella mano o in altri slot e le coordinate x e y della texture. Si consiglia, per questo, di usare un editor come Blockbench poiché crearlo manualmente è davvero faticoso. Dovrebbe avere un aspetto del genere:

{
  "parent": "minecraft:block/block",
  "textures": {
    "particle": "#side"
  },
  "display": {
    "gui": {
      "rotation": [
        30,
        -135,
        0
      ],
      "translation": [
        -1.5,
        0.75,
        0
      ],
      "scale": [
        0.625,
        0.625,
        0.625
      ]
    },
    "firstperson_righthand": {
      "rotation": [
        0,
        -45,
        0
      ],
      "translation": [
        0,
        2,
        0
      ],
      "scale": [
        0.375,
        0.375,
        0.375
      ]
    },
    "firstperson_lefthand": {
      "rotation": [
        0,
        315,
        0
      ],
      "translation": [
        0,
        2,
        0
      ],
      "scale": [
        0.375,
        0.375,
        0.375
      ]
    },
    "thirdperson_righthand": {
      "rotation": [
        75,
        -45,
        0
      ],
      "translation": [
        0,
        0,
        2
      ],
      "scale": [
        0.375,
        0.375,
        0.375
      ]
    },
    "thirdperson_lefthand": {
      "rotation": [
        75,
        315,
        0
      ],
      "translation": [
        0,
        0,
        2
      ],
      "scale": [
        0.375,
        0.375,
        0.375
      ]
    }
  },
  "elements": [
    {
      "from": [
        0,
        0,
        0
      ],
      "to": [
        16,
        16,
        8
      ],
      "faces": {
        "down": {
          "uv": [
            0,
            8,
            16,
            16
          ],
          "texture": "#bottom",
          "cullface": "down",
          "tintindex": 0
        },
        "up": {
          "uv": [
            0,
            0,
            16,
            8
          ],
          "texture": "#top",
          "cullface": "up",
          "tintindex": 0
        },
        "north": {
          "uv": [
            0,
            0,
            16,
            16
          ],
          "texture": "#side",
          "cullface": "north",
          "tintindex": 0
        },
        "south": {
          "uv": [
            0,
            0,
            16,
            16
          ],
          "texture": "#side",
          "tintindex": 0
        },
        "west": {
          "uv": [
            0,
            0,
            8,
            16
          ],
          "texture": "#side",
          "cullface": "west",
          "tintindex": 0
        },
        "east": {
          "uv": [
            8,
            0,
            16,
            16
          ],
          "texture": "#side",
          "cullface": "east",
          "tintindex": 0
        }
      }
    }
  ]
}

Controlla il formato degli stati del blocco per maggiori informazioni. Nota le parole chiave #bottom, #top, #side. Queste saranno variabili impostabili in modelli che ereditino da questo genitore:

{
  "parent": "minecraft:block/cube_bottom_top",
  "textures": {
    "bottom": "minecraft:block/sandstone_bottom",
    "side": "minecraft:block/sandstone",
    "top": "minecraft:block/sandstone_top"
  }
}

Il valore bottom sostituirà il segnaposto #bottom eccetera. Mettilo nella cartella resources/assets/mod-id/models/block/.

Modello Personalizzato

Un'altra cosa che ci serve è un'istanza della classe Model. Essa rappresenterà proprio il modello di blocco genitore nella nostra mod.

public static final ModelTemplate VERTICAL_SLAB = block("vertical_slab", TextureSlot.BOTTOM, TextureSlot.TOP, TextureSlot.SIDE);

//helper method for creating Models
private static ModelTemplate block(String parent, TextureSlot... requiredTextureKeys) {
	return new ModelTemplate(Optional.of(ResourceLocation.fromNamespaceAndPath(FabricDocsReference.MOD_ID, "block/" + parent)), Optional.empty(), requiredTextureKeys);
}

//helper method for creating Models with variants
private static ModelTemplate block(String parent, String variant, TextureSlot... requiredTextureKeys) {
	return new ModelTemplate(Optional.of(ResourceLocation.fromNamespaceAndPath(FabricDocsReference.MOD_ID, "block/" + parent)), Optional.of(variant), requiredTextureKeys);
}

Il metodo block() crea un nuovo Model, puntando al file vertical_slab.json nella cartella resources/assets/mod-id/models/block/. Le TextureKey rappresentano i "segnaposto" (#bottom, #top, ...) come oggetti.

Usare le Mappe di Texture

Cosa fa TextureMap? In effetti fornisce gli identificativi che puntano alle texture. Tecnicamente funziona proprio come una mappa normale - si associa una TextureKey (chiave) con un ResourceLocation (valore).

Puoi usare quelle vanilla, come TextureMap.all()(che associa tute le TextureKey allo stesso ResourceLocation), o crearne una nuova creandone una nuova istanza e usando .put() per associare valori alle chiavi.

TIP

TextureMap.all() associa tutte le TextureKey allo stesso ResourceLocation, indipendentemente dalla loro quantità!

Poiché vogliamo usare le texture del Tronco di Quercia, ma abbiamo le TextureKey BOTTOM, TOP e SIDE, ne dovremo creare un'altra.

public static TextureMapping blockAndTopForEnds(Block block) {
	return new TextureMapping()
			.put(TextureSlot.TOP, ModelLocationUtils.getModelLocation(block, "_top"))
			.put(TextureSlot.BOTTOM, ModelLocationUtils.getModelLocation(block, "_top"))
			.put(TextureSlot.SIDE, ModelLocationUtils.getModelLocation(block));
}

Le facce bottom e top useranno oak_log_top.png, i lati useranno oak_log.png.

WARNING

Tutte le TextureKey nella TextureMap devono corrispondere a tutte le TextureKey nel tuo modello di blocco genitore!

Metodo BlockStateSupplier Personalizzato

Il BlockStateSupplier contiene tutte le varianti degli stati del blocco, le rotazioni, e altre opzioni come uvlock.

private static BlockStateGenerator createVerticalSlabBlockStates(Block vertSlabBlock, ResourceLocation vertSlabId, ResourceLocation fullBlockId) {
	VariantProperty<Boolean> uvlock = VariantProperties.UV_LOCK;
	VariantProperty<VariantProperties.Rotation> yRot = VariantProperties.Y_ROT;
	return MultiVariantGenerator.multiVariant(vertSlabBlock).with(PropertyDispatch.properties(VerticalSlabBlock.FACING, VerticalSlabBlock.SINGLE)
			.select(Direction.NORTH, true, Variant.variant().with(VariantProperties.MODEL, vertSlabId).with(uvlock, true))
			.select(Direction.EAST, true, Variant.variant().with(VariantProperties.MODEL, vertSlabId).with(uvlock, true).with(yRot, VariantProperties.Rotation.R90))
			.select(Direction.SOUTH, true, Variant.variant().with(VariantProperties.MODEL, vertSlabId).with(uvlock, true).with(yRot, VariantProperties.Rotation.R180))
			.select(Direction.WEST, true, Variant.variant().with(VariantProperties.MODEL, vertSlabId).with(uvlock, true).with(yRot, VariantProperties.Rotation.R270))
			.select(Direction.NORTH, false, Variant.variant().with(VariantProperties.MODEL, fullBlockId).with(uvlock, true))
			.select(Direction.EAST, false, Variant.variant().with(VariantProperties.MODEL, fullBlockId).with(uvlock, true))
			.select(Direction.SOUTH, false, Variant.variant().with(VariantProperties.MODEL, fullBlockId).with(uvlock, true))
			.select(Direction.WEST, false, Variant.variant().with(VariantProperties.MODEL, fullBlockId).with(uvlock, true)));
}

Anzitutto creeremo un nuovo VariantsBlockStateSupplier tramite VariantsBlockStateSupplier.create(). Poi creeremo una nuova BlockStateVariantMap che contiene parametri per tutte le varianti del blocco, in questo caso FACING e SINGLE, e la passeremo nel nostro VariantsBlockStateSupplier. Puoi indicare il modello e le trasformazioni (uvlock, rotazione) da usare in .register(). Per esempio:

• Sulla prima linea, il blocco è in direzione nord, ed è singolo => useremo il modello senza ruotarlo.
• Sulla quarta linea, il blocco è in direzione ovest, ed è singolo => ruoteremo il modello di 270° sull'asse Y.
• Sulla sesta linea, il blocco è in direzione est, ma non è singolo => sembra un normale tronco di quercia => non dobbiamo ruotarlo.

Metodo di Generazione Dati Personalizzato

L'ultimo passaggio - creare effettivamente un metodo che si possa chiamare e che generi i JSON. Ma che parametri sono necessari?

1. BlockStateModelGenerator generator, quello che abbiamo passato in generateBlockStateModels.
2. Block vertSlabBlock è il blocco di cui genereremo i JSON.
3. Block fullBlock - il modello usato quando la proprietà SINGLE è falsa = il blocco di lastre sembra un blocco intero.
4. TextureMap textures definisce le texture che il modello usa effettivamente. Controlla il capitolo Usare le Mappe di Texture.

public static void registerVerticalSlab(BlockModelGenerators generator, Block vertSlabBlock, Block fullBlock, TextureMapping textures) {
	ResourceLocation slabModel = VERTICAL_SLAB.create(vertSlabBlock, textures, generator.modelOutput);
	ResourceLocation fullBlockModel = ModelLocationUtils.getModelLocation(fullBlock);
	generator.blockStateOutput.accept(createVerticalSlabBlockStates(vertSlabBlock, slabModel, fullBlockModel));
	generator.registerSimpleItemModel(vertSlabBlock, slabModel);
}

Anzitutto, otteniamo l'ResourceLocation del modello di lastra singola con VERTICAL_SLAB.upload(). Poi otteniamo l'ResourceLocation del modello di blocco intero con ModelIds.getBlockModelId(), e passiamo entrambi i modelli in createVerticalSlabBlockStates. Il BlockStateSupplier viene passato nel blockStateCollector, di modo che i file JSON vengano effettivamente generati. Inoltre, creiamo un modello per l'oggetto di lastra verticale con BlockStateModelGenerator.registerParentedItemModel().

È tutto! Tutto ciò che rimane da fare è chiamare il metodo nel nostro ModelProvider:

CustomBlockStateModelGenerator.registerVerticalSlab(
		blockStateModelGenerator,
		ModBlocks.VERTICAL_OAK_LOG_SLAB,
		Blocks.OAK_LOG,
		CustomBlockStateModelGenerator.blockAndTopForEnds(Blocks.OAK_LOG)
);

Fonti e Link

Per maggiori informazioni, puoi trovare il test di esempio nell'API di Fabric e nella Mod di Riferimento di questa documentazione.

Puoi anche trovare altri esempi dell'uso di metodi di datagen personalizzati navigando il codice sorgente aperto delle mod, per esempio di Vanilla+ Blocks e Vanilla+ Verticals di Fellteros.