Creare il Tuo Primo Oggetto 1.21.8

Impara come registrare un semplice oggetto e come aggiungergli texture, modello e nome.

WARNING

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

Questa pagina ti presenterà alcuni concetti chiave legati agli oggetti, e come registrargli e aggiungere loro texture, modello e nome.

Se non ne sei al corrente, tutto in Minecraft è memorizzato in registry, e gli oggetti non fanno eccezione.

Preparare la Tua Classe dei Oggetti

Per semplificare la registrazione degli oggetti, puoi creare un metodo che accetta una stringa come identificatore, delle impostazioni dell'oggetto e una fabbrica per creare l'istanza Item.

Questo metodo creerà un oggetto con l'identificatore fornito e lo registrano nella registry degli oggetti del gioco.

Puoi mettere questo metodo in una classe chiamata ModItems (o qualsiasi altro nome).

Anche Mojang fa lo stesso per i suoi oggetti! Prendi ispirazione dalla classe Items.

public class ModItems {
	public static Item register(String name, Function<Item.Properties, Item> itemFactory, Item.Properties settings) {
		// Create the item key.
		ResourceKey<Item> itemKey = ResourceKey.create(Registries.ITEM, ResourceLocation.fromNamespaceAndPath(FabricDocsReference.MOD_ID, name));

		// Create the item instance.
		Item item = itemFactory.apply(settings.setId(itemKey));

		// Register the item.
		Registry.register(BuiltInRegistries.ITEM, itemKey, item);

		return item;
	}

}

Nota l'utilizzo di un'interfaccia Function per la fabbrica, il che ci permetterà successivamente di specificare come vogliamo creare il nostro oggetto date le impostazioni tramite Item::new.

Registrare un Oggetto

Puoi ora registrare un oggetto con il metodo.

Il metodo di registrazione accetta come parametro un'istanza della classe Item.Properties. Questa classe ti permette di configurare le proprietà dell'oggetto con vari metodi costruttori.

TIP

If you want to change your item's stack size, you can use the maxStackSize method in the Item.Properties class.

Questo non funzionerà se hai segnato un oggetto come danneggiabile, poiché la dimensione di uno stack è sempre 1 per oggetti danneggiabili per evitare duplicazioni.

public static final Item SUSPICIOUS_SUBSTANCE = register("suspicious_substance", Item::new, new Item.Properties());

Item::new dice alla funzione di registrazione di creare un'istanza Item con Item.Properties chiamando il costruttore Item (new Item(...)), che accetta Item.Properties come parametro.

Tuttavia, provando ora ad eseguire il client modificato, noterai che il nostro oggetto non esiste ancora nel gioco! Questo perché non hai inizializzato la classe staticamente.

Per fare questo puoi aggiungere un metodo initialize pubblico e statico alla tua classe e richiamarlo dall'initializer della tua mod. Per ora il metodo non deve contenere nulla.

public static void initialize() {
}

public class FabricDocsReferenceItems implements ModInitializer {
	@Override
	public void onInitialize() {
		ModItems.initialize();
	}
}

Chiamare un metodo su una classe la inizializza staticamente se non è mai stata caricata prima - questo significa che tutti gli attributi static vengono calcolati. Questo è il motivo di questo metodo initialize fasullo.

Aggiungere l'Oggetto ad un Gruppo di Oggetti

INFO

Se volessi aggiungere l'oggetto a un CreativeModeTab personalizzato, consulta la pagina Gruppi di Oggetti Personalizzati per maggiori informazioni.

Per questo esempio, aggiungeremo questo oggetto all'CreativeModeTab ingredienti, dovrai usare gli eventi dei gruppi di oggetti dell'API di Fabric - in particolare ItemGroupEvents.modifyEntriesEvent

Questo si può fare nel metodo initialize della tua classe degli oggetti.

// Get the event for modifying entries in the ingredients group.
// And register an event handler that adds our suspicious item to the ingredients group.
ItemGroupEvents.modifyEntriesEvent(CreativeModeTabs.INGREDIENTS)
		.register((itemGroup) -> itemGroup.accept(ModItems.SUSPICIOUS_SUBSTANCE));

Appena caricato il gioco, vedrai che il nostro oggetto è stato registrato, ed è nel gruppo di oggetti Ingredienti:

Tuttavia, gli manca il seguente:

• Modello dell'Oggetto
• Texture
• Traduzione (nome)

Dare un Nome all'Oggetto

L'oggetto per ora non ha una traduzione, per cui dovrai aggiungerne una. La chiave di traduzione è già stata fornita da Minecraft: item.mod_id.suspicious_substance.

Crea un nuovo file JSON presso: src/main/resources/assets/mod-id/lang/en_us.json e mettici la chiave di traduzione, e il suo valore:

{
  "item.mod_id.suspicious_substance": "Suspicious Substance"
}

Puoi riavviare il gioco, o ricostruire la tua mod e premere F3+T per applicare le modifiche.

Aggiungere Texture e Modello

Per dare al tuo oggetto una texture e un modello, ti basta creare un'immagine 16x16 come texture per il tuo oggetto e salvarla nella cartella assets/mod-id/textures/item. Il nome del file è l'identificatore dell'oggetto, con estensione .png.

Per questo esempio, puoi usare questa texture di esempio per suspicious_substance.png

Scarica Texture

Appena riavviato/ricaricato il gioco - dovresti vedere che l'oggetto ancora non ha texture, questo perché devi aggiungere un modello che usi questa texture.

Creeremo un semplice modello item/generated, che accetti come input solo una texture.

Crea il modello JSON nella cartella assets/mod-id/models/item, con lo stesso nome dell'oggetto; suspicious_substance.json

{
  "parent": "minecraft:item/generated",
  "textures": {
    "layer0": "fabric-docs-reference:item/suspicious_substance"
  }
}

Comprendere il Modello in JSON

• parent: Questo è il modello genitore da cui questo modello erediterà. In questo caso è il modello item/generated.
• textures: Qui è dove definisci le texture per il modello. La chiave layer0 è la texture che il modello userà.

La maggior parte degli oggetti usa il modello item/generated come genitore, perché è un modello semplice che mostra semplicemente la texture.

Ci sono alternative, tra cui item/handheld che si usa per oggetti che il giocatore "tiene in mano", come gli utensili.

Creare la Descrizione del Modello d'Oggetto

Minecraft non sa in automatico dove i file dei modelli dei tuoi oggetti si trovino, dobbiamo fornire una descrizione del modello dell'oggetto.

Crea la descrizione JSON dell'oggetto in assets/mod-id/items, e come nome del file l'identifier dell'oggetto: suspicious_substance.json.

{
  "model": {
    "type": "minecraft:model",
    "model": "fabric-docs-reference:item/suspicious_substance"
  }
}

Comprendere il JSON della Descrizione del Modello d'Oggetto

• model: Questa è la proprietà che contiene il riferimento al nostro modello.
  • type: Questo è il tipo del nostro modello. Per la maggior parte degli oggetti dovrebbe essere minecraft:model
  • model: Questo è l'identifier del modello. Dovrebbe seguire questo formato: mod-id:item/item_name

Il tuo oggetto dovrebbe ora avere questo aspetto nel gioco:

Rendere l'Oggetto Compostabile o Combustibile

L'API di Fabric fornisce varie registry che si possono usare per aggiungere altre proprietà al tuo oggetto.

Per esempio, per rendere il tuo oggetto compostabile, puoi usare la CompostableItemRegistry:

// Add the suspicious substance to the composting registry with a 30% chance of increasing the composter's level.
CompostingChanceRegistry.INSTANCE.add(ModItems.SUSPICIOUS_SUBSTANCE, 0.3f);

In alternativa, se vuoi rendere il tuo oggetto combustibile, puoi usare l'evento FuelRegistryEvents.BUILD:

// Add the suspicious substance to the registry of fuels, with a burn time of 30 seconds.
// Remember, Minecraft deals with logical based-time using ticks.
// 20 ticks = 1 second.
FuelRegistryEvents.BUILD.register((builder, context) -> {
	builder.add(ModItems.SUSPICIOUS_SUBSTANCE, 30 * 20);
});

Aggiungere una Ricetta Basilare

Se vuoi aggiungere una ricetta per il tuo oggetto, devi posizione un file JSON della ricetta nella cartella data/mod-id/recipe.

Per maggiori informazioni sul formato delle ricette, consulta queste risorse:

• Generatore di Ricette JSON
• Minecraft Wiki - Recipe JSON

Tooltip Personalizzati

Se vuoi che il tuo oggetto abbia un tooltip personalizzato, dovrai creare una classe che estenda Item e faccia override del metodo appendHoverText.

INFO

Questo esempio usa la classe LightningStick creata nella pagina Interazioni Personalizzate tra Oggetti.

@Override
public void appendHoverText(ItemStack stack, TooltipContext context, TooltipDisplay displayComponent, Consumer<Component> textConsumer, TooltipFlag type) {
	textConsumer.accept(Component.translatable("itemTooltip.fabric-docs-reference.lightning_stick").withStyle(ChatFormatting.GOLD));
}

Ogni chiamata di add() aggiungerà una linea al tooltip.