Package net.neoforged.neoforge.common.world

Record Class StructureModifiers.AddSpawnsStructureModifier

java.lang.Object
java.lang.Record
net.neoforged.neoforge.common.world.StructureModifiers.AddSpawnsStructureModifier
Record Components:
structures - Structures to add mob spawns to.
spawners - List of SpawnerDatas specifying EntityType, weight, and pack size.
All Implemented Interfaces:
StructureModifier
Enclosing class:
StructureModifiers
public static record StructureModifiers.AddSpawnsStructureModifier(HolderSet<Structure> structures, List<MobSpawnSettings.SpawnerData> spawners) extends Record implements StructureModifier

Stock structure modifier that adds a mob spawn override to a structure. If a structure has mob spawn overrides, random mob spawning will use the structure's spawns instead of the local biome's spawns. Has the following json format:

 {
   "type": "neoforge:add_spawns", // Required
   "structures": "#namespace:structure_tag", // Accepts a structure id, [list of structure ids], or #namespace:structure_tag
   "spawners":
   {
     "type": "namespace:entity_type", // Type of mob to spawn
     "weight": 100, // int, spawn weighting
     "minCount": 1, // int, minimum pack size
     "maxCount": 4, // int, maximum pack size
   }
 }

Optionally accepts a list of spawner objects instead of a single spawner:

 {
   "type": "neoforge:add_spawns", // Required
   "structure": "#namespace:structure_tag", // Accepts a structure id, [list of structure ids], or #namespace:structure_tag
   "spawners":
   [
     {
       "type": "namespace:entity_type", // Type of mob to spawn
       "weight": 100, // int, spawn weighting
       "minCount": 1, // int, minimum pack size
       "maxCount": 4, // int, maximum pack size
     },
     {
       // additional spawner object
     }
   ]
 }

  • Field Details

  • Constructor Details

  • Method Details

    • singleSpawn

      public static StructureModifiers.AddSpawnsStructureModifier singleSpawn(HolderSet<Structure> structures, MobSpawnSettings.SpawnerData spawner)
      Convenience method for using a single MobSpawnSettings.SpawnerData.
      Parameters:
      structures - Structures to add mob spawns to.
      spawner - SpawnerData specifying EntityTYpe, weight, and pack size.
      Returns:
      AddSpawnsStructureModifier that adds a single spawn entry to the specified biomes.

    • modify

      public void modify(Holder<Structure> structure, StructureModifier.Phase phase, ModifiableStructureInfo.StructureInfo.Builder builder)
      Description copied from interface: StructureModifier
      Modifies the information via the provided structure builder. Allows mob spawns and world-gen features to be added or removed, and climate and client effects to be modified.
      Specified by:
      modify in interface StructureModifier
      Parameters:
      structure - the named structure being modified (with original data readable).
      phase - structure modification phase. Structure modifiers apply in each phase in order of the enum constants.
      builder - mutable structure info builder. Apply changes to this.

    • codec

      public com.mojang.serialization.MapCodec<? extends StructureModifier> codec()
      Specified by:
      codec in interface StructureModifier
      Returns:
      the codec which serializes and deserializes this structure modifier

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • structures

      public HolderSet<Structure> structures()
      Returns the value of the structures record component.
      Returns:
      the value of the structures record component

    • spawners

      public List<MobSpawnSettings.SpawnerData> spawners()
      Returns the value of the spawners record component.
      Returns:
      the value of the spawners record component