Add Custom HolderSet Types allowing for logical combining of sets. (#8928)

This commit is contained in:
Joseph B authored and GitHub committed 2022-08-09 12:25:12 -07:00
1 parent a3eb6263f4
commit 79112d6208
15 files changed
+764

No files matched your search

@@ -25,6 +25,7 @@ import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.mojang.datafixers.util.Either;
import com.mojang.serialization.Codec;
import com.mojang.serialization.Lifecycle;
@@ -145,6 +146,7 @@ import net.minecraftforge.registries.ForgeRegistries;
import net.minecraftforge.registries.ForgeRegistry;
import net.minecraftforge.registries.GameData;
import net.minecraftforge.registries.RegistryManager;
import net.minecraftforge.registries.holdersets.ICustomHolderSet;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -152,6 +154,7 @@ import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.MarkerManager;
import net.minecraft.ChatFormatting;
import net.minecraft.resources.HolderSetCodec;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.damagesource.DamageSource;
@@ -61,6 +61,11 @@ import net.minecraftforge.fml.*;
import net.minecraftforge.fml.config.ModConfig;
import net.minecraftforge.fml.event.lifecycle.*;
import net.minecraftforge.registries.*;
import net.minecraftforge.registries.holdersets.AndHolderSet;
import net.minecraftforge.registries.holdersets.AnyHolderSet;
import net.minecraftforge.registries.holdersets.HolderSetType;
import net.minecraftforge.registries.holdersets.NotHolderSet;
import net.minecraftforge.registries.holdersets.OrHolderSet;
import net.minecraftforge.network.NetworkConstants;
import net.minecraftforge.event.server.ServerStoppingEvent;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
@@ -120,6 +125,7 @@ public class ForgeMod
private static final DeferredRegister<ArgumentTypeInfo<?, ?>> COMMAND_ARGUMENT_TYPES = DeferredRegister.create(Registry.COMMAND_ARGUMENT_TYPE_REGISTRY, "forge");
private static final DeferredRegister<Codec<? extends BiomeModifier>> BIOME_MODIFIER_SERIALIZERS = DeferredRegister.create(ForgeRegistries.Keys.BIOME_MODIFIER_SERIALIZERS, "forge");
private static final DeferredRegister<Codec<? extends StructureModifier>> STRUCTURE_MODIFIER_SERIALIZERS = DeferredRegister.create(ForgeRegistries.Keys.STRUCTURE_MODIFIER_SERIALIZERS, "forge");
private static final DeferredRegister<HolderSetType> HOLDER_SET_TYPES = DeferredRegister.create(ForgeRegistries.Keys.HOLDER_SET_TYPES, "forge");
@SuppressWarnings({ "unchecked", "rawtypes" })
private static final RegistryObject<EnumArgument.Info> ENUM_COMMAND_ARGUMENT_TYPE = COMMAND_ARGUMENT_TYPES.register("enum", () ->
@@ -212,6 +218,27 @@ public class ForgeMod
*/
public static final RegistryObject<Codec<NoneStructureModifier>> NONE_STRUCTURE_MODIFIER_TYPE = STRUCTURE_MODIFIER_SERIALIZERS.register("none", () -> Codec.unit(NoneStructureModifier.INSTANCE));
/**
* Stock holder set type that represents any/all values in a registry. Can be used in a holderset object with {@code { "type": "forge:any" }}
*/
public static final RegistryObject<HolderSetType> ANY_HOLDER_SET = HOLDER_SET_TYPES.register("any", () -> AnyHolderSet::codec);
/**
* Stock holder set type that represents an intersection of other holdersets. Can be used in a holderset object with {@code { "type": "forge:and", "values": [list of holdersets] }}
*/
public static final RegistryObject<HolderSetType> AND_HOLDER_SET = HOLDER_SET_TYPES.register("and", () -> AndHolderSet::codec);
/**
* Stock holder set type that represents a union of other holdersets. Can be used in a holderset object with {@code { "type": "forge:or", "values": [list of holdersets] }}
*/
public static final RegistryObject<HolderSetType> OR_HOLDER_SET = HOLDER_SET_TYPES.register("or", () -> OrHolderSet::codec);
/**
* <p>Stock holder set type that represents all values in a registry except those in another given set.
* Can be used in a holderset object with {@code { "type": "forge:not", "value": holderset }}</p>
*/
public static final RegistryObject<HolderSetType> NOT_HOLDER_SET = HOLDER_SET_TYPES.register("not", () -> NotHolderSet::codec);
private static final DeferredRegister<FluidType> VANILLA_FLUID_TYPES = DeferredRegister.create(ForgeRegistries.Keys.FLUID_TYPES, "minecraft");
public static final RegistryObject<FluidType> EMPTY_TYPE = VANILLA_FLUID_TYPES.register("empty", () ->
@@ -418,6 +445,7 @@ public class ForgeMod
COMMAND_ARGUMENT_TYPES.register(modEventBus);
BIOME_MODIFIER_SERIALIZERS.register(modEventBus);
STRUCTURE_MODIFIER_SERIALIZERS.register(modEventBus);
HOLDER_SET_TYPES.register(modEventBus);
VANILLA_FLUID_TYPES.register(modEventBus);
MinecraftForge.EVENT_BUS.addListener(this::serverStopping);
MinecraftForge.EVENT_BUS.addListener(this::missingSoundMapping);
@@ -0,0 +1,26 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.common.extensions;
public interface IForgeHolderSet<T>
{
/**
* <p>Adds a callback to run when this holderset's contents invalidate (i.e. because tags were rebound).</p>
*
* <p>The intended usage and use case is with composite holdersets that need to cache sets/list based on other
* holdersets, which may be mutable (because they are tag-based or themselves composite holdersets).
* Composite holdersets should use this to add callbacks to each of their component holdersets when constructed.</p>
*
* @param runnable Runnable to invoke when this component holderset's contents are no longer valid.
* This runnable should only clear caches and allow them to be lazily reevaluated later,
* as not all tag holdersets may have been rebound when this is called.
* This runnable should also invalidate all of the caller's listeners.
*/
default public void addInvalidationListener(Runnable runnable)
{
// noop by default, mutable/composite holdersets must override
}
}
@@ -26,6 +26,7 @@ public class ForgeDeferredRegistriesSetup
ForgeRegistries.DEFERRED_BIOME_MODIFIERS.register(modEventBus);
ForgeRegistries.DEFERRED_STRUCTURE_MODIFIER_SERIALIZERS.register(modEventBus);
ForgeRegistries.DEFERRED_STRUCTURE_MODIFIERS.register(modEventBus);
ForgeRegistries.DEFERRED_HOLDER_SET_TYPES.register(modEventBus);
setup = true;
}
@@ -45,6 +45,7 @@ import net.minecraftforge.common.Tags;
import net.minecraftforge.common.loot.IGlobalLootModifier;
import net.minecraftforge.common.world.BiomeModifier;
import net.minecraftforge.fluids.FluidType;
import net.minecraftforge.registries.holdersets.HolderSetType;
import java.util.function.Supplier;
import net.minecraftforge.common.world.StructureModifier;
@@ -127,6 +128,12 @@ public class ForgeRegistries
* Use {@link Keys#FLUID_TYPES} to create a {@link DeferredRegister}.
*/
public static final Supplier<IForgeRegistry<FluidType>> FLUID_TYPES = DEFERRED_FLUID_TYPES.makeRegistry(GameData::getFluidTypeRegistryBuilder);
static final DeferredRegister<HolderSetType> DEFERRED_HOLDER_SET_TYPES = DeferredRegister.create(Keys.HOLDER_SET_TYPES, "forge");
/**
* Calling {@link Supplier#get()} before {@link NewRegistryEvent} is fired will result in a null registry returned.
* Use {@link Keys#HOLDER_SET_TYPES} to create a {@link DeferredRegister}.
*/
public static final Supplier<IForgeRegistry<HolderSetType>> HOLDER_SET_TYPES = DEFERRED_HOLDER_SET_TYPES.makeRegistry(GameData::getHolderSetTypeRegistryBuilder);
// Custom forge datapack registries
static final DeferredRegister<BiomeModifier> DEFERRED_BIOME_MODIFIERS = DeferredRegister.create(Keys.BIOME_MODIFIERS, "forge");
@@ -175,6 +182,7 @@ public class ForgeRegistries
public static final ResourceKey<Registry<Codec<? extends BiomeModifier>>> BIOME_MODIFIER_SERIALIZERS = key("forge:biome_modifier_serializers");
public static final ResourceKey<Registry<Codec<? extends StructureModifier>>> STRUCTURE_MODIFIER_SERIALIZERS = key("forge:structure_modifier_serializers");
public static final ResourceKey<Registry<FluidType>> FLUID_TYPES = key("forge:fluid_type");
public static final ResourceKey<Registry<HolderSetType>> HOLDER_SET_TYPES = key("forge:holder_set_type");
// Forge Dynamic
public static final ResourceKey<Registry<BiomeModifier>> BIOME_MODIFIERS = key("forge:biome_modifier");
@@ -48,6 +48,8 @@ import net.minecraftforge.fml.ModLoadingContext;
import net.minecraftforge.fml.StartupMessageManager;
import net.minecraftforge.fml.util.EnhancedRuntimeException;
import net.minecraftforge.fml.util.thread.EffectiveSide;
import net.minecraftforge.registries.holdersets.HolderSetType;
import org.apache.commons.lang3.Validate;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -164,6 +166,11 @@ public class GameData
{
return makeRegistry(FLUID_TYPES).disableSaving();
}
static RegistryBuilder<HolderSetType> getHolderSetTypeRegistryBuilder()
{
return new RegistryBuilder<HolderSetType>().disableSaving().disableSync();
}
private static <T> RegistryBuilder<T> makeRegistry(ResourceKey<? extends Registry<T>> key)
{
@@ -0,0 +1,80 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import com.mojang.serialization.Codec;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderSet;
import net.minecraft.core.Registry;
import net.minecraft.resources.HolderSetCodec;
import net.minecraft.resources.ResourceKey;
import net.minecraftforge.common.ForgeMod;
/**
* <p>Holderset that represents an intersection of other holdersets. Json format:</p>
* <pre>
* {
* "type": "forge:and",
* "values":
* [
* // list of sub-holdersets (strings, lists, or objects)
* ]
* }
* </pre>
*/
public class AndHolderSet<T> extends CompositeHolderSet<T>
{
public static <T> Codec<? extends ICustomHolderSet<T>> codec(ResourceKey<? extends Registry<T>> registryKey, Codec<Holder<T>> holderCodec, boolean forceList)
{
return HolderSetCodec.create(registryKey, holderCodec, forceList)
.listOf()
.xmap(AndHolderSet::new, AndHolderSet::getComponents)
.fieldOf("values")
.codec();
}
public AndHolderSet(List<HolderSet<T>> values)
{
super(values);
}
@Override
public HolderSetType type()
{
return ForgeMod.AND_HOLDER_SET.get();
}
@Override
protected Set<Holder<T>> createSet()
{
List<HolderSet<T>> components = this.getComponents();
if (components.size() < 1)
{
return Set.of();
}
if (components.size() == 1)
{
return components.get(0).stream().collect(Collectors.toSet());
}
List<HolderSet<T>> remainingComponents = components.subList(1, components.size());
return components.get(0)
.stream()
.filter(holder -> remainingComponents.stream().allMatch(holderset -> holderset.contains(holder)))
.collect(Collectors.toSet());
}
@Override
public String toString()
{
return "AndSet[" + this.getComponents() + "]";
}
}
@@ -0,0 +1,102 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Stream;
import com.mojang.datafixers.util.Either;
import com.mojang.serialization.Codec;
import net.minecraft.core.Holder;
import net.minecraft.core.Registry;
import net.minecraft.resources.RegistryOps;
import net.minecraft.resources.ResourceKey;
import net.minecraft.tags.TagKey;
import net.minecraft.util.RandomSource;
import net.minecraftforge.common.ForgeMod;
/**
* <p>Holderset that represents all elements of a registry. Json format:</p>
* <pre>
* {
* "type": "forge:any"
* }
* </pre>
*/
public record AnyHolderSet<T>(Registry<T> registry) implements ICustomHolderSet<T>
{
public static <T> Codec<? extends ICustomHolderSet<T>> codec(ResourceKey<? extends Registry<T>> registryKey, Codec<Holder<T>> holderCodec, boolean forceList)
{
return RegistryOps.retrieveRegistry(registryKey)
.xmap(AnyHolderSet::new, AnyHolderSet::registry)
.codec();
}
@Override
public HolderSetType type()
{
return ForgeMod.ANY_HOLDER_SET.get();
}
@Override
public Iterator<Holder<T>> iterator()
{
return this.stream().iterator();
}
@Override
public Stream<Holder<T>> stream()
{
return registry.holders().map(Function.identity());
}
@Override
public int size()
{
return this.registry.size();
}
@Override
public Either<TagKey<T>, List<Holder<T>>> unwrap()
{
return Either.right(this.stream().toList());
}
@Override
public Optional<Holder<T>> getRandomElement(RandomSource random)
{
return this.registry.getRandom(random);
}
@Override
public Holder<T> get(int i)
{
return this.registry.getHolder(i).orElseThrow(() -> new NoSuchElementException("No element " + i + " in registry " + this.registry.key()));
}
@Override
public boolean contains(Holder<T> holder)
{
return holder.unwrapKey().map(this.registry::containsKey).orElse(false);
}
@Override
public boolean isValidInRegistry(Registry<T> registry)
{
return this.registry == registry;
}
@Override
public String toString()
{
return "AnySet(" + this.registry.key() + ")";
}
}
@@ -0,0 +1,164 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Stream;
import org.jetbrains.annotations.Nullable;
import com.mojang.datafixers.util.Either;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderSet;
import net.minecraft.core.Registry;
import net.minecraft.tags.TagKey;
import net.minecraft.util.RandomSource;
/**
* Composite holdersets have component holdersets and possibly owner holdersets
* (which have this holderset as a component).
* When their component holderset(s) invalidate, they clear any cached data and then
* invalidate their owner holdersets.
*/
public abstract class CompositeHolderSet<T> implements ICustomHolderSet<T>
{
private final List<Runnable> owners = new ArrayList<>();
private final List<HolderSet<T>> components;
@Nullable
private Set<Holder<T>> set = null;
@Nullable
private List<Holder<T>> list = null;
public CompositeHolderSet(List<HolderSet<T>> components)
{
this.components = components;
for (HolderSet<T> holderset : components)
{
holderset.addInvalidationListener(this::invalidate);
}
}
/**
* {@return immutable Set of Holders given this composite holderset's component holdersets}
*/
protected abstract Set<Holder<T>> createSet();
public List<HolderSet<T>> getComponents()
{
return this.components;
}
public Set<Holder<T>> getSet()
{
Set<Holder<T>> thisSet = this.set;
if (thisSet == null)
{
Set<Holder<T>> set = this.createSet();
this.set = set;
return set;
}
else
{
return thisSet;
}
}
public List<Holder<T>> getList()
{
List<Holder<T>> thisList = this.list;
if (thisList == null)
{
List<Holder<T>> list = List.copyOf(this.getSet());
this.list = list;
return list;
}
else
{
return thisList;
}
}
@Override
public void addInvalidationListener(Runnable runnable)
{
this.owners.add(runnable);
}
private void invalidate()
{
this.set = null;
this.list = null;
for (Runnable runnable : this.owners)
{
runnable.run();
}
}
@Override
public Stream<Holder<T>> stream()
{
return this.getList().stream();
}
@Override
public int size()
{
return this.getList().size();
}
@Override
public Either<TagKey<T>, List<Holder<T>>> unwrap()
{
return Either.right(this.getList());
}
@Override
public Optional<Holder<T>> getRandomElement(RandomSource rand)
{
List<Holder<T>> list = this.getList();
int size = list.size();
return size > 0
? Optional.of(list.get(rand.nextInt(size)))
: Optional.empty();
}
@Override
public Holder<T> get(int i)
{
return this.getList().get(i);
}
@Override
public boolean contains(Holder<T> holder)
{
return this.getSet().contains(holder);
}
@Override
public boolean isValidInRegistry(Registry<T> registry)
{
for (HolderSet<T> component : this.components)
{
if (!component.isValidInRegistry(registry))
{
return false;
}
}
return true;
}
@Override
public Iterator<Holder<T>> iterator()
{
return this.getList().iterator();
}
}
@@ -0,0 +1,18 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import com.mojang.serialization.Codec;
import net.minecraft.core.Holder;
import net.minecraft.core.Registry;
import net.minecraft.resources.ResourceKey;
@FunctionalInterface
public interface HolderSetType
{
<T> Codec<? extends ICustomHolderSet<T>> makeCodec(ResourceKey<? extends Registry<T>> registryKey, Codec<Holder<T>> holderCodec, boolean forceList);
}
@@ -0,0 +1,19 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import net.minecraft.core.HolderSet;
/**
* Interface for mods' custom holderset types
*/
public interface ICustomHolderSet<T> extends HolderSet<T>
{
/**
* {@return HolderSetType registered to {@link ForgeRegistries.HOLDER_SET_TYPES}}
*/
HolderSetType type();
}
@@ -0,0 +1,164 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
import org.jetbrains.annotations.Nullable;
import com.mojang.datafixers.util.Either;
import com.mojang.serialization.Codec;
import com.mojang.serialization.codecs.RecordCodecBuilder;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderSet;
import net.minecraft.core.Registry;
import net.minecraft.resources.HolderSetCodec;
import net.minecraft.resources.RegistryOps;
import net.minecraft.resources.ResourceKey;
import net.minecraft.tags.TagKey;
import net.minecraft.util.RandomSource;
import net.minecraftforge.common.ForgeMod;
/**
* <p>Holderset that represents all elements of a registry not present in another holderset.
* forge:exclusion is preferable when the number of allowed elements is small relative to the size of the registry.
* Json format:</p>
* <pre>
* {
* "type": "forge:not",
* "value": "not_this_holderset" // string, list, or object
* }
* </pre>
*/
// this doesn't extend CompositeHolderSet because it doesn't need to cache a set
public class NotHolderSet<T> implements ICustomHolderSet<T>
{
public static <T> Codec<? extends ICustomHolderSet<T>> codec(ResourceKey<? extends Registry<T>> registryKey, Codec<Holder<T>> holderCodec, boolean forceList)
{
return RecordCodecBuilder.<NotHolderSet<T>>create(builder -> builder.group(
RegistryOps.retrieveRegistry(registryKey).forGetter(NotHolderSet::registry),
HolderSetCodec.create(registryKey, holderCodec, forceList).fieldOf("value").forGetter(NotHolderSet::value)
).apply(builder, NotHolderSet::new));
}
private final List<Runnable> owners = new ArrayList<>();
private final Registry<T> registry;
private final HolderSet<T> value;
@Nullable
private List<Holder<T>> list = null;
public Registry<T> registry() { return this.registry; }
public HolderSet<T> value() { return this.value; }
public NotHolderSet(Registry<T> registry, HolderSet<T> value)
{
this.registry = registry;
this.value = value;
this.value.addInvalidationListener(this::invalidate);
}
@Override
public HolderSetType type()
{
return ForgeMod.NOT_HOLDER_SET.get();
}
@Override
public void addInvalidationListener(Runnable runnable)
{
this.owners.add(runnable);
}
@Override
public Iterator<Holder<T>> iterator()
{
return this.getList().iterator();
}
@Override
public Stream<Holder<T>> stream()
{
return this.getList().stream();
}
@Override
public int size()
{
return this.getList().size();
}
@Override
public Either<TagKey<T>, List<Holder<T>>> unwrap()
{
return Either.right(this.getList());
}
@Override
public Optional<Holder<T>> getRandomElement(RandomSource random)
{
List<Holder<T>> list = this.getList();
int size = list.size();
return size > 0
? Optional.of(list.get(random.nextInt(size)))
: Optional.empty();
}
@Override
public Holder<T> get(int i)
{
return this.getList().get(i);
}
@Override
public boolean contains(Holder<T> holder)
{
return !this.value.contains(holder);
}
@Override
public boolean isValidInRegistry(Registry<T> registry)
{
return this.registry == registry;
}
@Override
public String toString()
{
return "NotSet(" + this.value + ")";
}
private List<Holder<T>> getList()
{
List<Holder<T>> thisList = this.list;
if (thisList == null)
{
List<Holder<T>> list = this.registry.holders()
.filter(holder -> !this.value.contains(holder))
.map(holder -> (Holder<T>)holder)
.toList();
this.list = list;
return list;
}
else
{
return thisList;
}
}
private void invalidate()
{
this.list = null;
for (Runnable runnable : this.owners)
{
runnable.run();
}
}
}
@@ -0,0 +1,66 @@
/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.registries.holdersets;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import com.mojang.serialization.Codec;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderSet;
import net.minecraft.core.Registry;
import net.minecraft.resources.HolderSetCodec;
import net.minecraft.resources.ResourceKey;
import net.minecraftforge.common.ForgeMod;
/**
* <p>Holderset that represents a union of other holdersets. Json format:</p>
* <pre>
* {
* "type": "forge:or",
* "values":
* [
* // list of sub-holdersets (strings, lists, or objects)
* ]
* }
* </pre>
*/
public class OrHolderSet<T> extends CompositeHolderSet<T>
{
public static <T> Codec<? extends ICustomHolderSet<T>> codec(ResourceKey<? extends Registry<T>> registryKey, Codec<Holder<T>> holderCodec, boolean forceList)
{
return HolderSetCodec.create(registryKey, holderCodec, forceList)
.listOf()
.xmap(OrHolderSet::new, OrHolderSet::getComponents)
.fieldOf("values")
.codec();
}
public OrHolderSet(List<HolderSet<T>> values)
{
super(values);
}
@Override
public HolderSetType type()
{
return ForgeMod.OR_HOLDER_SET.get();
}
@Override
protected Set<Holder<T>> createSet()
{
return this.getComponents().stream().flatMap(HolderSet::stream).collect(Collectors.toSet());
}
@Override
public String toString()
{
return "OrSet[" + this.getComponents() + "]";
}
}