Animals

Ageable

Python

Ageable(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Creature

Base class for ageable mob entities.

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

AbstractHorse

Python

AbstractHorse(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Abstract base class for horse-type entities.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

ChestedHorse

Python

ChestedHorse(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: AbstractHorse

Base class for horse entities that can carry chests.

has_chest property

Python

has_chest: bool

Whether the horse is currently equipped with a chest.

RETURNS	DESCRIPTION
bool	True if carrying a chest, False otherwise.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Pig

Python

Pig(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Pig entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for pigs. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the pig. TYPE: ClassVar[Tuple[float, float]]

has_saddle property

Python

has_saddle: bool

Whether the pig is equipped with a saddle for riding.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

boost_time property

Python

boost_time: int

Total time remaining for carrot on stick boost effect.

RETURNS	DESCRIPTION
int	Boost time in ticks, 0 if not boosting.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Sheep

Python

Sheep(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Sheep entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for sheep. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the sheep. TYPE: ClassVar[Tuple[float, float]]

color property

Python

color: int

The wool color of the sheep.

RETURNS	DESCRIPTION
int	Color ID matching dye damage values (0-15).

is_sheared property

Python

is_sheared: bool

Whether the sheep has been sheared and is growing wool back.

RETURNS	DESCRIPTION
bool	True if recently sheared, False if wool has grown back.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Cow

Python

Cow(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Cow entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for cows. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the cow. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Chicken

Python

Chicken(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Chicken entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for chickens. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the chicken. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Rabbit

Python

Rabbit(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Rabbit entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for rabbits. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the rabbit. TYPE: ClassVar[Tuple[float, float]]

rabbit_type property

Python

rabbit_type: int

The visual variant type of the rabbit.

RETURNS	DESCRIPTION
int	Rabbit type ID determining appearance and behavior.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

PolarBear

Python

PolarBear(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Polar Bear entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for polar bears. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the polar bear. TYPE: ClassVar[Tuple[float, float]]

is_standing_up property

Python

is_standing_up: bool

Whether the polar bear is standing on its hind legs.

RETURNS	DESCRIPTION
bool	True if standing up, False if on all fours.

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

MushroomCow

Python

MushroomCow(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: Ageable

Mooshroom entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for mooshrooms. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the mooshroom. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Horse

Python

Horse(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: AbstractHorse

Horse entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for horses. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the horse. TYPE: ClassVar[Tuple[float, float]]

variant property

Python

variant: int

The visual variant combining color and markings.

RETURNS	DESCRIPTION
int	Variant ID determining the horse's appearance.

armor_type property

Python

armor_type: int

The type of armor currently equipped on the horse.

RETURNS	DESCRIPTION
int	Armor type (0: none, 1: iron, 2: gold, 3: diamond).

armor_item property

Python

armor_item: Optional[Dict[str, Any]]

The armor item data currently equipped.

RETURNS	DESCRIPTION
Optional[Dict[str, Any]]	Armor item data if equipped, None otherwise. (Forge only)

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

ZombieHorse

Python

ZombieHorse(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: AbstractHorse

Zombie Horse entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for zombie horses. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the zombie horse. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

SkeletonHorse

Python

SkeletonHorse(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: AbstractHorse

Skeleton Horse entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for skeleton horses. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the skeleton horse. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Donkey

Python

Donkey(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: ChestedHorse

Donkey entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for donkeys. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the donkey. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

has_chest property

Python

has_chest: bool

Whether the horse is currently equipped with a chest.

RETURNS	DESCRIPTION
bool	True if carrying a chest, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Llama

Python

Llama(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: ChestedHorse

Llama entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for llamas. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the llama. TYPE: ClassVar[Tuple[float, float]]

strength property

Python

strength: int

Number of columns of inventory slots when chest is equipped.

RETURNS	DESCRIPTION
int	Inventory strength (columns of 3 slots each).

carpet_color property

Python

carpet_color: int

The color of carpet decoration on the llama.

RETURNS	DESCRIPTION
int	Carpet color ID matching dye colors, or -1 if no carpet.

variant property

Python

variant: int

The visual variant of the llama.

RETURNS	DESCRIPTION
int	Variant ID (0: creamy, 1: white, 2: brown, 3: gray).

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

has_chest property

Python

has_chest: bool

Whether the horse is currently equipped with a chest.

RETURNS	DESCRIPTION
bool	True if carrying a chest, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None

---

Mule

Python

Mule(
    entity_id: int,
    uuid: str,
    position: Vector3D[float],
    rotation: Rotation,
    metadata: Dict[int, Any],
)

Bases: ChestedHorse

Mule entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for mules. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the mule. TYPE: ClassVar[Tuple[float, float]]

air property

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
int	Number of air ticks remaining before drowning

custom_name property

Python

custom_name: Optional[str]

Custom name text component or None.

RETURNS	DESCRIPTION
Optional[str]	Custom display name for the entity, or None if not set

is_custom_name_visible property

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS	DESCRIPTION
bool	True if custom name should be displayed above the entity

is_silent property

Python

is_silent: bool

Whether entity makes sounds.

RETURNS	DESCRIPTION
bool	True if entity is silent and won't produce sounds

no_gravity property

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
bool	True if entity ignores gravity effects

max_health property

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
float	Maximum health points for this entity

movement_speed property

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
float	Movement speed multiplier for this entity

armor property

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
float	Armor points providing damage reduction

attack_speed property

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
float	Attack speed multiplier for this entity

on_fire property

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if entity is currently on fire

crouched property

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
bool	True if entity is in crouching state

sprinting property

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
bool	True if entity is currently sprinting

invisible property

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
bool	True if entity has invisibility effect active

glowing property

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
bool	True if entity has glowing outline effect

flying_with_elytra property

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
bool	True if entity is gliding with elytra wings

equipment property

Python

equipment: Dict[int, gui.Slot]

Get all equipment slots.

RETURNS	DESCRIPTION
Dict[int, gui.Slot]	Dictionary mapping slot IDs to their equipment slots.

has_equipment property

Python

has_equipment: bool

Check if the entity has any equipment.

RETURNS	DESCRIPTION
bool	True if entity has equipment, False otherwise.

hand_states property

Python

hand_states: int

Hand state bit mask.

RETURNS	DESCRIPTION
int	Bit mask containing hand usage states

health property

Python

health: float

Current health value.

RETURNS	DESCRIPTION
float	Current health points remaining

potion_effect_color property

Python

potion_effect_color: int

Potion effect particle color.

RETURNS	DESCRIPTION
int	RGB color value for potion effect particles

is_potion_effect_ambient property

Python

is_potion_effect_ambient: bool

Whether potion effect is ambient.

RETURNS	DESCRIPTION
bool	True if potion effect particles are ambient (less visible)

arrows_in_entity property

Python

arrows_in_entity: int

Number of arrows stuck in entity.

RETURNS	DESCRIPTION
int	Count of arrows visually stuck in the entity

is_hand_active property

Python

is_hand_active: bool

Whether hand is active (using item).

RETURNS	DESCRIPTION
bool	True if entity is currently using an item with their hand

active_hand property

Python

active_hand: int

Which hand is active (0=main, 1=off).

RETURNS	DESCRIPTION
int	Hand index: 0 for main hand, 1 for off-hand

no_ai property

Python

no_ai: bool

Whether AI is disabled (bit 0).

RETURNS	DESCRIPTION
bool	True if entity's AI behavior is disabled

left_handed property

Python

left_handed: bool

Whether entity is left-handed (bit 1).

RETURNS	DESCRIPTION
bool	True if entity prefers using left hand for actions

is_baby property

Python

is_baby: bool

Whether the entity is currently in baby form.

RETURNS	DESCRIPTION
bool	True if the entity is a baby, False if adult.

owner_uuid property

Python

owner_uuid: Optional[str]

UUID of the player who owns this horse.

RETURNS	DESCRIPTION
Optional[str]	Owner's UUID string if tamed, None if wild.

is_tame property

Python

is_tame: bool

Whether the horse has been tamed by a player.

RETURNS	DESCRIPTION
bool	True if tamed, False if wild.

is_saddled property

Python

is_saddled: bool

Whether the horse is currently equipped with a saddle.

RETURNS	DESCRIPTION
bool	True if saddled, False otherwise.

has_bred property

Python

has_bred: bool

Whether the horse has been bred at least once.

RETURNS	DESCRIPTION
bool	True if it has bred, False otherwise.

is_eating property

Python

is_eating: bool

Whether the horse is currently eating.

RETURNS	DESCRIPTION
bool	True if eating, False otherwise.

is_rearing property

Python

is_rearing: bool

Whether the horse is rearing up on its hind legs.

RETURNS	DESCRIPTION
bool	True if rearing, False otherwise.

is_mouth_open property

Python

is_mouth_open: bool

Whether the horse's mouth is currently open.

RETURNS	DESCRIPTION
bool	True if mouth open, False otherwise.

has_chest property

Python

has_chest: bool

Whether the horse is currently equipped with a chest.

RETURNS	DESCRIPTION
bool	True if carrying a chest, False otherwise.

update_metadata

Python

update_metadata(metadata: Dict[int, Any]) -> None

Update entity metadata from metadata packet.

PARAMETER	DESCRIPTION
metadata	New metadata values indexed by metadata ID TYPE: Dict[int, Any]

update_properties

Python

update_properties(
    properties: Dict[str, Dict[str, Any]],
) -> None

Update entity attributes from properties packet.

PARAMETER	DESCRIPTION
properties	Attribute properties containing base values and modifiers TYPE: Dict[str, Dict[str, Any]]

get_attribute

Python

get_attribute(key: str, default: float = 0.0) -> float

Get final attribute value.

PARAMETER	DESCRIPTION
key	Attribute key name TYPE: str
default	Default value if attribute not found. TYPE: float DEFAULT: 0.0

RETURNS	DESCRIPTION
float	Final attribute value after applying modifiers

get_metadata_value

Python

get_metadata_value(index: int, default: Any = None) -> Any

Get metadata value by index with default fallback.

PARAMETER	DESCRIPTION
index	Metadata index to retrieve TYPE: int
default	Default value if metadata not found. TYPE: Any DEFAULT: None

RETURNS	DESCRIPTION
Any	Metadata value at the specified index, or default if not found

set_equipment

Python

set_equipment(slot: gui.Slot) -> None

Set equipment in the specified slot.

RETURNS	DESCRIPTION
None