Gets the location of the model's body, facing the model's yaw: the mob's body yaw reached with turning inertia when weightedTurning is on (see updateModelYaw), otherwise the body yaw itself.

getDynamicEntities

public static HashMap<UUID, DynamicEntity> getDynamicEntities()

getDynamicEntity

public static DynamicEntity getDynamicEntity(Entity entity)

getLocation

public Location getLocation()

getTravelOrientation

public TravelOrientation getTravelOrientation()

How the model leans with its travel; upright by default.

hasSteeringRider

public boolean hasSteeringRider()

isClickSurface

public boolean isClickSurface()

When true, clients get an invisible Interaction entity over the model, so players click the model they see instead of the body's own box.

isCosmeticInvisibility

public boolean isCosmeticInvisibility()

When true, the underlying entity's invisibility potion is cosmetic (used to hide the vanilla model while showing the custom one) and should NOT hide the custom model bones.

isDamagesOnContact

public boolean isDamagesOnContact()

isDynamicEntity

public static boolean isDynamicEntity(Entity entity)

isSteerableMount

public boolean isSteerableMount()

Whether a player could steer this mob: vanilla lets the first passenger of a saddled horse ride it.

isSyncMovement

public boolean isSyncMovement()

Whether the model's position and rotation should be synced with the underlying entity.

isViewerTrackedBody

public boolean isViewerTrackedBody()

When true, the entity stays hidden by default but each Java viewer of the model tracks it as an invisible, bare body (see SkeletonWatchers), so the display bones can ride it like a mount's.

liftSaddleTo

public void liftSaddleTo(Bone seat)

Scales the mob so its saddle, the seat a vanilla rider steers it from, lands on the given seat bone at the model's rest pose: the bone's Blockbench origin, in blocks from the model's feet, at the model's own scale.

onSpawnComplete

protected void onSpawnComplete()

Hook invoked once the spawn path and display initialization have completed successfully, immediately before this entity is published to the tickable registry.

onSpawnFailed

protected void onSpawnFailed()

Subclasses undo any registry entry installed by a partial onSpawnComplete.

remove

public void remove()

removeKeepingBody

protected void removeKeepingBody()

Takes the model off its entity and leaves the entity in the world, for another model to take its place.

ridesUnderlyingEntity

protected boolean ridesUnderlyingEntity()

Whether Java clients track the underlying entity, which its bones need in order to ride it.

seatScale

protected double seatScale()

The part of the underlying entity's scale that only moves its rider's seat, which the model leaves out.

seatSteeringRider

public boolean seatSteeringRider(Player player)

Seats the player on the mob itself when it is a saddled horse nobody rides, as a vanilla rider who steers it.

setClickSurface

public void setClickSurface(boolean clickSurface)

When true, clients get an invisible Interaction entity over the model, so players click the model they see instead of the body's own box.

setDamagesOnContact

public void setDamagesOnContact(boolean damagesOnContact)

setLookTarget

public void setLookTarget(@Nullable() @Nullable() Location target)

Faces the model toward a world position, aiming head bones independently at that position.

setSyncMovement

public void setSyncMovement(boolean syncMovement)

Sets whether the model's position and rotation should be synced with the underlying entity.

setTravelOrientation

public void setTravelOrientation(@Nullable() @Nullable() TravelOrientation orientation)

Sets how the model leans with its travel; null stands it upright again.

shutdown

public static void shutdown()

spawn

public void spawn(LivingEntity entity)

tick

public void tick(AbstractPacketBundle abstractPacketBundle)

Inherited functions

attack

public void attack(LivingEntity target)

Performs an attack on the specified living entity target.

public void attack(LivingEntity target, double damage)

Attacks the specified target entity with a specified amount of damage.

bodyHeight

protected double bodyHeight()

Height of the entity the model is on, in blocks, or 0 without one.

clearBrightnessOverride

public ModeledEntity clearBrightnessOverride()

Drops the fixed light set by setBrightnessOverride, so the bones take the light where they are again.

damage

public void damage(double amount)

Inflicts damage on the entity based on the specified amount.

public void damage(Entity damager)

Applies damage to this entity as inflicted by the specified damager.

public boolean damage(Projectile projectile)

Applies damage to the current entity based on the attributes of the provided projectile (impact speed, base damage, and bow enchantments such as Power and Piercing).

public void damage(Entity damager, double amount)

Inflicts damage on this entity by a specified amount, attributed to the given damager.

displayInitializer

protected void displayInitializer()

getAnimationComponent

public AnimationComponent getAnimationComponent()

getBedrockModeledEntity

public BedrockModeledEntity getBedrockModeledEntity()

getBodyOffset

public double getBodyOffset()

Blocks the model is drawn above its entity's feet: none while it stands on them; for a model centred on its body, whatever puts the middle of its cubes on the body's middle, below the feet when the model is the taller.

getBodyTilt

@Nullable()

public @Nullable() Quaterniondc getBodyTilt()

The world-space lean the whole model takes about its middle, or null while it stands upright.

getBodyTiltPivotHeight

public double getBodyTiltPivotHeight()

Blocks above the entity's feet that a body tilt turns about: the middle of the model's cubes at its current scale, where it is drawn.

getBoneTransformLocation

public Location getBoneTransformLocation()

Gets the location to use for bone transforms.

getBoxLift

public double getBoxLift(double height)

Blocks above the entity's feet where a box of this height standing for the model starts: at the feet, or for a model centred on its body, wherever centres the box on the body too.

getBrightnessOverrideBlockLight

public int getBrightnessOverrideBlockLight()

The fixed block light of the bones, or -1 without an override.

getBrightnessOverrideSkyLight

public int getBrightnessOverrideSkyLight()

The fixed sky light of the bones, or -1 without an override.

getDamageableComponent

public DamageableComponent getDamageableComponent()

getDisplayName

public String getDisplayName()

getEffectiveViewDistance

public int getEffectiveViewDistance()

Returns the effective view distance for this entity.

getEntityID

public String getEntityID()

getFileModelConverter

public FileModelConverter getFileModelConverter()

getHitboxComponent

public HitboxComponent getHitboxComponent()

getInteractionComponent

public InteractionComponent getInteractionComponent()

getLoadedModeledEntities

public static Set<ModeledEntity> getLoadedModeledEntities()

getLoadedModeledEntitiesWithUnderlyingEntities

public static HashMap<Entity, ModeledEntity> getLoadedModeledEntitiesWithUnderlyingEntities()

getModelBottomHeight

public double getModelBottomHeight()

Blocks above the entity's feet of the model's lowest cube as drawn, at its current scale.

getModeledEntity

public static ModeledEntity getModeledEntity(Entity entity)

O(1) single-entity lookup against the live underlying-entity registry.

getModelInstanceId

public UUID getModelInstanceId()

Stable identity for this logical model instance.

getModelMiddleHeight

public double getModelMiddleHeight()

Blocks above the model's own feet of the middle of its cubes, at its current scale.

getMountPointManager

public MountPointManager getMountPointManager()

getNameplate

public StackedText getNameplate()

getNameplateLocation

public Location getNameplateLocation()

Authored nametag position, or a fallback above the model's hitbox.

getNametagBones

public List<Bone> getNametagBones()

Returns the name tag locations.

getParticleComponent

public ParticleComponent getParticleComponent()

getRiddenBody

@Nullable()

public @Nullable() Entity getRiddenBody()

The entity this model's display bones ride, or null when they are placed freely.

getScaleModifier

public double getScaleModifier()

getSkeleton

public Skeleton getSkeleton()

getSkeletonBlueprint

public SkeletonBlueprint getSkeletonBlueprint()

getSpawnLocation

public Location getSpawnLocation()

getTintColor

public Color getTintColor()

Returns the persistent tint set via setTintColor, or null if no persistent tint has been applied.

getUnderlyingEntity

public Entity getUnderlyingEntity()

getViewers

public HashSet<UUID> getViewers()

Gets the set of UUIDs of all viewers (players who can see the entity)

getWorld

public World getWorld()

hasAnimation

public boolean hasAnimation(String animationName)

Checks if the specified animation exists in the animation component.

hasBrightnessOverride

public boolean hasBrightnessOverride()

Whether setBrightnessOverride lights the bones at a fixed level.

hasViewDistanceOverride

public boolean hasViewDistanceOverride()

Whether this model has its own view distance.

hideFrom

public void hideFrom(Player player)

Hides this model from one player while everyone else keeps seeing it.

hideUnderlyingEntity

public void hideUnderlyingEntity(Player player)

isCenteredOnBody

public boolean isCenteredOnBody()

isDying

public boolean isDying()

Whether the entity is currently dying.

isHiddenFrom

public boolean isHiddenFrom(Player player)

Whether hideFrom has hidden this model from the player.

isRemoved

public boolean isRemoved()

playAnimation

public boolean playAnimation(String animationName, boolean blendAnimation, boolean loop)

Plays an animation as set by the string name.

removeWithDeathAnimation

public void removeWithDeathAnimation()

removeWithMinimizedAnimation

public void removeWithMinimizedAnimation()

setBodyTilt

public void setBodyTilt(@Nullable() @Nullable() Quaterniondc tilt)

Leans the whole model: a world-space rotation about the middle of its height, applied after it faces its heading and after its animations.

setBrightnessOverride

public ModeledEntity setBrightnessOverride(int blockLight, int skyLight)

Lights every display bone at a fixed level instead of the light where it stands, as a glowing creature or a lantern needs.

setCachedBoneTransformLocation

public void setCachedBoneTransformLocation(Location location)

Sets the cached bone transform location.

setCenteredOnBody

public void setCenteredOnBody(boolean centered)

Draws the model with the middle of its cubes on the middle of its entity instead of standing on the entity's feet.

setDisplayName

public void setDisplayName(String displayName)

setDisplayNameLineGap

public void setDisplayNameLineGap(double gap)

Clear gap in blocks at scale 1; scaled Java text scales both glyphs and spacing.

setDisplayNameLines

public void setDisplayNameLines(List<String> lines)

Lines are top-to-bottom; the last line remains at the model's name anchor.

setDisplayNameScale

public void setDisplayNameScale(float scale)

setDisplayNameVisible

public void setDisplayNameVisible(boolean visible)

setHitboxContactCallback

public ModeledEntity setHitboxContactCallback(ModeledEntityHitboxContactCallback callback)

Sets the callback to be triggered when a player contacts the hitbox of this entity.

setLeftClickCallback

public ModeledEntity setLeftClickCallback(ModeledEntityLeftClickCallback callback)

Sets a callback to be invoked when the entity is left-clicked by a player.

setModeledEntityHitByProjectileCallback

public ModeledEntity setModeledEntityHitByProjectileCallback(ModeledEntityHitByProjectileCallback callback)

setRightClickCallback

public ModeledEntity setRightClickCallback(ModeledEntityRightClickCallback callback)

Sets a callback that is triggered when the entity is right-clicked by a player.

setScaleModifier

public void setScaleModifier(double scaleModifier)

setTintColor

public ModeledEntity setTintColor(Color color)

Persistent tint applied via the leather-armor dye channel.

setUnderlyingEntity

public void setUnderlyingEntity(Entity underlyingEntity)

setViewDistanceOverride

public ModeledEntity setViewDistanceOverride(int blocks)

Overrides the plugin-wide default view distance for this single modeled entity.

showTo

public void showTo(Player player)

Undoes hideFrom.

showUnderlyingEntity

public void showUnderlyingEntity(Player player)

shutdownRemove

protected void shutdownRemove()

spawn

public void spawn()

public void spawn(Location location)

public void spawn(Entity entity)

stopCurrentAnimations

public void stopCurrentAnimations()

Stops all currently running animations.

teleport

public void teleport(Location location, boolean teleportUnderlyingEntity)

Teleports the entity represented by this ModeledEntity to the specified location.

updateBedrockAnimations

public void updateBedrockAnimations(String baseAnimation, String actionAnimation)

Shows Bedrock clients the base animation and the action layered over it; either may be null.