Monsters

Monster

Python

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

Bases: Creature

Base monster entity extending Creature.

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

---

Creeper

Python

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

Bases: Monster

Creeper entity.

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

state property

Python

state: int

Creeper state.

RETURNS	DESCRIPTION
int	The creeper's current state (-1 = idle, 1 = fuse).

is_charged property

Python

is_charged: bool

Whether creeper is charged.

RETURNS	DESCRIPTION
bool	True if the creeper is charged, False otherwise.

is_ignited property

Python

is_ignited: bool

Whether creeper is ignited.

RETURNS	DESCRIPTION
bool	True if the creeper is ignited, False otherwise.

is_fusing property

Python

is_fusing: bool

Whether creeper is in fuse state.

RETURNS	DESCRIPTION
bool	True if the creeper is currently fusing (about to explode), 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

---

Spider

Python

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

Bases: Monster

Spider entity.

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

is_climbing property

Python

is_climbing: bool

Whether spider is climbing (bit 0).

RETURNS	DESCRIPTION
bool	True if the spider is climbing, 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

---

CaveSpider

Python

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

Bases: Spider

Cave Spider entity extending Spider.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for cave spiders. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the cave spider. 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_climbing property

Python

is_climbing: bool

Whether spider is climbing (bit 0).

RETURNS	DESCRIPTION
bool	True if the spider is climbing, 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

---

Zombie

Python

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

Bases: Monster

Zombie entity.

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

is_baby property

Python

is_baby: bool

Whether zombie is a baby.

RETURNS	DESCRIPTION
bool	True if the zombie is a baby, False otherwise.

unused_type property

Python

unused_type: int

Unused type field.

RETURNS	DESCRIPTION
int	The unused type value.

are_hands_held_up property

Python

are_hands_held_up: bool

Whether zombie has hands held up.

RETURNS	DESCRIPTION
bool	True if the zombie has hands held up, 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

---

ZombieVillager

Python

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

Bases: Zombie

Zombie Villager entity extending Zombie.

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

is_converting property

Python

is_converting: bool

Whether zombie villager is converting.

RETURNS	DESCRIPTION
bool	True if the zombie villager is converting, False otherwise.

profession property

Python

profession: int

Zombie villager profession.

RETURNS	DESCRIPTION
int	The profession ID of the zombie villager.

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 zombie is a baby.

RETURNS	DESCRIPTION
bool	True if the zombie is a baby, False otherwise.

unused_type property

Python

unused_type: int

Unused type field.

RETURNS	DESCRIPTION
int	The unused type value.

are_hands_held_up property

Python

are_hands_held_up: bool

Whether zombie has hands held up.

RETURNS	DESCRIPTION
bool	True if the zombie has hands held up, 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

---

PigZombie

Python

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

Bases: Monster

Pig Zombie (Zombified Piglin) entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for pig zombies. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the pig zombie. 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

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

---

Husk

Python

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

Bases: Zombie

Husk entity extending Zombie.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for husks. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the husk. 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 zombie is a baby.

RETURNS	DESCRIPTION
bool	True if the zombie is a baby, False otherwise.

unused_type property

Python

unused_type: int

Unused type field.

RETURNS	DESCRIPTION
int	The unused type value.

are_hands_held_up property

Python

are_hands_held_up: bool

Whether zombie has hands held up.

RETURNS	DESCRIPTION
bool	True if the zombie has hands held up, 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

---

Giant

Python

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

Bases: Monster

Giant Zombie entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for giants. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the giant. 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

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

---

Slime

Python

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

Bases: Monster

Slime entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for slimes. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the slime. Note: Actual size is 0.51000005 * size for both dimensions. TYPE: ClassVar[Tuple[float, float]]

size property

Python

size: int

Slime size.

RETURNS	DESCRIPTION
int	The size of the slime (affects bounding box and health).

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

---

LavaSlime

Python

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

Bases: Slime

Lava Slime (Magma Cube).

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for magma cubes. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the magma cube. Note: Actual size is 0.51000005 * size for both dimensions. 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

size property

Python

size: int

Slime size.

RETURNS	DESCRIPTION
int	The size of the slime (affects bounding box and health).

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

---

Blaze

Python

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

Bases: Monster

Blaze entity.

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

is_on_fire property

Python

is_on_fire: bool

Whether blaze is on fire (bit 0).

RETURNS	DESCRIPTION
bool	True if the blaze is on fire, 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

---

Enderman

Python

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

Bases: Monster

Enderman entity.

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

carried_block property

Python

carried_block: Optional[int]

Carried block ID.

RETURNS	DESCRIPTION
Optional[int]	The block ID being carried by the enderman, or None if no block.

is_screaming property

Python

is_screaming: bool

Whether enderman is screaming.

RETURNS	DESCRIPTION
bool	True if the enderman is screaming, 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

---

Endermite

Python

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

Bases: Monster

Endermite entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for endermites. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the endermite. 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

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

---

Silverfish

Python

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

Bases: Monster

Silverfish entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for silverfish. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the silverfish. 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

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

---

Witch

Python

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

Bases: Monster

Witch entity.

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

is_drinking_potion property

Python

is_drinking_potion: bool

Whether witch is drinking potion.

RETURNS	DESCRIPTION
bool	True if the witch is drinking a potion, 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

---

Guardian

Python

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

Bases: Monster

Guardian entity.

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

is_retracting_spikes property

Python

is_retracting_spikes: bool

Whether guardian is retracting spikes.

RETURNS	DESCRIPTION
bool	True if the guardian is retracting spikes, False otherwise.

target_eid property

Python

target_eid: int

Target entity ID.

RETURNS	DESCRIPTION
int	The entity ID of the guardian's target.

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

---

ElderGuardian

Python

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

Bases: Guardian

Elder Guardian entity extending Guardian.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for elder guardians. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the elder guardian. 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_retracting_spikes property

Python

is_retracting_spikes: bool

Whether guardian is retracting spikes.

RETURNS	DESCRIPTION
bool	True if the guardian is retracting spikes, False otherwise.

target_eid property

Python

target_eid: int

Target entity ID.

RETURNS	DESCRIPTION
int	The entity ID of the guardian's target.

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

---

Shulker

Python

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

Bases: Monster

Shulker entity.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for shulkers. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the shulker. Note: Height varies from 1.0 to 2.0 depending on peek state. TYPE: ClassVar[Tuple[float, float]]

facing_direction property

Python

facing_direction: int

Facing direction.

RETURNS	DESCRIPTION
int	The facing direction (Down=0, Up=1, North=2, South=3, West=4, East=5).

attachment_position property

Python

attachment_position: Optional[Tuple[int, int, int]]

Attachment position.

RETURNS	DESCRIPTION
Optional[Tuple[int, int, int]]	The attachment position coordinates, or None if absent.

shield_height property

Python

shield_height: int

Shield height.

RETURNS	DESCRIPTION
int	The height of the shulker's shield.

color property

Python

color: int

Dye color.

RETURNS	DESCRIPTION
int	The dye color ID (default purple = 10).

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

---

WitherBoss

Python

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

Bases: Monster

Wither Boss entity.

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

center_head_target property

Python

center_head_target: int

Center head's target entity ID.

RETURNS	DESCRIPTION
int	The entity ID of the center head's target.

left_head_target property

Python

left_head_target: int

Left head's target entity ID.

RETURNS	DESCRIPTION
int	The entity ID of the left head's target.

right_head_target property

Python

right_head_target: int

Right head's target entity ID.

RETURNS	DESCRIPTION
int	The entity ID of the right head's target.

invulnerable_time property

Python

invulnerable_time: int

Invulnerable time.

RETURNS	DESCRIPTION
int	The remaining invulnerable time in ticks.

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

---

Vex

Python

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

Bases: Monster

Vex entity.

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

is_in_attack_mode property

Python

is_in_attack_mode: bool

Whether vex is in attack mode (bit 0).

RETURNS	DESCRIPTION
bool	True if the vex is in attack mode, 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

---

AbstractSkeleton

Python

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

Bases: Monster

AbstractSkeleton entity base class.

This is the base class for all skeleton-type entities.

is_swinging_arms property

Python

is_swinging_arms: bool

Whether skeleton is swinging arms.

RETURNS	DESCRIPTION
bool	True if the skeleton is swinging arms, 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

---

Skeleton

Python

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

Bases: AbstractSkeleton

Skeleton entity extending AbstractSkeleton.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for skeletons. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the skeleton. 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_swinging_arms property

Python

is_swinging_arms: bool

Whether skeleton is swinging arms.

RETURNS	DESCRIPTION
bool	True if the skeleton is swinging arms, 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

---

WitherSkeleton

Python

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

Bases: AbstractSkeleton

Wither Skeleton entity extending AbstractSkeleton.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for wither skeletons. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the wither skeleton. 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_swinging_arms property

Python

is_swinging_arms: bool

Whether skeleton is swinging arms.

RETURNS	DESCRIPTION
bool	True if the skeleton is swinging arms, 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

---

Stray

Python

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

Bases: AbstractSkeleton

Stray entity extending AbstractSkeleton.

ATTRIBUTE	DESCRIPTION
ENTITY_TYPE	The Minecraft entity type identifier for strays. TYPE: ClassVar[str]
BOUNDING	The bounding box dimensions (width/depth, height) of the stray. 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_swinging_arms property

Python

is_swinging_arms: bool

Whether skeleton is swinging arms.

RETURNS	DESCRIPTION
bool	True if the skeleton is swinging arms, 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