All Classes and Interfaces
Class
Description
Abstraction over the pathfinding/movement system for a pet entity.
Marker interface for skills that can be manually activated by the player (e.g., via
a command or hotkey).
An experience modifier that adds a fixed amount to the incoming experience value.
Single source of truth for MyPet admin permission node strings + parent-gate helper.
This interface defines that the hook checks if a player is in any a place where he is allowed to have a pet
Resolve an annotation-carried name (e.g.
Skill that grants the pet vanilla armor points and armor toughness via attribute
modifiers, so incoming damage (melee, projectiles, explosions) is reduced by
Minecraft's own armor formula.
Skill that grants the pet a portable inventory (backpack) which the owner can open
to store and retrieve items.
Snapshot of a Backpack skill's persisted or live contents as a raw item array.
Skill that allows the pet to act as a mobile beacon, periodically applying configurable
potion-effect buffs to nearby players.
Enumerates the potion-effect buffs that the Beacon skill can apply.
Determines which players receive the beacon's potion-effect buffs.
Context for the Beacon buff-selection menu.
Snapshot of a Beacon skill's persisted or live state — the player-chosen buffs, the toggle, and the receiver scope.
This interface defines hooks that control beacon skill behavior in regions
Skill that controls the pet's combat behavior mode.
Enumerates the possible pet behavior modes.
Snapshot of a Behavior skill's selected mode (persisted or live).
Skill that gives the pet a chance to inflict a bleeding damage-over-time effect on
hit targets.
Outer-ring decoration.
Skill that turns the pet invisible after it stands still for a configured number of
seconds.
Base of every
PetEvent that listeners may veto.Payload routed to
MenuHandler.onClick(de.Keyle.MyPet.api.gui.MenuInstance, java.lang.String, de.Keyle.MyPet.api.gui.ClickPayload) for every click inside a tracked menu.Skill that lets a pet climb walls on its own during pathfinding, spider-style: when the
pet is heading somewhere higher and beyond a wall it's pressed against, it scales the wall as a
shortcut instead of pathing all the way around, then resumes normal navigation once it crests.
Why a
MenuInstance is closing.Information a
JsonCodec needs at decode time to validate section data
against its surrounding menu (bounds, sibling presence, etc.).A configured item — typically loaded from config (e.g.,
RIDE_ITEM,
CONTROL_ITEM, GROW_UP_ITEM) and compared against items the
player is holding.How an item's durability is taken into account when matching.
A per-pet config value, declared as a
public static final field
on the matching PetXxx pet class — the pet class is the single
source of truth for its species' config.Central registry of every
ConfigKey declared as a static field on
a pet class.One YAML file on disk, with load, save and clear operations over its parsed contents.
Parameters for a yes/no confirm prompt opened via
DialogService.promptConfirm(org.bukkit.entity.Player, de.Keyle.MyPet.api.dialog.ConfirmPromptSpec, java.lang.Runnable, java.lang.Runnable).Skill that enables the owner to direct their pet to move to a specific location by
left-clicking on a block with a configured control item.
API-only inventory implementation
Generic carrier for sections whose type is registered at runtime (e.g.
Skill that determines the pet's base melee attack damage.
The built-in experience calculator that ships with MyPet.
Declares the out-of-box defaults for a pet type.
Opens text and confirm prompts for a viewer using whichever transport
the implementation has available (anvil rename, chat conversation, or
a chest-menu confirm).
This interface defines that the hook handles economy interactions
Receives the errors MyPet catches, so they can be reported somewhere useful.
Utility class for centralized error reporting.
Disk-backed cache for pre-computed experience-per-level values.
Thrown when a requested level has not yet been computed and cached.
Strategy interface for computing the cumulative experience required at each pet level.
Service responsible for managing available
ExperienceCalculator implementations
and switching between them at runtime.Abstract base class for experience modifiers that transform the amount of experience a pet
receives from a kill.
Geometric experience curve: each level
l costs Base * Growth^(l-1), summed
from level 1 up to the target.Backdrop fill.
A rectangular part of the menu to fill, instead of the whole thing.
Skill that gives the pet a chance to ignite targets on hit, setting them on fire for
a configurable duration.
Skill that lets the pet periodically fish at nearby open water, dropping
vanilla fishing loot beside itself.
Inclusive `[min, max]` float range; samples uniformly.
This interface defines that the hook checks if a player can fly his pet at a certain location
An experience modifier that multiplies incoming experience by the server-wide global factor.
Service facade.
Skin source applied to a
PLAYER_HEAD item.Skill that passively regenerates the pet's health over time.
The
HookHelper is a wrapper for the hooks of the default functionality this plugin needs from other plugins.Deprecated, for removal: This API element is subject to removal in a future version.
Thrown when a
.st.json skilltree file fails to parse — malformed
JSON, missing required fields, or invalid skill/level references.Pure visual description of one item slot.
Round-trips a full
ItemStack (including all meta) to and from a paste-safe
one-line string, for storing items in skilltree JSON.JSON ↔ section-record bridge.
Skill that gives the pet a chance to knock back targets on hit, pushing them away
from the pet.
This interface defines that the hook checks if the leashed entity will be removed
A single condition that must be satisfied before a player can leash
(tame) a mob as a pet.
Central registry for
LeashFlag implementations.Declares the config-facing name of a
LeashFlag implementation.This interface defines that the hook checks if players can attack an entity
A rule that determines whether a particular upgrade or notification should activate at a
given pet level.
Matches levels by an "every
modulo levels" pattern, optionally restricted to the
inclusive range [start, end] (end == 0 means unbounded).Matches an explicit, fixed set of levels.
Skill that increases the pet's maximum health (hit points).
Skill that gives the pet a chance to strike the target with a lightning bolt on hit.
Flat experience curve: every level costs the same
Base amount, so the cumulative
experience to reach level L is Base * (L - 1).Declares the startup phase at which a
ServiceContainer should be loaded.The startup phases a service can be loaded at.
MyPet's translation facility.
Skill that lets the pet periodically fell a nearby tree (a log column with a
leaf canopy), dropping the logs naturally.
Immutable resolved blueprint for one menu.
Per-menu Java logic.
Typed identity of a registered menu.
Catalog of built-in
MenuIds.Runtime handle for one open menu.
Volatile UI state captured when a menu is pushed onto the navigation stack.
Skill that lets the pet periodically mine one exposed ore block near itself,
dropping the ore's natural drops.
Represents the experience value (or range) awarded to a pet when a specific mob type is killed.
This interface defines that the hook handles custom exp values from mobs of other plugins
This interface defines that the hook checks if a player tries to enter a region by mounting their pet
An experience modifier that multiplies the incoming experience by a configurable factor.
Static entry point to the MyPet API: every manager, service and hook an addon can
reach is reached through one of the accessors here.
Plugin-wide settings from
config.yml, each a ConfigKey
declared as a public static final field — the single source of truth
for global config, mirroring the per-pet ConfigKey fields on each
PetXxx class.Pet saturation: how it drains, how it is restored, and what starving costs.
Which experience curve pets level along.
Tunable parameters for the built-in
Linear/Power/Exponential XP curves.How pets earn and lose experience.
Multipliers applied to experience a pet earns.
Assorted server-wide behaviour that does not belong to a larger system.
Limits and presentation for pet names.
The floating name tag drawn above a pet.
How strictly permission nodes are enforced.
Where pets are persisted, and how that storage is reached.
Connection details for the
MySQL repository type.How long a dead pet takes to come back, and what reviving it costs.
Skilltree assignment rules and the fee for switching.
Per-skill server-wide settings.
The Backpack skill.
The Beacon skill.
The Fishing skill.
The Lumberjack skill.
The Mining skill.
The Ride skill.
The built-in update checker and downloader.
Browser-based config editor (`/mypet editor`) — relay endpoints + on/off.
Represents a player who owns (or may own) pets.
API-facing contract for the MyPet plugin instance.
Mutable parameter bag that controls how a pet navigates the world.
Something that can write itself to NBT and read itself back.
Interface for skills that react when the pet receives damage from another
entity.
Interface for skills that trigger when the pet deals melee damage to a
target.
Rectangular region populated by a per-item template applied to a stream supplied
by the menu handler.
This interface defines that the hook handles party checks
This interface defines that the hook handles party checks
An experience modifier that grants bonus experience based on the pet owner's permissions.
Static permission-check utility.
Immutable, value-typed pet record — the canonical "pet at rest"
representation that the repository loads from disk and that callers pass
around between deactivation and reactivation.
Step-by-step construction of a
PersistedPet, for callers setting more than one field.Active, in-world pet.
Lifecycle state of a pet.
Result codes returned by
Pet.createEntity().Fired after a pet has finished transitioning from at-rest (
PersistedPet)
to live (Pet) — i.e., once the runtime entity exists, all skills are
registered and rebuilt from persisted state, and the pet is in the active-pets map.Marker for pet types whose underlying vanilla mob swims in water but also
survives on land indefinitely — axolotl, drowned, frog, turtle.
Marker for pet types whose underlying vanilla mob is a strict water-breather
— swims naturally and takes vanilla
drown-type damage when exposed
to air.Marker for pet types that have a baby/adult form.
One per-pet event handler, dispatched by the central
PetBehaviorDispatcher.Factory methods for
PetBehavior, one per common Bukkit event
shape.Central registry of every
PetBehavior declared as a static field
on a pet class.Fired when an owner attempts to spawn the world entity for an already-active
pet — i.e.
Marker for pets that expose the
chest creation flag (gives the
underlying mob a carried chest at spawn via
ChestedHorse.setCarryingChest(boolean)).Resolves per-pet config values from a runtime
Class<? extends Pet>
reference — the form marker interfaces (PetFlyingEntity.canFly,
PetSwimmingEntity.canSwim, etc.) need.Fired when a brand-new pet is created and assigned to an owner — the moment
a pet first enters the repository.
How a pet came to be created.
Fired before a pet deals mêlée damage to a target.
The per-pet distance formula, in one place.
One pet's resolved thresholds, in blocks from the owner.
Marker for pet types that can wear or hold equipment (armor, weapons,
saddles).
Common base of every MyPet event that concerns one specific pet.
Functional handler invoked by the central dispatcher when a
Event
fires on a pet whose type matches a registered PetBehavior.Fired when a pet's saturation drops to zero — the pet is hungry and would
otherwise begin losing health.
Manages a pet's experience points, level progression, and the damage-tracking maps
used to attribute kills for XP distribution.
Fired before a pet's experience changes — gain or loss.
Fired when an owner right-clicks a pet with a food
ItemStack.The visual and audible reaction a feed produces.
Marker for pet types whose underlying vanilla mob naturally flies — implies
Pet's AI/movement layer should treat this pet as airborne (no gravity,
flight pathing, no float goal).
Per-pet-type declaration of vanilla Bukkit goals that
PetGoalInstaller
should keep on the live mob at spawn time, instead of stripping every goal
via Bukkit.getMobGoals().removeAllGoals(mob).Central registry of every
PetGoalRetention declared as a static
field on a pet class.Per-type metadata registry.
Base class for pet right-click interaction events.
Marker for pet types whose underlying vanilla mob has a per-tick item-driven
right-click interaction (cow + bucket → milk, sheep and shears → wool, etc.).
Fired when something interacts with a pet's Backpack inventory.
What is being done to the backpack.
Marker for pet types whose underlying vanilla mob is immune to lava
and navigates through it naturally (Strider, all Nether skeletons, and
Magma Cube).
Fired after an experience change pushes a pet's level down — the symmetric
counterpart of
PetLevelUpEvent.Common parent for level-transition events.
Fired after an experience change pushes a pet's level up.
Per-pet-type runtime hook fired when a pet spawns and despawns.
Central registry of every
PetLifecycleHook declared as a static
field on a pet class.Marker for pet types that vanilla converts to a different species when struck
by lightning (Pig → ZombifiedPiglin, Villager → Witch).
Central registry of every Bukkit
Listener declared as a nested
static class on a pet class.Fired when the repository hands a stored pet to
PetManager for
activation — i.e., just before the manager wires it up as a live
Pet.Manages the lifecycle of active (in-world) pets and provides access to
stored (inactive) pet records.
Marker for pet types that vanilla matures into a different species once
an internal age timer expires.
A renderer provider (ModelEngine, BetterModel, ItemsAdder) that can draw a
BlockBench model on a pet's host Bukkit mob.
A source of naturally-spawned modeled creatures (MythicMobs, ItemsAdder).
Marker for pets that carry more than one rider in vanilla.
Fired when a pet's display name is about to change.
Marker for pet types whose underlying vanilla mob has a periodic AI-tick
item drop (chicken eggs, armadillo scutes, sniffer seeds, goat horns,
panda baby slimeballs, ...).
Marker for pets that can be mounted in vanilla Minecraft.
Fired before a pet's on-hit skill executes against a living target.
Fired when a pet with the Pickup skill is about to grab an
Item
entity off the ground.Fired after a
MyPetPlayer has finished joining the server — i.e.,
after the vanilla PlayerJoinEvent fires AND after MyPet has loaded
the player's pet roster from the repository, applied any pet-related
tracking (lastSeen timestamp, default-pet activation, etc.), and
registered them in the active player map.Fired when a pet is being permanently removed from the repository — the
symmetric counterpart to
PetCreateEvent.How a pet came to be removed.
Marker for pets that can be saddled in vanilla Minecraft, via any of
the three Bukkit-API saddle shapes:
SaddledMountInventory — inventory
saddle slot (Horse, Donkey, Mule, SkeletonHorse, ZombieHorse,
Camel, CamelHusk via AbstractHorseInventory;
Nautilus, ZombieNautilus via ArmoredSaddledMountInventory)
Steerable — boolean saddle flag
(Pig, Strider).Fired when a pet's persisted state is being written to the repository.
Fired when a pet has a skilltree assigned.
How a skilltree came to be assigned.
Fired when an owner runs
/mypet sendaway — the symmetric counterpart
of PetCallEvent.Fired when a pet's sit / follow toggle is about to flip.
The state a sit toggle switches the pet into.
Marker for pet types whose underlying vanilla mob has a sit animation
— Wolf, Cat, Camel, Panda, Fox.
A single per-pet boolean flag that applies to every pet type, declared
once at the feature that owns it rather than in a central loader.
Fired when a pet's lifecycle
PetState transitions — e.g., from
Here (entity in the world) to Despawned (entity removed
but pet still active) or to Dead (post-death respawn timer).Marker for pet types whose underlying vanilla mob combusts in direct
sunlight — the cohort whose Mojang counterpart returns
true from
Mob#isSunSensitive() (zombies, skeletons, and their variants) plus
Phantom (which has its own sunlight check on aiStep).Marker for pet types whose underlying vanilla mob can swim — implies
MyPet's movement layer should treat the pet as a swimmer when it's in
water (aquatic follow path, no float goal).
Marker for pets that expose the
tamed creation flag (sets the
underlying mob's tamed state to true at spawn).The single answer to "may this pet target or damage that entity?".
Registry of all available pet types.
Thrown by
PetType.byName(String) and
PetType.byEntityTypeName(String) when
the requested name does not match any registered pet type.Marker for pet types whose underlying vanilla mob is hurt by water and
rain — the cohort whose Mojang counterpart returns
true from
LivingEntity#isSensitiveToWater() (Enderman, Blaze, Snow Golem,
Strider).Marker for nether-native pet types that vanilla converts to a zombified
form when they spend too long in the Overworld (Hoglin → Zoglin, Piglin →
ZombifiedPiglin, PiglinBrute → ZombifiedPiglin).
Skill that allows the pet to automatically pick up nearby dropped items and experience
orbs on behalf of its owner.
Snapshot of the Pickup auto-toggle (persisted or live).
Mutable carrier for the
TagResolvers a section renderer assembles per
rendered item.Manages the online
MyPetPlayer cache.This interface defines that the hook checks if players can attack an entity
This interface defines that the hook checks if players can do PvP
Skill that gives the pet a chance to apply the Poison potion effect to targets on hit.
Skill that turns the pet into a field alchemist: the skilltree grants, per level, which splash
potions the pet may throw (its arsenal), each with its own cooldown.
One permitted potion and how many seconds must pass between throws of it.
Polynomial experience curve: each level
l costs Factor * l^Exponent, summed
from level 1 up to the target.Skill that enables the pet to perform ranged attacks by launching projectiles at
targets.
Enumerates the projectile types the pet can fire with the Ranged skill.
Per-render scratchpad.
A condition that must be satisfied before a pet can use a particular
Skilltree.Annotation that assigns a unique name to a
Requirement implementation.Marks a
ServiceContainer that bridges to a specific third-party Bukkit plugin.Skill that allows the pet's owner to mount and ride the pet as a controllable mount.
Skill that changes the pet's size through the vanilla
minecraft:scale
attribute.Something with recurring work MyPet should run on a schedule.
Sealed marker for every section record.
Interface a section type implements to render itself into a Bukkit
Inventory
and respond to clicks on the slots it owns.What the menu should do after a renderer has handled a click.
Pairs a section's type id with its concrete record class, renderer, and codec.
Process-wide registry of
SectionTypes by id.Decides which of a player's active pets a command with no pet named acts on.
Services are a way to register possible functionality
The
ServiceManager manages all interactions with other plugins.Annotation to add name information to the
ServiceContainer classOne token parsed out of a
Settings string.Parsed key=value bag from a Requirement or LeashFlag string like
"MinHealth:min=20:max=50".Skill that gives the pet a chance to intercept damage aimed at its owner, redirecting
a percentage of the incoming damage to itself instead.
Annotation to define shop information for a pet type.
Base interface for all pet skills in the MyPet skill system.
Annotation that declares the canonical name of a
Skill implementation.Marker interface for the typed, immutable state record exposed by a
Skill.Bundles the write and read halves of a skill's persisted state into one
object.
Self-registering handle pairing a skill's
SkillStateCodec with its
state class, declared as a static field on the skill's impl class.Represents a named skilltree that defines how a pet's skills progress as it levels up.
A level-gated notification binding.
A level-gated upgrade binding.
Represents the visual icon displayed for a
Skilltree in inventory-based selection GUIs.Central service for managing all registered
Skilltrees and Requirements.Self-registering handle pairing a skill's
UpgradeSchema with its
UpgradeParser, declared as a static field on the skill's impl class.Single-slot section.
Skill that gives the pet a chance to apply the Slowness potion effect to targets on
hit, reducing their movement speed.
Skill that lets the pet periodically "sniff out" a drop and leave it beside itself.
One weighted drop: a full item and the random stack-size range [amountMin, amountMax].
Polymorphic sound description: a fixed sound, a sound with pitch/volume ranges,
a uniform-random choice among other specs, or silence.
Picks uniformly among other specs on each play.
A sound played at a fixed volume and pitch.
A sound whose volume and pitch are sampled from a range on each play.
Plays nothing.
Skill that enables the pet to sprint (move at increased speed) when its owner is
sprinting.
Skill that gives the pet a chance to perform a ground-stomp area-of-effect attack on
hit, dealing bonus damage to all nearby entities around the target.
Free-input slots backed by an ItemStack[] supplied by the menu handler at open time
and persisted via the handler at close time.
Read-only view of a pet at rest.
Determines which targeting goal wins when multiple goals attempt to
assign a combat target simultaneously.
Skill that lets the pet growl at nearby hostile mobs, diverting their attention away
from the owner and onto the pet.
Parameters for a text-input prompt opened via
DialogService.promptText(org.bukkit.entity.Player, de.Keyle.MyPet.api.dialog.TextPromptSpec, java.util.function.Consumer<java.lang.String>, java.lang.Runnable).Skill that gives the pet a chance to reflect a portion of incoming melee damage back
to the attacker.
A skill the owner can switch on or off at runtime (from the pet menu) independently of whether
the skilltree granted it.
Persisted on/off flag for a toggleable skill.
Skill that turns the pet into a set of portable utility workstations (crafting table,
anvil, grindstone, etc.).
Enumerates the workstations the Toolbox skill can unlock.
A load step whose failure should be reported as an
InvalidSkilltreeException naming the part that failed.Represents a single level-up upgrade for a skill.
An
UpgradeModifier for boolean skill parameters.Tracks the cumulative value of a single skill property (e.g.
Indicates whether the value change was caused by adding or removing modifiers.
Listener interface notified whenever the
UpgradeComputer's current
value changes due to modifier addition or removal.An
UpgradeModifier for enum-typed skill parameters.An
UpgradeModifier for integer-typed skill parameters.A typed modifier that transforms a skill parameter value when a skilltree upgrade is applied.
An
UpgradeModifier for generic numeric skill parameters (doubles, floats, etc.).The arithmetic operation a numeric upgrade modifier can perform.
Reads one level's upgrade for a skill out of a skilltree's JSON.
Helpers for
UpgradeParser implementations.Declarative description of a skill's upgrade JSON fields, registered alongside the
UpgradeParser and shipped to the web editor as skill metadata.Collects the fields a skill's upgrade JSON declares.
One upgrade field: name (the exact JSON key the parser reads), type, and display hints.
The kinds of field a skill's upgrade JSON can declare.
Small helpers shared across the API: the sanitized MiniMessage instance for player-controlled text, a shared random source, and a few collection and HTTP conveniences.
Thrown by
SectionType codecs and the menu loader when a JSON definition fails validation.One-row horizontal slider.
This interface defines that the hook handles party checks
Per-species predicate that decides whether a wild Bukkit mob is currently
"angry" — consumed by capture-time leash flags (see
AngryFlag).Central registry of every
WildAngerCheck declared as a static
field on a pet class.Skill that gives the pet a chance to apply the Wither potion effect to targets on hit,
dealing damage over time and turning hearts black.
A named set of worlds that share pets.
Helpers for item strings that travel through YAML as a single-quoted scalar.
ItemAppearancerecord instead.