Aller au contenu principal
Version: 1.18.x

Deferred Register

DeferredRegister est une couche d'abstraction de l'événement de registre utilisé pour enregistrer des éléments. Il maintient une correspondance entre les "noms de registre" et leurs fournisseurs associés et arrange ceux-ci lors de l'appel de l'événement RegistryEvent$Register.

Créer un Deferred Register​

Registres gérés par Forge​

Pour créer un DeferredRegister, il nous faut tout d'abord ajouter une variable dans une classe où nous enregistrerons tous les éléments concernés (comme les items, les blocs, etc...) comme celle-ci :

public static final DeferredRegister<Item> MON_REGISTRE = DeferredRegister.create(ForgeRegistries.ITEMS, "modid");

Quelques explications :

  • La classe référencée entre les chevrons doit correspondre au type définit par le premier argument
  • Le premier argument permet de définir le type d'élément (liste ci-dessous) que nous allons pouvoir enregistrer (ici, cela sera pour les items)
    Liste des types
    • BLOCKS
    • FLUIDS
    • ITEMS
    • MOB_EFFECTS
    • SOUND_EVENTS
    • POTIONS
    • ENCHANTMENTS
    • ENTITIES
    • BLOCK_ENTITIES
    • PARTICLE_TYPES
    • CONTAINERS
    • PAINTING_TYPES
    • RECIPE_SERIALIZERS
    • ATTRIBUTES
    • STAT_TYPES
    • PROFESSIONS
    • POI_TYPES
    • MEMORY_MODULE_TYPES
    • SENSOR_TYPES
    • SCHEDULES
    • ACTIVITIES
    • WORLD_CARVERS
    • FEATURES
    • CHUNK_STATUS
    • STRUCTURE_FEATURES
    • BLOCK_STATE_PROVIDER_TYPES
    • FOLIAGE_PLACER_TYPES
    • TREE_DECORATOR_TYPES
    • BIOMES
    • DATA_SERIALIZERS
    • LOOT_MODIFIER_SERIALIZERS
    • WORLD_TYPES
  • Le deuxième quant à lui est le modid sous lequel votre élément sera enregistré (il est préférable de mettre le modid de votre mod)
attention

Tous les noms de classes, de variables et de méthodes sont personnalisables comme vous le souhaitez, et cela, tout au long du tutoriel.

Registres non gérés par Forge​

En raison de certaines particularités du code de base, tous les registres ne sont pas gérés par Forge. Il peut s'agir de registres statiques, comme RecipeType, qui peuvent être utilisés en toute sécurité, ou dynamiques, comme ConfiguredFeature et certains autres concernant la génération, qui sont généralement représentés en JSON. Ces objets ne doivent être enregistrés de cette manière que si un autre objet de registre le nécessite. La fonction DeferredRegister#create possède une surcharge (depuis la 1.18.2) qui permet aux moddeurs de spécifier la clé du registre pour lequel il est nécessaire de créer un RegistryObject :

private static final DeferredRegister<RecipeType<?>> MON_REGISTRE = DeferredRegister.create(Registry.RECIPE_TYPE_REGISTRY, "modid");

public static final RegistryObject<RecipeType<ExampleRecipe>> MON_TYPE_RECETTE = REGISTER.register("example_recipe_type", () -> new RecipeType<>() {});

Indiquer au jeu que le DeferredRegister existe​

Après avoir créée votre DeferredRegister, il ne reste plus qu'à faire comprendre au jeu que celui existe et pour cela il faudra disposer ce bout de code dans le constructeur de votre classe principale.

Classe.NOM_VARIABLE.register(FMLJavaModLoadingContext.get().getModEventBus());