Create a basic api to add Animations. Fix #217

src/main/java/dev/tr7zw/notenoughanimations/animations/fullbody/CrawlingAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.fullbody;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.RenderStateHolder;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/fullbody/FallingAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.fullbody;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import dev.tr7zw.notenoughanimations.versionless.animations.DataHolder;

src/main/java/dev/tr7zw/notenoughanimations/animations/fullbody/FreezingAnimation.java

@@ -2,7 +2,7 @@
 package dev.tr7zw.notenoughanimations.animations.fullbody;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/fullbody/LadderAnimation.java

@@ -5,8 +5,8 @@
 import java.util.Set;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
-import dev.tr7zw.notenoughanimations.animations.PoseOverwrite;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.PoseOverwrite;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.util.RenderStateHolder;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;

src/main/java/dev/tr7zw/notenoughanimations/animations/fullbody/PassengerAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.fullbody;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.PlayerModel;
 import net.minecraft.client.player.AbstractClientPlayer;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/BoatAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/CustomBowAnimation.java

@@ -3,7 +3,7 @@
 import java.util.EnumSet;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/EatDrinkAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/HorseAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/HugAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/ItemSwapAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/LookAtItemAnimation.java

@@ -4,7 +4,7 @@
 import java.util.Set;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/MapHoldingAnimation.java

@@ -4,7 +4,7 @@
 import java.util.Set;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.util.NMSWrapper;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/NarutoRunningAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/hands/PetAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.hands;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/DeathAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.PlayerModel;
 import net.minecraft.client.player.AbstractClientPlayer;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/ElytraAnimation.java

@@ -1,8 +1,8 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
-import dev.tr7zw.notenoughanimations.animations.PoseOverwrite;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.PoseOverwrite;
 import dev.tr7zw.notenoughanimations.util.RenderStateHolder;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/RiptideAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.PlayerModel;
 import net.minecraft.client.player.AbstractClientPlayer;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/SleepAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/SwimAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.PlayerModel;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/VanillaShieldAnimation.java

@@ -1,7 +1,7 @@
 package dev.tr7zw.notenoughanimations.animations.vanilla;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.NEABaseMod;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/VanillaSingleHandedAnimation.java

@@ -3,7 +3,7 @@
 import java.util.EnumSet;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.HumanoidModel.ArmPose;

src/main/java/dev/tr7zw/notenoughanimations/animations/vanilla/VanillaTwoHandedAnimation.java

@@ -3,7 +3,7 @@
 import java.util.EnumSet;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
 import dev.tr7zw.notenoughanimations.util.AnimationUtil;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.HumanoidModel.ArmPose;

src/main/java/dev/tr7zw/notenoughanimations/animations/BasicAnimation.java → src/main/java/dev/tr7zw/notenoughanimations/api/BasicAnimation.java

@@ -1,4 +1,4 @@
-package dev.tr7zw.notenoughanimations.animations;
+package dev.tr7zw.notenoughanimations.api;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
@@ -9,13 +9,27 @@ public abstract class BasicAnimation {
 
     private boolean isPrepared = false;
 
+    /**
+     * Check if the animation is enabled in the settings.
+     * 
+     * @return true when enabled
+     */
     public abstract boolean isEnabled();
 
+    /**
+     * Check if this animation wants to apply to the provided player right now. When
+     * true, the priorities determine if and which body parts will be assigned to
+     * this animation.
+     * 
+     * @param entity
+     * @param data
+     * @return
+     */
     public abstract boolean isValid(AbstractClientPlayer entity, PlayerData data);
 
     /**
      * Gets the body parts this animation should be applied to, expects that isValid
-     * is called before.
+     * is called before, so state can be cached from isValid to this method.
      * 
      * @param entity
      * @param data
@@ -47,11 +61,31 @@ public void cleanup() {
         isPrepared = false;
     }
 
+    /**
+     * This method allows to precalculate data to be then used in the apply method
+     * to reduce overhead.
+     * 
+     * @param entity
+     * @param data
+     * @param model
+     * @param delta
+     * @param tickCounter
+     */
     protected void precalculate(AbstractClientPlayer entity, PlayerData data, PlayerModel model, float delta,
             float tickCounter) {
         // not used by default
     }
 
+    /**
+     * Apply the animation to the provided bodypart.
+     * 
+     * @param entity
+     * @param data
+     * @param model
+     * @param part
+     * @param delta
+     * @param tickCounter
+     */
     public abstract void apply(AbstractClientPlayer entity, PlayerData data, PlayerModel model, BodyPart part,
             float delta, float tickCounter);
 

src/main/java/dev/tr7zw/notenoughanimations/api/NotEnoughAnimationsApi.java

@@ -0,0 +1,25 @@
+package dev.tr7zw.notenoughanimations.api;
+
+import dev.tr7zw.notenoughanimations.NEAnimationsMod;
+
+public class NotEnoughAnimationsApi {
+
+    /**
+     * Register a new {@link BasicAnimation} to the mod. BasicAnimations can
+     * implement {@link PoseOverwrite} to access these features.
+     * 
+     * @param animation
+     */
+    public static void registerAnimation(BasicAnimation animation) {
+        NEAnimationsMod.INSTANCE.animationProvider.addAnimation(animation);
+    }
+
+    /**
+     * Refreshes which animations are enabled right now. Should be called after
+     * {@link BasicAnimation#isEnabled()} might have changed.
+     */
+    public static void refreshEnabledAnimations() {
+        NEAnimationsMod.INSTANCE.animationProvider.refreshEnabledAnimations();
+    }
+
+}

src/main/java/dev/tr7zw/notenoughanimations/animations/PoseOverwrite.java → src/main/java/dev/tr7zw/notenoughanimations/api/PoseOverwrite.java

@@ -1,4 +1,4 @@
-package dev.tr7zw.notenoughanimations.animations;
+package dev.tr7zw.notenoughanimations.api;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
 import net.minecraft.client.model.PlayerModel;

src/main/java/dev/tr7zw/notenoughanimations/logic/AnimationProvider.java

@@ -6,8 +6,6 @@
 import java.util.Set;
 
 import dev.tr7zw.notenoughanimations.access.PlayerData;
-import dev.tr7zw.notenoughanimations.animations.BasicAnimation;
-import dev.tr7zw.notenoughanimations.animations.PoseOverwrite;
 import dev.tr7zw.notenoughanimations.animations.fullbody.CrawlingAnimation;
 import dev.tr7zw.notenoughanimations.animations.fullbody.FallingAnimation;
 import dev.tr7zw.notenoughanimations.animations.fullbody.LadderAnimation;
@@ -30,6 +28,8 @@
 import dev.tr7zw.notenoughanimations.animations.vanilla.VanillaShieldAnimation;
 import dev.tr7zw.notenoughanimations.animations.vanilla.VanillaSingleHandedAnimation;
 import dev.tr7zw.notenoughanimations.animations.vanilla.VanillaTwoHandedAnimation;
+import dev.tr7zw.notenoughanimations.api.BasicAnimation;
+import dev.tr7zw.notenoughanimations.api.PoseOverwrite;
 import dev.tr7zw.notenoughanimations.versionless.animations.BodyPart;
 import net.minecraft.client.model.PlayerModel;
 import net.minecraft.client.player.AbstractClientPlayer;