keith/ForgePatch
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Usability improvements to RegistryObject/DeferredRegister

Browse source
This commit is contained in:
tterrag 2019-09-25 18:01:39 -04:00
parent d510978446
commit 476b7056fb
3 changed files with 75 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
src/main/java/net/minecraftforge/fml/RegistryObject.java
View file

@ -22,9 +22,12 @@ package net.minecraftforge.fml;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.registries.IForgeRegistry;
import net.minecraftforge.registries.IForgeRegistryEntry;
import net.minecraftforge.registries.IRegistryDelegate;
import net.minecraftforge.registries.ObjectHolderRegistry;
import net.minecraftforge.registries.RegistryManager;
import javax.annotation.Nullable;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
@ -33,19 +36,27 @@ import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Stream;
import javax.annotation.Nullable;
public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> implements Supplier<T>
{
private final ResourceLocation name;
@Nullable
private T value;
@Deprecated
public static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U> of(final String name, Supplier<Class<? super T>> registryType) {
return of(new ResourceLocation(name), registryType);
}
public static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U> of(final ResourceLocation name, Supplier<Class<? super T>> registryType) {
return new RegistryObject<>(name, registryType);
}
@Deprecated
public static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U> of(final String name, IForgeRegistry<T> registry) {
return of(new ResourceLocation(name), registry);
}
public static <T extends IForgeRegistryEntry<T>, U extends T> RegistryObject<U> of(final ResourceLocation name, IForgeRegistry<T> registry) {
return new RegistryObject<>(name, registry);
}
@ -61,17 +72,17 @@ public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> impl
this.name = null;
}
private <V extends IForgeRegistryEntry<V>> RegistryObject(String name, Supplier<Class<? super V>> registryType)
private <V extends IForgeRegistryEntry<V>> RegistryObject(ResourceLocation name, Supplier<Class<? super V>> registryType)
{
this(name, RegistryManager.ACTIVE.<V>getRegistry(registryType.get()));
}
@SuppressWarnings("unchecked")
private <V extends IForgeRegistryEntry<V>> RegistryObject(String name, IForgeRegistry<V> registry)
private <V extends IForgeRegistryEntry<V>> RegistryObject(ResourceLocation name, IForgeRegistry<V> registry)
{
if (registry == null)
throw new IllegalArgumentException("Invalid registry argument, must not be null");
this.name = new ResourceLocation(name);
this.name = name;
ObjectHolderRegistry.addHandler(pred ->
{
if (pred.test(registry.getRegistryName()))
@ -83,13 +94,28 @@ public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> impl
* Directly retrieves the wrapped Registry Object. This value will automatically be updated when the backing registry is updated.
*/
@Nullable
@Override
public T get()
{
return this.value;
}
public void updateReference(IForgeRegistry<? extends T> registry)
{
this.value = registry.getValue(getId());
}
public ResourceLocation getId()
{
return this.name;
}
/**
* @deprecated Prefer {@link #getId()}
*/
@Deprecated
public String getName() {
return this.name.toString();
return getId().toString();
}
public Stream<T> stream() {
@ -187,6 +213,26 @@ public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> impl
}
}
/**
* If a mod object is present, lazily apply the provided mapping function to it,
* returning a supplier for the transformed result. If this object is empty, or the
* mapping function returns {@code null}, the supplier will return {@code null}.
*
* @apiNote This method supports post-processing on optional values, without
* the need to explicitly check for a return status.
*
* @param <U> The type of the result of the mapping function
* @param mapper A mapping function to apply to the mod object, if present
* @return A {@code Supplier} lazily providing the result of applying a mapping
* function to the mod object of this {@code RegistryObject}, if a mod object is present,
* otherwise a supplier returning {@code null}
* @throws NullPointerException if the mapping function is {@code null}
*/
public<U> Supplier<U> lazyMap(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
return () -> isPresent() ? mapper.apply(get()) : null;
}
/**
* Return the mod object if present, otherwise return {@code other}.
*
@ -195,7 +241,7 @@ public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> impl
* @return the mod object, if present, otherwise {@code other}
*/
public T orElse(T other) {
return get() != null ? get() : other;
return isPresent() ? get() : other;
}
/**
@ -209,7 +255,7 @@ public final class RegistryObject<T extends IForgeRegistryEntry<? super T>> impl
* null
*/
public T orElseGet(Supplier<? extends T> other) {
return get() != null ? get() : other.get();
return isPresent() ? get() : other.get();
}
/**

28
src/main/java/net/minecraftforge/registries/DeferredRegister.java
View file

@ -19,15 +19,17 @@
package net.minecraftforge.registries;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Supplier;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.event.RegistryEvent;
import net.minecraftforge.eventbus.api.IEventBus;
import net.minecraftforge.fml.RegistryObject;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.function.Supplier;
/**
* Utility class to help with managing registry entries.
* Maintains a list of all suppliers for entries and registers them during the proper Register event.
@ -53,7 +55,7 @@ public class DeferredRegister<T extends IForgeRegistryEntry<T>>
{
private final IForgeRegistry<T> type;
private final String modid;
private List<Supplier<? extends T>> entries = new ArrayList<>();
private Map<RegistryObject<T>, Supplier<? extends T>> entries = new LinkedHashMap<>();
public DeferredRegister(IForgeRegistry<T> reg, String modid)
{
@ -68,11 +70,17 @@ public class DeferredRegister<T extends IForgeRegistryEntry<T>>
* @param sup A factory for the new entry, it should return a new instance every time it is called.
* @return A RegistryObject that will be updated with when the entries in the registry change.
*/
@SuppressWarnings("unchecked")
public <I extends T> RegistryObject<I> register(final String name, final Supplier<I> sup)
{
Objects.requireNonNull(name);
Objects.requireNonNull(sup);
final ResourceLocation key = new ResourceLocation(modid, name);
entries.add(() -> sup.get().setRegistryName(key));
return RegistryObject.of(key.toString(), this.type);
RegistryObject<I> ret = RegistryObject.of(key, this.type);
if (entries.putIfAbsent((RegistryObject<T>) ret, () -> sup.get().setRegistryName(key)) != null) {
throw new IllegalArgumentException("Duplicate registration " + name);
}
return ret;
}
/**
@ -92,7 +100,11 @@ public class DeferredRegister<T extends IForgeRegistryEntry<T>>
{
@SuppressWarnings("unchecked")
IForgeRegistry<T> reg = (IForgeRegistry<T>)event.getRegistry();
entries.stream().map(Supplier::get).forEach(reg::register);
for (Entry<RegistryObject<T>, Supplier<? extends T>> e : entries.entrySet())
{
reg.register(e.getValue().get());
e.getKey().updateReference(reg);
}
}
}
}

1
src/main/java/net/minecraftforge/registries/IRegistryDelegate.java
View file

@ -41,6 +41,7 @@ public interface IRegistryDelegate<T> extends Supplier<T> {
*
* @return The referred object
*/
@Override
T get();
/**