FreeMinecraftModels/com.magmaguy.freeminecraftmodels.pets/PetSpecies

PetSpecies

public final class PetSpecies

One pet species, read from a <species>.pet.yml file that sits beside its model in the models folder, so a model pack ships, enables and disables its pets together with its models. It names the model and the body the model rides, and says how the species is tamed, bred and raised, how it floats and follows, and where it lives wild.

Types

public enum Placement

Where a wild group may stand when it spawns, like a vanilla mob's spawn placement: on the ground, in water, in the air just over a water surface, or in the open air over solid ground.

public enum TimeOfDay

public final class Variant extends Record

A model the species' pets may wear, its share of the picks, and the behavior modules it adds to the species'.

public final class WildSpawn extends Record

How the species appears wild in CREATURES mode, shaped like a vanilla mob's entry in a biome's spawn list: a weight against the other species that may spawn at the same spot, a group size, where the group may stand, and the light, world, environment, biome and height it needs.

Properties

public final static String FILE_SUFFIX

Functions

babyGrowthMillis

public long babyGrowthMillis()

public String babyModel()

public double babyScale()

public List<PetBehaviorEntry> behaviors(String model)

The modules a pet wearing this model runs: the species' list or its locomotion's defaults, then the variant's.

public EntityType body()

breedingCooldownMillis

public long breedingCooldownMillis()

public List<Material> breedingFood()

public boolean canStay()

public boolean centerOnBody()

Whether the model is drawn centred on its hidden body rather than standing on its feet.

public File file()

public double followDistance()

public double health()

public double hoverHeight()

public double hoverVariance()

public Material icon()

public NamespacedKey iconItemModel()

An item model for the pets menu icon, or null to show the icon material as it is.

public String id()

public PetInteractions interactions()

The species' look in night migrations; its migration() is null when off.

public boolean isBreedingFood(ItemStack item)

public boolean isTamingFood(ItemStack item)

public double leashDistance()

public boolean listsBehaviors()

Whether the pet file lists its own behaviors; false when it has no list or one that is not a list, and the species runs its locomotion's defaults.

public static PetSpecies load(File file)

The species a pet file defines, or null when the file is disabled or unreadable.

public MindBodyLocomotion locomotion()

public int loveTicks()

public String model()

public String name()

public TravelOrientation orientation()

How the model leans with its travel.

public String pickVariant(Random random)

A variant model by weight, or the species' model when it lists none.

public double roamRadius()

public double scale()

public double speed()

public double tameChance()

public List<Material> tamingFood()

teleportDistance

public double teleportDistance()

public List<PetSpecies.Variant> variants()

public PetSpecies.WildSpawn wildSpawn()