Add pet leveling data

Author: lineargraph

src/main/java/io/github/moulberry/repo/NEUConstants.java

@@ -24,6 +24,8 @@ public class NEUConstants implements IReloadable {
     Misc misc;
     @Getter
     Leveling leveling;
+    @Getter
+    PetLevelingData petLevelingData;
 
     public void reload(NEURepository repository) throws NEURepositoryException {
         bonuses = repository.requireFile("constants/bonuses.json").json(Bonuses.class);
@@ -36,6 +38,7 @@ public void reload(NEURepository repository) throws NEURepositoryException {
         }));
         misc = repository.requireFile("constants/misc.json").json(Misc.class);
         leveling = repository.requireFile("constants/leveling.json").json(Leveling.class);
+        petLevelingData = repository.requireFile("constants/pets.json").json(PetLevelingData.class);
     }
 
 

src/main/java/io/github/moulberry/repo/constants/PetLevelingBehaviourOverride.java

@@ -0,0 +1,70 @@
+package io.github.moulberry.repo.constants;
+
+import com.google.gson.annotations.SerializedName;
+import io.github.moulberry.repo.data.Rarity;
+import lombok.Getter;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
+import java.util.Map;
+
+public class PetLevelingBehaviourOverride {
+    /**
+     * Constant multiplier for all exp gains. If not present should be treated as {@code 1.0}
+     */
+    @Getter
+    @SerializedName("xp_multiplier")
+    @Nullable
+    Double xpMultiplier;
+
+    /**
+     * Offset the {@link PetLevelingData#getPetExpCostForLevel() pet leveling cost} by a specified amount for each rarity.
+     * This replaces the default behaviour in {@link PetLevelingData#getPetLevelStartOffset()}.
+     */
+    @Getter
+    @SerializedName("pet_rarity_offset")
+    Map<Rarity, Integer> petLevelStartOffset;
+
+    @SerializedName("type")
+    @Getter
+    @ApiStatus.Obsolete
+    Integer rawLevelOverrideType;
+
+    /**
+     * Override the max level of this pet.
+     */
+    @SerializedName("max_level")
+    @Getter
+    Integer maxLevel;
+
+    /**
+     * List of levels to replace or augment the default ones in {@link PetLevelingData#getPetExpCostForLevel()}
+     */
+    @SerializedName("pet_levels")
+    @Getter
+    List<Integer> petExpCostModifier;
+
+    /**
+     * Specify how {@link #getPetExpCostModifier() the pet exp cost modifier list} should be used.
+     */
+    @Nullable
+    public PetExpModifierType getPetExpCostModifierType() {
+        if (rawLevelOverrideType == 1) return PetExpModifierType.APPEND;
+        if (rawLevelOverrideType == 2) return PetExpModifierType.REPLACE;
+        return null;
+    }
+
+    public enum PetExpModifierType {
+        /**
+         * Append the data in {@link #getPetExpCostModifier()} to {@link PetLevelingData#getPetExpCostForLevel()}.
+         */
+        APPEND,
+        /**
+         * Replace the data in {@link PetLevelingData#getPetExpCostForLevel()} with {@link  #getPetExpCostModifier()}
+         */
+        REPLACE,
+        ;
+    }
+
+}

src/main/java/io/github/moulberry/repo/constants/PetLevelingData.java

@@ -0,0 +1,39 @@
+package io.github.moulberry.repo.constants;
+
+import com.google.gson.annotations.SerializedName;
+import io.github.moulberry.repo.data.Rarity;
+import io.github.moulberry.repo.util.PetId;
+import lombok.Getter;
+
+import java.util.List;
+import java.util.Map;
+
+@Getter
+public class PetLevelingData {
+    /**
+     * Offset the {@link #getPetExpCostForLevel() pet leveling cost} by a specified amount for each rarity.
+     */
+    @SerializedName("pet_rarity_offset")
+    Map<Rarity, Integer> petLevelStartOffset;
+    /**
+     * EXP needed for each individual pet level. This cost is offset by {@link #getPetLevelStartOffset() the pet level start offset} and then
+     * capped according to
+     */
+    @SerializedName("pet_levels")
+    List<Integer> petExpCostForLevel;
+
+    /**
+     * A map of pet name to overrides in the leveling behaviour.
+     */
+    @SerializedName("custom_pet_leveling")
+    Map<@PetId String, PetLevelingBehaviourOverride> petLevelingBehaviourOverrides;
+
+    /**
+     * A map of pet name to the kind of exp it uses.
+     * Uses the standard skill names, but may include {@code ALL} or might not be present for pets that
+     * do not level up via normal means.
+     */
+    @SerializedName("pet_types")
+    Map<@PetId String, String> petExpTypes;
+
+}

src/main/java/io/github/moulberry/repo/util/PetId.java

@@ -0,0 +1,16 @@
+package io.github.moulberry.repo.util;
+
+import java.lang.annotation.*;
+
+/**
+ * Indicates that this string is a pet id. Unlike {@link NEUId}, this pet id
+ * does not include the {@code ;RARITY} postfix. So an {@link PetId} {@link String}
+ * would be {@code "BEE"}, while a {@link NEUId} {@link String} would be {@code "BEE;2"}.
+ * When applied to a method, indicates the return type is a pet id.
+ * When applied to a parameter, field, or local variable indicated that the variable type is a pet id.
+ */
+@Documented
+@Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD, ElementType.TYPE_USE})
+@Retention(RetentionPolicy.CLASS)
+public @interface PetId {
+}

src/test/java/TestMain.java

@@ -23,6 +23,8 @@ public static void main(String[] args) throws NEURepositoryException {
                 .filter(it -> it instanceof NEUUnknownRecipe).map(it -> (NEUUnknownRecipe) it)
                 .map(NEUUnknownRecipe::getType)
                 .collect(Collectors.toSet()));
+        System.out.println("pet exp type for ROCK: " + repository.getConstants().getPetLevelingData().getPetExpTypes().get("ROCK"));
+        System.out.println("max level of golden dragon: " + repository.getConstants().getPetLevelingData().getPetLevelingBehaviourOverrides().get("GOLDEN_DRAGON").getMaxLevel());
         System.out.println("amount of people with rainbow names: " + repository.getConstants().getMisc().getRainbowNames().size());
         System.out.println("display name for dynamic zone: " + repository.getConstants().getMisc().getAreaNames().get("dynamic"));
         System.out.println("max blaze minion level: " + repository.getConstants().getMisc().getMaxMinionLevel().get("BLAZE_GENERATOR"));