Add example animated entity using keyframe anims

SizableShrimp · SizableShrimp · commit 9d5b1a65cee3 · 2022-07-03T20:54:06.000-05:00
diff --git a/gradle.properties b/gradle.properties
@@ -5,13 +5,13 @@ org.gradle.daemon=false
 
 minecraft_version=1.19
 minecraft_version_range=[1.19,1.20)
-forge_version=41.0.30
+forge_version=41.0.63
 # The forge version range can use version of forge or match the loader version range
 forge_version_range=[41.0.21,)
 # The loader version range can only be the major version of Forge/FML!
 loader_version_range=[41,)
 mappings_channel=parchment
-mappings_version=1.18.2-2022.06.05-1.19
+mappings_version=1.18.2-2022.07.03-1.19
 
 mod_id=entitymodeljson
 mod_name=Entity Model Json
diff --git a/src/main/java/me/sizableshrimp/entitymodeljson/animation/EntityAnimations.java b/src/main/java/me/sizableshrimp/entitymodeljson/animation/EntityAnimations.java
@@ -33,12 +33,12 @@ public class EntityAnimations {
     static Map<ResourceLocation, AnimationDefinition> definitions = Map.of();
 
     @NotNull
-    public Optional<AnimationDefinition> getDefinition(ResourceLocation id) {
+    public static Optional<AnimationDefinition> getDefinition(ResourceLocation id) {
         return Optional.ofNullable(definitions.get(id));
     }
 
     @NotNull
-    public AnimationDefinition getDefinitionOrThrow(ResourceLocation id) {
+    public static AnimationDefinition getDefinitionOrThrow(ResourceLocation id) {
         AnimationDefinition animationDefinition = definitions.get(id);
         if (animationDefinition == null)
             throw new IllegalArgumentException("Missing entity animation definition with id " + id);
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/EntityModelJsonExampleMod.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/EntityModelJsonExampleMod.java
@@ -22,10 +22,15 @@
 
 package me.sizableshrimp.entitymodeljsonexample;
 
+import me.sizableshrimp.entitymodeljsonexample.animal.ExampleAnimal;
+import me.sizableshrimp.entitymodeljsonexample.animal.ExampleAnimalRenderer;
+import me.sizableshrimp.entitymodeljsonexample.animated.ExampleAnimatedEntityRenderer;
+import me.sizableshrimp.entitymodeljsonexample.data.ExampleEntityModelProvider;
 import net.minecraft.data.DataGenerator;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.entity.EntityType;
 import net.minecraft.world.entity.MobCategory;
+import net.minecraft.world.entity.monster.warden.Warden;
 import net.minecraftforge.client.event.EntityRenderersEvent;
 import net.minecraftforge.common.data.ExistingFileHelper;
 import net.minecraftforge.event.entity.EntityAttributeCreationEvent;
@@ -46,6 +51,10 @@ public class EntityModelJsonExampleMod {
 
     public static final DeferredRegister<EntityType<?>> ENTITIES = DeferredRegister.create(ForgeRegistries.ENTITIES, MODID);
     public static final RegistryObject<EntityType<ExampleAnimal>> EXAMPLE_ANIMAL = registerEntity("animal", () -> EntityType.Builder.of(ExampleAnimal::new, MobCategory.AMBIENT));
+    public static final RegistryObject<EntityType<Warden>> EXAMPLE_ANIMATED_ENTITY = registerEntity("animated", () -> EntityType.Builder.of(Warden::new, MobCategory.MONSTER)
+            .sized(0.9F, 2.9F)
+            .clientTrackingRange(16)
+            .fireImmune());
 
     public EntityModelJsonExampleMod() {
         IEventBus modBus = FMLJavaModLoadingContext.get().getModEventBus();
@@ -57,11 +66,13 @@ public EntityModelJsonExampleMod() {
     @SubscribeEvent
     public void onRegisterEntityRenderers(EntityRenderersEvent.RegisterRenderers event) {
         event.registerEntityRenderer(EXAMPLE_ANIMAL.get(), ExampleAnimalRenderer::new);
+        event.registerEntityRenderer(EXAMPLE_ANIMATED_ENTITY.get(), ExampleAnimatedEntityRenderer::new);
     }
 
     @SubscribeEvent
     public void onEntityAttributeCreation(EntityAttributeCreationEvent event) {
         event.put(EXAMPLE_ANIMAL.get(), ExampleAnimal.createAttributes().build());
+        event.put(EXAMPLE_ANIMATED_ENTITY.get(), Warden.createAttributes().build());
     }
 
     @SubscribeEvent
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimal.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimal.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 SizableShrimp
+ * Copyright (c) 2022 SizableShrimp
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-package me.sizableshrimp.entitymodeljsonexample;
+package me.sizableshrimp.entitymodeljsonexample.animal;
 
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.world.entity.AgeableMob;
@@ -33,7 +33,7 @@
 import org.jetbrains.annotations.Nullable;
 
 public class ExampleAnimal extends Animal {
-    protected ExampleAnimal(EntityType<? extends Animal> entityType, Level level) {
+    public ExampleAnimal(EntityType<? extends ExampleAnimal> entityType, Level level) {
         super(entityType, level);
     }
 
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimalModel.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimalModel.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2022 SizableShrimp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package me.sizableshrimp.entitymodeljsonexample.animal;
+
+import net.minecraft.client.model.HierarchicalModel;
+import net.minecraft.client.model.geom.ModelPart;
+
+public class ExampleAnimalModel extends HierarchicalModel<ExampleAnimal> {
+    private final ModelPart root;
+
+    public ExampleAnimalModel(ModelPart root) {
+        this.root = root;
+    }
+
+    @Override
+    public void setupAnim(ExampleAnimal entity, float limbSwing, float limbSwingAmount, float ageInTicks, float netHeadYaw, float headPitch) {}
+
+    @Override
+    public ModelPart root() {
+        return root;
+    }
+}
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimalRenderer.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimalRenderer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 SizableShrimp
+ * Copyright (c) 2022 SizableShrimp
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -20,12 +20,11 @@
  * SOFTWARE.
  */
 
-package me.sizableshrimp.entitymodeljsonexample;
+package me.sizableshrimp.entitymodeljsonexample.animal;
 
+import me.sizableshrimp.entitymodeljsonexample.EntityModelJsonExampleMod;
 import net.minecraft.client.model.EntityModel;
-import net.minecraft.client.model.HierarchicalModel;
 import net.minecraft.client.model.geom.ModelLayerLocation;
-import net.minecraft.client.model.geom.ModelPart;
 import net.minecraft.client.renderer.entity.EntityRendererProvider;
 import net.minecraft.client.renderer.entity.MobRenderer;
 import net.minecraft.resources.ResourceLocation;
@@ -34,9 +33,9 @@ public class ExampleAnimalRenderer extends MobRenderer<ExampleAnimal, EntityMode
     // The layer, in this case "main", becomes the root folder for the entity model
     // All JSON entity models reside in assets/modid/models/entity.
     // This model location translates to assets/entitymodeljsonexample/models/entity/main/example_animal.json
-    public static final ModelLayerLocation EXAMPLE_ANIMAL_MODEL_LOCATION = new ModelLayerLocation(new ResourceLocation(EntityModelJsonExampleMod.MODID, "allay"), "main");
+    public static final ModelLayerLocation EXAMPLE_ANIMAL_MODEL_LOCATION = new ModelLayerLocation(new ResourceLocation(EntityModelJsonExampleMod.MODID, "example_animal"), "main");
     // The actual texture PNG
-    public static final ResourceLocation SQUID_LOCATION = new ResourceLocation(EntityModelJsonExampleMod.MODID, "textures/entity/allay.png");
+    public static final ResourceLocation TEXTURE_LOCATION = new ResourceLocation("textures/entity/armorstand/wood.png");
 
     public ExampleAnimalRenderer(EntityRendererProvider.Context context) {
         // Bake the model location, this will get a ModelPart with the data defined in the custom JSON file
@@ -45,22 +44,6 @@ public ExampleAnimalRenderer(EntityRendererProvider.Context context) {
 
     @Override
     public ResourceLocation getTextureLocation(ExampleAnimal entity) {
-        return SQUID_LOCATION;
-    }
-
-    public static class ExampleAnimalModel extends HierarchicalModel<ExampleAnimal> {
-        private final ModelPart root;
-
-        public ExampleAnimalModel(ModelPart root) {
-            this.root = root;
-        }
-
-        @Override
-        public void setupAnim(ExampleAnimal entity, float limbSwing, float limbSwingAmount, float ageInTicks, float netHeadYaw, float headPitch) {}
-
-        @Override
-        public ModelPart root() {
-            return root;
-        }
+        return TEXTURE_LOCATION;
     }
 }
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/animated/ExampleAnimatedEntityModel.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/animated/ExampleAnimatedEntityModel.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2022 SizableShrimp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package me.sizableshrimp.entitymodeljsonexample.animated;
+
+import me.sizableshrimp.entitymodeljson.animation.EntityAnimations;
+import me.sizableshrimp.entitymodeljsonexample.EntityModelJsonExampleMod;
+import net.minecraft.client.animation.AnimationDefinition;
+import net.minecraft.client.animation.definitions.WardenAnimation;
+import net.minecraft.client.model.HierarchicalModel;
+import net.minecraft.client.model.geom.ModelPart;
+import net.minecraft.client.renderer.RenderType;
+import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.entity.monster.warden.Warden;
+
+public class ExampleAnimatedEntityModel extends HierarchicalModel<Warden> {
+    // All JSON entity animation definitions reside in assets/modid/animations/entity.
+    // This resource location with path "warden/attack" translates to assets/entitymodeljsonexample/animations/entity/warden/attack.json
+    private static final ResourceLocation ATTACK_LOCATION = new ResourceLocation(EntityModelJsonExampleMod.MODID, "warden/attack");
+    private final ModelPart root;
+    private final AnimationDefinition attackAnimation;
+
+    public ExampleAnimatedEntityModel(ModelPart root) {
+        super(RenderType::entityCutoutNoCull);
+        this.root = root;
+        // Query the animation definition from the loaded animations
+        this.attackAnimation = EntityAnimations.getDefinitionOrThrow(ATTACK_LOCATION);
+    }
+
+    @Override
+    public void setupAnim(Warden warden, float limbSwing, float limbSwingAmount, float ageInTicks, float netHeadYaw, float headPitch) {
+        this.root().getAllParts().forEach(ModelPart::resetPose);
+
+        // Keep playing the attack animation to demo it
+        if (warden.attackAnimationState.getAccumulatedTime() >= this.attackAnimation.lengthInSeconds() * 1000L) {
+            warden.attackAnimationState.start(warden.tickCount);
+        }
+
+        // Animate the attack animation; this should always be run and will just do nothing if the animation is not playing
+        this.animate(warden.attackAnimationState, this.attackAnimation, ageInTicks);
+    }
+
+    @Override
+    public ModelPart root() {
+        return this.root;
+    }
+}
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/animated/ExampleAnimatedEntityRenderer.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/animated/ExampleAnimatedEntityRenderer.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2022 SizableShrimp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package me.sizableshrimp.entitymodeljsonexample.animated;
+
+import net.minecraft.client.model.geom.ModelLayers;
+import net.minecraft.client.renderer.entity.EntityRendererProvider;
+import net.minecraft.client.renderer.entity.MobRenderer;
+import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.entity.monster.warden.Warden;
+
+public class ExampleAnimatedEntityRenderer extends MobRenderer<Warden, ExampleAnimatedEntityModel> {
+    private static final ResourceLocation TEXTURE = new ResourceLocation("textures/entity/warden/warden.png");
+
+    public ExampleAnimatedEntityRenderer(EntityRendererProvider.Context context) {
+        super(context, new ExampleAnimatedEntityModel(context.bakeLayer(ModelLayers.WARDEN)), 0.9F);
+    }
+
+    @Override
+    public ResourceLocation getTextureLocation(Warden warden) {
+        return TEXTURE;
+    }
+}
diff --git a/src/test/java/me/sizableshrimp/entitymodeljsonexample/data/ExampleEntityModelProvider.java b/src/test/java/me/sizableshrimp/entitymodeljsonexample/data/ExampleEntityModelProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 SizableShrimp
+ * Copyright (c) 2022 SizableShrimp
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -20,9 +20,10 @@
  * SOFTWARE.
  */
 
-package me.sizableshrimp.entitymodeljsonexample;
+package me.sizableshrimp.entitymodeljsonexample.data;
 
 import me.sizableshrimp.entitymodeljson.datagen.EntityModelProvider;
+import me.sizableshrimp.entitymodeljsonexample.EntityModelJsonExampleMod;
 import net.minecraft.client.model.geom.ModelLayers;
 import net.minecraft.client.model.geom.PartPose;
 import net.minecraft.data.DataGenerator;
diff --git a/src/test/resources/assets/entitymodeljsonexample/animations/entity/warden/attack.json b/src/test/resources/assets/entitymodeljsonexample/animations/entity/warden/attack.json
