FreeMinecraftModels/com.magmaguy.freeminecraftmodels.customentity/PlayerDisguiseEntity

PlayerDisguiseEntity

public class PlayerDisguiseEntity extends ModeledEntity

A modeled entity that visually replaces a player. The disguised Player is held as a direct reference — this class does NOT set the player as the underlyingEntity, so the modeled-entity-with-underlying registry, packet interaction entity, and RegisterModelEntity PDC tagging are all bypassed naturally (no special-casing needed in shared code).

Lifecycle is owned by DisguiseManager; instances should not be created or destroyed directly outside the manager or the public API.

Properties

animationController

public final DisguiseAnimationController animationController

disguisedPlayer

public final Player disguisedPlayer

Inherited properties

animationComponent

public final AnimationComponent animationComponent

bedrockModeledEntity

public BedrockModeledEntity bedrockModeledEntity

bodyTilt

public volatile Quaterniondc bodyTilt

cachedBoneTransformLocation

protected Location cachedBoneTransformLocation

currentLocation

protected Location currentLocation

damageableComponent

public final DamageableComponent damageableComponent

displayName

public String displayName

entityID

public final String entityID

fileModelConverter

public final FileModelConverter fileModelConverter

hitboxComponent

public final HitboxComponent hitboxComponent

interactionComponent

public final InteractionComponent interactionComponent

isDying

public boolean isDying

Whether the entity is currently dying.

isRemoved

public volatile boolean isRemoved

loadedModeledEntities

public final static Set<ModeledEntity> loadedModeledEntities

modelInstanceId

public final UUID modelInstanceId

Stable identity for this logical model instance.

mountPointManager

public MountPointManager mountPointManager

nameplate

public final StackedText nameplate

particleComponent

public final ParticleComponent particleComponent

scaleModifier

public double scaleModifier

skeleton

public Skeleton skeleton

skeletonBlueprint

public SkeletonBlueprint skeletonBlueprint

spawnLocation

protected Location spawnLocation

underlyingEntity

protected Entity underlyingEntity

Functions

displayInitializer

protected void displayInitializer()

Disguises must not spawn a packet interaction entity — the model is decorative and clicks should pass through to the underlying player.

getAnimationController

public DisguiseAnimationController getAnimationController()

getDisguisedPlayer

public Player getDisguisedPlayer()

getLocation

public Location getLocation()

hideEquipmentFor

public void hideEquipmentFor(Player viewer)

Sends an empty-equipment override to viewer so the disguised player's armor / held items don't render on the viewer's screen.

reapplyInvisibilityIfOurs

public void reapplyInvisibilityIfOurs()

Re-applies the invisibility potion effect if this disguise originally applied it.

remove

public void remove()

restoreEquipmentFor

public void restoreEquipmentFor(Player viewer)

Re-sends the disguised player's actual equipment to viewer so the client picks up what they're really wearing.

tick

public void tick(AbstractPacketBundle bundle)

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.

bonesCanRideUnderlyingEntity

protected boolean bonesCanRideUnderlyingEntity()

Whether the bones ride the underlying entity for viewers that track it.

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.

deathLocation

protected Location deathLocation()

Where the model stays while its death animation plays.

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()

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.

playAnimation