Tameable

TameableAnimal ¶

Python

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

Bases: Creature

Base tameable animal entity class.

owner_uuid `property` ¶

Python

owner_uuid: Optional[str]

Owner UUID.

RETURNS	DESCRIPTION
`Optional[str]`	The UUID of the owner, None if not owned.

is_sitting `property` ¶

Python

is_sitting: bool

Whether animal is sitting (bit 0).

RETURNS	DESCRIPTION
`bool`	True if the animal is sitting, False otherwise.

is_angry `property` ¶

Python

is_angry: bool

Whether animal is angry (bit 1).

RETURNS	DESCRIPTION
`bool`	True if the animal is angry, False otherwise.

is_tamed `property` ¶

Python

is_tamed: bool

Whether animal is tamed (bit 2).

RETURNS	DESCRIPTION
`bool`	True if the animal is tamed, False otherwise.

has_owner `property` ¶

Python

has_owner: bool

Whether animal has an owner.

RETURNS	DESCRIPTION
`bool`	True if the animal has an owner, 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

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`

Wolf ¶

Python

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

Bases: TameableAnimal

Wolf entity extending TameableAnimal.

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

damage_taken `property` ¶

Python

damage_taken: float

Damage taken (used for tail rotation).

RETURNS	DESCRIPTION
`float`	The amount of damage taken, defaults to current health.

is_begging `property` ¶

Python

is_begging: bool

Whether wolf is begging.

RETURNS	DESCRIPTION
`bool`	True if the wolf is begging, False otherwise.

collar_color `property` ¶

Python

collar_color: int

Collar color (dye values).

RETURNS	DESCRIPTION
`int`	The collar color ID (default: 14 for red).

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

owner_uuid `property` ¶

Python

owner_uuid: Optional[str]

Owner UUID.

RETURNS	DESCRIPTION
`Optional[str]`	The UUID of the owner, None if not owned.

is_sitting `property` ¶

Python

is_sitting: bool

Whether animal is sitting (bit 0).

RETURNS	DESCRIPTION
`bool`	True if the animal is sitting, False otherwise.

is_angry `property` ¶

Python

is_angry: bool

Whether animal is angry (bit 1).

RETURNS	DESCRIPTION
`bool`	True if the animal is angry, False otherwise.

is_tamed `property` ¶

Python

is_tamed: bool

Whether animal is tamed (bit 2).

RETURNS	DESCRIPTION
`bool`	True if the animal is tamed, False otherwise.

has_owner `property` ¶

Python

has_owner: bool

Whether animal has an owner.

RETURNS	DESCRIPTION
`bool`	True if the animal has an owner, 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`

Ocelot ¶

Python

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

Bases: TameableAnimal

Ocelot entity extending TameableAnimal.

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

ocelot_type `property` ¶

Python

ocelot_type: int

Ocelot type.

RETURNS	DESCRIPTION
`int`	The ocelot type (0: untamed, 1: tuxedo, 2: tabby, 3: siamese).

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

owner_uuid `property` ¶

Python

owner_uuid: Optional[str]

Owner UUID.

RETURNS	DESCRIPTION
`Optional[str]`	The UUID of the owner, None if not owned.

is_sitting `property` ¶

Python

is_sitting: bool

Whether animal is sitting (bit 0).

RETURNS	DESCRIPTION
`bool`	True if the animal is sitting, False otherwise.

is_angry `property` ¶

Python

is_angry: bool

Whether animal is angry (bit 1).

RETURNS	DESCRIPTION
`bool`	True if the animal is angry, False otherwise.

is_tamed `property` ¶

Python

is_tamed: bool

Whether animal is tamed (bit 2).

RETURNS	DESCRIPTION
`bool`	True if the animal is tamed, False otherwise.

has_owner `property` ¶

Python

has_owner: bool

Whether animal has an owner.

RETURNS	DESCRIPTION
`bool`	True if the animal has an owner, 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`

Parrot ¶

Python

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

Bases: TameableAnimal

Parrot entity extending TameableAnimal.

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

variant `property` ¶

Python

variant: int

Parrot variant.

RETURNS	DESCRIPTION
`int`	The parrot variant (0: red/blue, 1: blue, 2: green, 3: yellow/blue, 4: silver).

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

owner_uuid `property` ¶

Python

owner_uuid: Optional[str]

Owner UUID.

RETURNS	DESCRIPTION
`Optional[str]`	The UUID of the owner, None if not owned.

is_sitting `property` ¶

Python

is_sitting: bool

Whether animal is sitting (bit 0).

RETURNS	DESCRIPTION
`bool`	True if the animal is sitting, False otherwise.

is_angry `property` ¶

Python

is_angry: bool

Whether animal is angry (bit 1).

RETURNS	DESCRIPTION
`bool`	True if the animal is angry, False otherwise.

is_tamed `property` ¶

Python

is_tamed: bool

Whether animal is tamed (bit 2).

RETURNS	DESCRIPTION
`bool`	True if the animal is tamed, False otherwise.

has_owner `property` ¶

Python

has_owner: bool

Whether animal has an owner.

RETURNS	DESCRIPTION
`bool`	True if the animal has an owner, 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`

Tameable

TameableAnimal ¶

owner_uuid property ¶

is_sitting property ¶

is_angry property ¶

is_tamed property ¶

has_owner property ¶

air property ¶

custom_name property ¶

is_custom_name_visible property ¶

is_silent property ¶

no_gravity property ¶

max_health property ¶

movement_speed property ¶

armor property ¶

attack_speed property ¶

on_fire property ¶

crouched property ¶

sprinting property ¶

invisible property ¶

glowing property ¶

flying_with_elytra property ¶

equipment property ¶

has_equipment property ¶

hand_states property ¶

health property ¶

potion_effect_color property ¶

is_potion_effect_ambient property ¶

arrows_in_entity property ¶

is_hand_active property ¶

active_hand property ¶

no_ai property ¶

left_handed property ¶

update_metadata ¶

update_properties ¶

get_attribute ¶

get_metadata_value ¶

set_equipment ¶

Wolf ¶

damage_taken property ¶

is_begging property ¶

collar_color property ¶

air property ¶

custom_name property ¶

is_custom_name_visible property ¶

is_silent property ¶

no_gravity property ¶

max_health property ¶

movement_speed property ¶

armor property ¶

attack_speed property ¶

on_fire property ¶

crouched property ¶

sprinting property ¶

invisible property ¶

glowing property ¶

flying_with_elytra property ¶

equipment property ¶

has_equipment property ¶

hand_states property ¶

health property ¶

potion_effect_color property ¶

is_potion_effect_ambient property ¶

arrows_in_entity property ¶

is_hand_active property ¶

active_hand property ¶

no_ai property ¶

left_handed property ¶

owner_uuid property ¶

is_sitting property ¶

is_angry property ¶

is_tamed property ¶

has_owner property ¶

update_metadata ¶

update_properties ¶

get_attribute ¶

get_metadata_value ¶

set_equipment ¶

Ocelot ¶

ocelot_type property ¶

owner_uuid `property` ¶

is_sitting `property` ¶

is_angry `property` ¶

is_tamed `property` ¶

has_owner `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

equipment `property` ¶

has_equipment `property` ¶

hand_states `property` ¶

health `property` ¶

potion_effect_color `property` ¶

is_potion_effect_ambient `property` ¶

arrows_in_entity `property` ¶

is_hand_active `property` ¶

active_hand `property` ¶

no_ai `property` ¶

left_handed `property` ¶

damage_taken `property` ¶

is_begging `property` ¶

collar_color `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

equipment `property` ¶

has_equipment `property` ¶

hand_states `property` ¶

health `property` ¶

potion_effect_color `property` ¶

is_potion_effect_ambient `property` ¶

arrows_in_entity `property` ¶

is_hand_active `property` ¶

active_hand `property` ¶

no_ai `property` ¶

left_handed `property` ¶

owner_uuid `property` ¶

is_sitting `property` ¶

is_angry `property` ¶

is_tamed `property` ¶

has_owner `property` ¶

ocelot_type `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶