Fabric 1.17 does not contain the ArmorRenderingRegistry. Temporarily added the missing files to a shadow-namespace to allw testing of the CrystaliteArmor.

This commit is contained in:
Frank Bauer 2021-06-30 12:23:27 +02:00
parent 2ba7ed4ec8
commit 9a28623230
9 changed files with 474 additions and 7 deletions

View file

@ -1,5 +1,7 @@
package ru.betterend.item.model;
import net.minecraft.client.renderer.entity.layers.HumanoidArmorLayer;
import net.minecraft.world.item.ArmorMaterial;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@ -16,9 +18,10 @@ import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStack;
import ru.betterend.item.CrystaliteArmor;
import ru.betterend.registry.EndItems;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
@Environment(EnvType.CLIENT)
public class CrystaliteArmorProvider /*implements ModelProvider, TextureProvider*/ {
public class CrystaliteArmorProvider implements ArmorRenderingRegistry.ModelProvider, ArmorRenderingRegistry.TextureProvider {
//TODO: find new registry
private final static ResourceLocation FIRST_LAYER = new ResourceLocation("textures/models/armor/crystalite_layer_1.png");
private final static ResourceLocation SECOND_LAYER = new ResourceLocation("textures/models/armor/crystalite_layer_2.png");

View file

@ -3,6 +3,7 @@ package ru.betterend.registry;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import ru.betterend.item.model.CrystaliteArmorProvider;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
@Environment(EnvType.CLIENT)
public class EndModelProviders {
@ -10,9 +11,7 @@ public class EndModelProviders {
public final static CrystaliteArmorProvider CRYSTALITE_PROVIDER = new CrystaliteArmorProvider();
public final static void register() {
//TODO: Needs Fix in 1.17
throw new RuntimeException("Needs Fix for 1.17");
//ArmorRenderingRegistry.registerModel(CRYSTALITE_PROVIDER, CRYSTALITE_PROVIDER.getRenderedItems());
//ArmorRenderingRegistry.registerTexture(CRYSTALITE_PROVIDER, CRYSTALITE_PROVIDER.getRenderedItems());
ArmorRenderingRegistry.registerModel(CRYSTALITE_PROVIDER, CRYSTALITE_PROVIDER.getRenderedItems());
ArmorRenderingRegistry.registerTexture(CRYSTALITE_PROVIDER, CRYSTALITE_PROVIDER.getRenderedItems());
}
}

View file

@ -0,0 +1,168 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
This file is a refactor from fabric-api, based on the work of shedaniel.
*/
package shadow.fabric.api.client.rendering.v1;
import java.util.Arrays;
import shadow.fabric.impl.client.rendering.ArmorRenderingRegistryImpl;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import net.minecraft.client.model.HumanoidModel;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.EquipmentSlot;
import net.minecraft.world.entity.LivingEntity;
import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStack;
/**
* A class for registering custom armor models and textures for {@link Item}, to be provided by a {@link ModelProvider} or {@link TextureProvider}.
*
* <p>This can be used to replace existing vanilla armor models and textures conditionally, however each {@link Item}
* instance can only allow one {@link ModelProvider} or {@link TextureProvider} respectively, causing potential conflicts
* with other mods if you replace the model or texture for vanilla items. Consider using a separate item instead.</p>
*
* <p>A custom model would probably also require a custom texture to go along it, the model will use the vanilla texture if it is undefined.</p>
*
* <p>Since armor textures identifier in vanilla is hardcoded to be in the {@code minecraft} namespace, this registry can also be
* used to use a custom namespace if desired.</p>
*/
@Environment(EnvType.CLIENT)
public final class ArmorRenderingRegistry {
private ArmorRenderingRegistry() {
}
/**
* Registers a provider for custom armor models for an item.
*
* @param provider the provider for the model
* @param items the items to be registered for
*/
public static void registerModel(@Nullable ModelProvider provider, Item... items) {
registerModel(provider, Arrays.asList(items));
}
/**
* Registers a provider for custom armor models for an item.
*
* @param provider the provider for the model
* @param items the items to be registered for
*/
public static void registerModel(@Nullable ModelProvider provider, Iterable<Item> items) {
ArmorRenderingRegistryImpl.registerModel(provider, items);
}
/**
* Registers a provider for custom texture models for an item.
*
* @param provider the provider for the texture
* @param items the items to be registered for
*/
public static void registerTexture(@Nullable TextureProvider provider, Item... items) {
registerTexture(provider, Arrays.asList(items));
}
/**
* Registers a provider for custom texture models for an item.
*
* @param provider the provider for the texture
* @param items the items to be registered for
*/
public static void registerTexture(@Nullable TextureProvider provider, Iterable<Item> items) {
ArmorRenderingRegistryImpl.registerTexture(provider, items);
}
/**
* Register simple armor items to use the vanilla armor file name under the mods namespace.
*
* @param identifier The namespace + path to use for the armor texture location.
* @param items the items to be registered
*/
public static void registerSimpleTexture(ResourceLocation identifier, Item... items) {
registerTexture((entity, stack, slot, secondLayer, suffix, defaultTexture) -> {
return new ResourceLocation(identifier.getNamespace(), "textures/models/armor/" + identifier.getPath() + "_layer_" + (secondLayer ? 2 : 1) + (suffix == null ? "" : "_" + suffix) + ".png");
}, items);
}
/**
* Gets the model of the armor piece.
*
* @param entity The entity equipping the armor
* @param stack The item stack of the armor
* @param slot The slot which the armor is in
* @param defaultModel The default model that vanilla provides
* @return The model of the armor piece.
*/
@NotNull
public static HumanoidModel<LivingEntity> getArmorModel(LivingEntity entity, ItemStack stack, EquipmentSlot slot, HumanoidModel<LivingEntity> defaultModel) {
return ArmorRenderingRegistryImpl.getArmorModel(entity, stack, slot, defaultModel);
}
/**
* Gets the armor texture {@link net.minecraft.resources.ResourceLocation}.
*
* @param entity The entity equipping the armor
* @param stack The item stack of the armor
* @param slot The slot which the armor is in
* @param secondLayer True if using the second texture layer
* @param suffix The texture suffix, used in vanilla by {@link net.minecraft.world.item.DyeableArmorItem}
* @param defaultTexture The default vanilla texture identifier
* @return the custom armor texture identifier, return null to use the vanilla ones. Defaulted to the item's registry id.
*/
@NotNull
public static ResourceLocation getArmorTexture(LivingEntity entity, ItemStack stack, EquipmentSlot slot, boolean secondLayer, @Nullable String suffix, ResourceLocation defaultTexture) {
return ArmorRenderingRegistryImpl.getArmorTexture(entity, stack, slot, secondLayer, suffix, defaultTexture);
}
@FunctionalInterface
@Environment(EnvType.CLIENT)
public interface ModelProvider {
/**
* Gets the model of the armor piece.
*
* @param entity The entity equipping the armor
* @param stack The item stack of the armor
* @param slot The slot which the armor is in
* @param defaultModel The default vanilla armor model
* @return The model of the armor piece. Should never be null.
*/
@NotNull
HumanoidModel<LivingEntity> getArmorModel(LivingEntity entity, ItemStack stack, EquipmentSlot slot, HumanoidModel<LivingEntity> defaultModel);
}
@FunctionalInterface
@Environment(EnvType.CLIENT)
public interface TextureProvider {
/**
* Gets the armor texture {@link net.minecraft.resources.ResourceLocation}.
*
* @param entity The entity equipping the armor
* @param stack The item stack of the armor
* @param slot The slot which the armor is in
* @param defaultTexture The default vanilla texture identifier
* @return the custom armor texture identifier. Should never be null.
*/
@NotNull
ResourceLocation getArmorTexture(LivingEntity entity, ItemStack stack, EquipmentSlot slot, boolean secondLayer, @Nullable String suffix, ResourceLocation defaultTexture);
}
}

View file

@ -0,0 +1,37 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
This file is a refactor from fabric-api, based on the work of shedaniel.
*/
package shadow.fabric.impl.client.rendering;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
import org.jetbrains.annotations.Nullable;
public interface ArmorProviderExtensions {
@Nullable
ArmorRenderingRegistry.ModelProvider fabric_getArmorModelProvider();
@Nullable
ArmorRenderingRegistry.TextureProvider fabric_getArmorTextureProvider();
void fabric_setArmorModelProvider(@Nullable ArmorRenderingRegistry.ModelProvider provider);
void fabric_setArmorTextureProvider(@Nullable ArmorRenderingRegistry.TextureProvider provider);
}

View file

@ -0,0 +1,82 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
This file is a refactor from fabric-api, based on the work of shedaniel.
*/
package shadow.fabric.impl.client.rendering;
import java.util.Objects;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
import org.jetbrains.annotations.Nullable;
import net.minecraft.client.model.HumanoidModel;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.EquipmentSlot;
import net.minecraft.world.entity.LivingEntity;
import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStack;
public final class ArmorRenderingRegistryImpl {
private ArmorRenderingRegistryImpl() {
}
public static void registerModel(ArmorRenderingRegistry.ModelProvider provider, Iterable<Item> items) {
Objects.requireNonNull(items);
for (Item item : items) {
Objects.requireNonNull(item);
((ArmorProviderExtensions) item).fabric_setArmorModelProvider(provider);
}
}
public static void registerTexture(ArmorRenderingRegistry.TextureProvider provider, Iterable<Item> items) {
Objects.requireNonNull(items);
for (Item item : items) {
Objects.requireNonNull(item);
((ArmorProviderExtensions) item).fabric_setArmorTextureProvider(provider);
}
}
public static HumanoidModel<LivingEntity> getArmorModel(LivingEntity entity, ItemStack stack, EquipmentSlot slot, HumanoidModel<LivingEntity> defaultModel) {
if (!stack.isEmpty()) {
ArmorRenderingRegistry.ModelProvider provider = ((ArmorProviderExtensions) stack.getItem()).fabric_getArmorModelProvider();
if (provider != null) {
return provider.getArmorModel(entity, stack, slot, defaultModel);
}
}
return defaultModel;
}
public static ResourceLocation getArmorTexture(LivingEntity entity, ItemStack stack, EquipmentSlot slot, boolean secondLayer, @Nullable String suffix, ResourceLocation defaultTexture) {
if (!stack.isEmpty()) {
ArmorRenderingRegistry.TextureProvider provider = ((ArmorProviderExtensions) stack.getItem()).fabric_getArmorTextureProvider();
if (provider != null) {
return provider.getArmorTexture(entity, stack, slot, secondLayer, suffix, defaultTexture);
}
}
return defaultTexture;
}
}

View file

@ -0,0 +1,107 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
This file is a refactor from fabric-api, based on the work of shedaniel.
*/
package shadow.fabric.mixin.client.rendering;
import com.mojang.blaze3d.vertex.PoseStack;
import java.util.Map;
import java.util.Objects;
import org.spongepowered.asm.mixin.Final;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.Shadow;
import org.spongepowered.asm.mixin.Unique;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
import org.spongepowered.asm.mixin.injection.callback.LocalCapture;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
import net.minecraft.client.model.HumanoidModel;
import net.minecraft.client.renderer.MultiBufferSource;
import net.minecraft.client.renderer.entity.RenderLayerParent;
import net.minecraft.client.renderer.entity.layers.HumanoidArmorLayer;
import net.minecraft.client.renderer.entity.layers.RenderLayer;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.EquipmentSlot;
import net.minecraft.world.entity.LivingEntity;
import net.minecraft.world.item.ArmorItem;
import net.minecraft.world.item.ItemStack;
@Mixin(HumanoidArmorLayer.class)
@Environment(EnvType.CLIENT)
public abstract class MixinArmorFeatureRenderer extends RenderLayer {
@Shadow
@Final
private static Map<String, ResourceLocation> ARMOR_LOCATION_CACHE;
public MixinArmorFeatureRenderer(RenderLayerParent context) {
super(context);
}
@Unique
private LivingEntity storedEntity;
@Unique
private EquipmentSlot storedSlot;
@Inject(method = "render", at = @At("HEAD"))
private void storeEntity(PoseStack matrixStack, MultiBufferSource vertexConsumerProvider, int i, LivingEntity livingEntity, float f, float g, float h, float j, float k, float l, CallbackInfo ci) {
// We store the living entity wearing the armor before we render
this.storedEntity = livingEntity;
}
@Inject(method = "renderArmorPiece", at = @At("HEAD"))
private void storeSlot(PoseStack matrices, MultiBufferSource vertexConsumers, LivingEntity livingEntity, EquipmentSlot slot, int i, HumanoidModel bipedEntityModel, CallbackInfo ci) {
// We store the current armor slot that is rendering before we render each armor piece
this.storedSlot = slot;
}
@Inject(method = "render", at = @At("RETURN"))
private void removeStored(PoseStack matrixStack, MultiBufferSource vertexConsumerProvider, int i, LivingEntity livingEntity, float f, float g, float h, float j, float k, float l, CallbackInfo ci) {
// We remove the stored data after we render
this.storedEntity = null;
this.storedSlot = null;
}
@Inject(method = "getArmorModel", at = @At("RETURN"), cancellable = true)
private void selectArmorModel(EquipmentSlot slot, CallbackInfoReturnable<HumanoidModel<LivingEntity>> cir) {
ItemStack stack = storedEntity.getItemBySlot(slot);
HumanoidModel<LivingEntity> defaultModel = cir.getReturnValue();
HumanoidModel<LivingEntity> model = ArmorRenderingRegistry.getArmorModel(storedEntity, stack, slot, defaultModel);
if (model != defaultModel) {
cir.setReturnValue(model);
}
}
@Inject(method = "getArmorLocation", at = @At(value = "INVOKE", target = "Ljava/util/Map;computeIfAbsent(Ljava/lang/Object;Ljava/util/function/Function;)Ljava/lang/Object;"), cancellable = true, locals = LocalCapture.CAPTURE_FAILHARD)
private void getArmorTexture(ArmorItem armorItem, boolean secondLayer, /* @Nullable */ String suffix, CallbackInfoReturnable<ResourceLocation> cir, String vanillaIdentifier) {
String texture = ArmorRenderingRegistry.getArmorTexture(storedEntity, storedEntity.getItemBySlot(storedSlot), storedSlot, secondLayer, suffix, new ResourceLocation(vanillaIdentifier)).toString();
if (!Objects.equals(texture, vanillaIdentifier)) {
cir.setReturnValue(ARMOR_LOCATION_CACHE.computeIfAbsent(texture, ResourceLocation::new));
}
}
}

View file

@ -0,0 +1,57 @@
/*
* Copyright (c) 2016, 2017, 2018, 2019 FabricMC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
This file is a refactor from fabric-api, based on the work of shedaniel.
*/
package shadow.fabric.mixin.client.rendering;
import net.minecraft.world.item.Item;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.Unique;
import shadow.fabric.api.client.rendering.v1.ArmorRenderingRegistry;
import shadow.fabric.impl.client.rendering.ArmorProviderExtensions;
@Mixin(Item.class)
public class MixinItem implements ArmorProviderExtensions {
@Unique
private ArmorRenderingRegistry.ModelProvider armorModelProvider;
@Unique
private ArmorRenderingRegistry.TextureProvider armorTextureProvider;
@Override
public ArmorRenderingRegistry.ModelProvider fabric_getArmorModelProvider() {
return armorModelProvider;
}
@Override
public ArmorRenderingRegistry.TextureProvider fabric_getArmorTextureProvider() {
return armorTextureProvider;
}
@Override
public void fabric_setArmorModelProvider(ArmorRenderingRegistry.ModelProvider provider) {
armorModelProvider = provider;
}
@Override
public void fabric_setArmorTextureProvider(ArmorRenderingRegistry.TextureProvider provider) {
armorTextureProvider = provider;
}
}

View file

@ -0,0 +1,13 @@
{
"required": true,
"minVersion": "0.8",
"package": "shadow.fabric.mixin.client.rendering",
"compatibilityLevel": "JAVA_16",
"client": [
"MixinArmorFeatureRenderer",
"MixinItem"
],
"injectors": {
"defaultRequire": 1
}
}

View file

@ -36,7 +36,8 @@
},
"mixins": [
"betterend.mixins.common.json",
"betterend.mixins.client.json"
"betterend.mixins.client.json",
"betterend.mixins.shadow.json"
],
"depends": {