Misc

DroppedItem ¶

Python

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

Bases: Entity

Item entity representing a dropped item in the world.

The entity does not include the item data when initially created. The item it holds must be received through a metadata update packet.

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

item `property` ¶

Python

item: Optional[Item]

Item instance representing the dropped item.

RETURNS	DESCRIPTION
`Optional[Item]`	Item instance or None if no item data available.

has_item `property` ¶

Python

has_item: bool

Whether the item entity contains an item stack.

RETURNS	DESCRIPTION
`bool`	True if item stack is present.

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

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

Item ¶

Python

Item(
    item_id: int,
    count: int = 1,
    item_damage: int = 0,
    nbt: Optional[Dict[str, Any]] = None,
)

Represents a Minecraft item.

has_nbt `property` ¶

Python

has_nbt: bool

Check if this item has NBT data.

RETURNS	DESCRIPTION
`bool`	True if NBT data is present

is_damaged `property` ¶

Python

is_damaged: bool

Check if this item has damage (for tools/armor).

RETURNS	DESCRIPTION
`bool`	True if damage > 0

is_enchanted `property` ¶

Python

is_enchanted: bool

Check if this item has enchantments.

RETURNS	DESCRIPTION
`bool`	True if item has enchantment NBT data

get_enchantments ¶

Python

get_enchantments() -> list[Dict[str, int]]

Get enchantments from NBT data.

RETURNS	DESCRIPTION
`list[Dict[str, int]]`	List of enchantment dictionaries with 'id' and 'lvl' keys

to_dict ¶

Python

to_dict() -> ItemData

Convert the item to ItemData format.

RETURNS	DESCRIPTION
`ItemData`	Dictionary containing item data

XPOrb ¶

Python

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

Bases: Entity

Experience orb entity.

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

count `property` ¶

Python

count: float

The amount of experience this orb will reward once collected.

RETURNS	DESCRIPTION
`float`	Experience amount.

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

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

LightningBolt ¶

Python

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

Bases: Entity

Lightning bolt entity.

This entity is not stored in the entity registry, as it is ephemeral.

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

type `property` ¶

Python

type: int

The global entity type, currently always 1 for thunderbolt.

RETURNS	DESCRIPTION
`int`	Global entity type.

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

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

AreaEffectCloud ¶

Python

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

Bases: Entity

Area effect cloud entity for potion effects and particles.

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

radius `property` ¶

Python

radius: float

Effect cloud radius.

RETURNS	DESCRIPTION
`float`	Cloud radius in blocks.5.

color `property` ¶

Python

color: int

Effect cloud color.

RETURNS	DESCRIPTION
`int`	Color value for mob spell particle.

ignore_radius `property` ¶

Python

ignore_radius: bool

Whether to ignore radius and show as single point.

RETURNS	DESCRIPTION
`bool`	True if you should show as single point.

particle_id `property` ¶

Python

particle_id: int

Particle type ID.

RETURNS	DESCRIPTION
`int`	Particle ID, default 15 (mobSpell).

particle_param1 `property` ¶

Python

particle_param1: int

First particle parameter.

RETURNS	DESCRIPTION
`int`	Particle parameter 1.

particle_param2 `property` ¶

Python

particle_param2: int

Second particle parameter.

RETURNS	DESCRIPTION
`int`	Particle parameter 2.

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

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

ArmorStand ¶

Python

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

Bases: Living

Armor stand entity extending Living.

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

is_small `property` ¶

Python

is_small: bool

Whether armor stand is small size (bit 0).

RETURNS	DESCRIPTION
`bool`	True if small size.

has_arms `property` ¶

Python

has_arms: bool

Whether armor stand has arms (bit 2).

RETURNS	DESCRIPTION
`bool`	True if it has arms.

has_base_plate `property` ¶

Python

has_base_plate: bool

Whether armor stand has baseplate (bit 3 inverted).

RETURNS	DESCRIPTION
`bool`	True if it has baseplate.

is_marker `property` ¶

Python

is_marker: bool

Whether armor stand is marker (bit 4).

RETURNS	DESCRIPTION
`bool`	True if is marker.

head_rotation `property` ¶

Python

head_rotation: tuple[float, float, float]

Head rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (0.0, 0.0, 0.0).

body_rotation `property` ¶

Python

body_rotation: tuple[float, float, float]

Body rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (0.0, 0.0, 0.0).

left_arm_rotation `property` ¶

Python

left_arm_rotation: tuple[float, float, float]

Left arm rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (-10.0, 0.0, -10.0).

right_arm_rotation `property` ¶

Python

right_arm_rotation: tuple[float, float, float]

Right arm rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (-15.0, 0.0, 10.0).

left_leg_rotation `property` ¶

Python

left_leg_rotation: tuple[float, float, float]

Left leg rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (-1.0, 0.0, -1.0).

right_leg_rotation `property` ¶

Python

right_leg_rotation: tuple[float, float, float]

Right leg rotation.

RETURNS	DESCRIPTION
`tuple[float, float, float]`	(x, y, z) rotation values, default (1.0, 0.0, 1.0).

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

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`

FallingBlock ¶

Python

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

Bases: Entity

Falling block entity (FallingSand).

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

block_id `property` ¶

Python

block_id: int

Extracts the block ID from the raw block type integer.

RETURNS	DESCRIPTION
`int`	The block ID.

block_metadata `property` ¶

Python

block_metadata: int

Extracts the block metadata from the raw block type integer.

RETURNS	DESCRIPTION
`int`	The block metadata.

spawn_position `property` ¶

Python

spawn_position: tuple[int, int, int]

Original spawn position.

RETURNS	DESCRIPTION
`tuple[int, int, int]`	(x, y, z) spawn coordinates, default (0, 0, 0).

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

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

FireworksRocket ¶

Python

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

Bases: Entity

Fireworks rocket entity.

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

firework_info `property` ¶

Python

firework_info: Optional[Dict[str, Any]]

Firework item stack info.

RETURNS	DESCRIPTION
`Optional[Dict[str, Any]]`	Firework item data or None if empty.

boosted_entity_id `property` ¶

Python

boosted_entity_id: int

Entity ID that used firework for elytra boosting.

RETURNS	DESCRIPTION
`int`	Entity ID of boosted entity.

is_elytra_boost `property` ¶

Python

is_elytra_boost: bool

Whether this firework is being used for elytra boosting.

RETURNS	DESCRIPTION
`bool`	True if used for elytra boosting.

air `property` ¶

Python

air: int

Remaining air ticks.

RETURNS	DESCRIPTION
`int`	Number of air ticks remaining before drowning

custom_name `property` ¶

Python

custom_name: Optional[str]

Custom name text component or None.

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

is_custom_name_visible `property` ¶

Python

is_custom_name_visible: bool

Whether custom name is visible above entity.

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

is_silent `property` ¶

Python

is_silent: bool

Whether entity makes sounds.

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

no_gravity `property` ¶

Python

no_gravity: bool

Whether entity is affected by gravity.

RETURNS	DESCRIPTION
`bool`	True if entity ignores gravity effects

max_health `property` ¶

Python

max_health: float

Maximum health attribute value.

RETURNS	DESCRIPTION
`float`	Maximum health points for this entity

movement_speed `property` ¶

Python

movement_speed: float

Movement speed attribute value.

RETURNS	DESCRIPTION
`float`	Movement speed multiplier for this entity

armor `property` ¶

Python

armor: float

Armor attribute value.

RETURNS	DESCRIPTION
`float`	Armor points providing damage reduction

attack_speed `property` ¶

Python

attack_speed: float

Attack speed attribute value.

RETURNS	DESCRIPTION
`float`	Attack speed multiplier for this entity

on_fire `property` ¶

Python

on_fire: bool

Whether entity is on fire (bit 0).

RETURNS	DESCRIPTION
`bool`	True if entity is currently on fire

crouched `property` ¶

Python

crouched: bool

Whether entity is crouching (bit 1).

RETURNS	DESCRIPTION
`bool`	True if entity is in crouching state

sprinting `property` ¶

Python

sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS	DESCRIPTION
`bool`	True if entity is currently sprinting

invisible `property` ¶

Python

invisible: bool

Whether entity is invisible (bit 5).

RETURNS	DESCRIPTION
`bool`	True if entity has invisibility effect active

glowing `property` ¶

Python

glowing: bool

Whether entity is glowing (bit 6).

RETURNS	DESCRIPTION
`bool`	True if entity has glowing outline effect

flying_with_elytra `property` ¶

Python

flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS	DESCRIPTION
`bool`	True if entity is gliding with elytra wings

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

TNTPrimed ¶

Python

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

Bases: Entity

Primed TNT entity.

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

fuse_time `property` ¶

Python

fuse_time: int

Remaining fuse time in ticks.

RETURNS	DESCRIPTION
`int`	Fuse time remaining.

will_explode_soon `property` ¶

Python

will_explode_soon: bool

Whether TNT will explode within 1 second.

RETURNS	DESCRIPTION
`bool`	True if fuse time <= 20 ticks (1 second).

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

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

LeashKnot ¶

Python

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

Bases: Entity

Leash-knot entity attached to fences.

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

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

EvocationFangs ¶

Python

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

Bases: Entity

Evocation fangs entity created by Evoker spells.

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

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

FishingHook ¶

Python

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

Bases: Entity

Fishing hook/bobber entity.

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

owner_id `property` ¶

Python

owner_id: int

Returns the entity ID of the owner who cast the fishing hook.

RETURNS	DESCRIPTION
`int`	The entity ID of the owner.

hooked_entity_id `property` ¶

Python

hooked_entity_id: int

ID of hooked entity.

RETURNS	DESCRIPTION
`int`	Hooked entity ID + 1, or 0 if no entity hooked.

has_hooked_entity `property` ¶

Python

has_hooked_entity: bool

Whether the fishing hook has caught an entity.

RETURNS	DESCRIPTION
`bool`	True if an entity is hooked.

actual_hooked_entity_id `property` ¶

Python

actual_hooked_entity_id: Optional[int]

Actual entity ID of hooked entity (subtracts 1 from stored value).

RETURNS	DESCRIPTION
`Optional[int]`	Real entity ID or None if no entity hooked.

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

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

EnderCrystal ¶

Python

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

Bases: Entity

End crystal entity.

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

beam_target `property` ¶

Python

beam_target: Optional[tuple[int, int, int]]

Beam target position.

RETURNS	DESCRIPTION
`Optional[tuple[int, int, int]]`	(x, y, z) target coordinates or None if no target.

show_bottom `property` ¶

Python

show_bottom: bool

Whether to show crystal bottom.

RETURNS	DESCRIPTION
`bool`	True if bottom should be shown.

has_beam_target `property` ¶

Python

has_beam_target: bool

Whether the crystal has a beam target.

RETURNS	DESCRIPTION
`bool`	True if beam target is set.

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

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

Misc

DroppedItem ¶

item property ¶

has_item property ¶

air property ¶

custom_name property ¶

is_custom_name_visible property ¶

is_silent property ¶

no_gravity property ¶

max_health property ¶

movement_speed property ¶

armor property ¶

attack_speed property ¶

on_fire property ¶

crouched property ¶

sprinting property ¶

invisible property ¶

glowing property ¶

flying_with_elytra property ¶

update_metadata ¶

update_properties ¶

get_attribute ¶

get_metadata_value ¶

Item ¶

has_nbt property ¶

is_damaged property ¶

is_enchanted property ¶

get_enchantments ¶

to_dict ¶

XPOrb ¶

count property ¶

air property ¶

custom_name property ¶

is_custom_name_visible property ¶

is_silent property ¶

no_gravity property ¶

max_health property ¶

movement_speed property ¶

armor property ¶

attack_speed property ¶

on_fire property ¶

crouched property ¶

sprinting property ¶

invisible property ¶

glowing property ¶

flying_with_elytra property ¶

update_metadata ¶

update_properties ¶

get_attribute ¶

get_metadata_value ¶

LightningBolt ¶

type property ¶

air property ¶

custom_name property ¶

is_custom_name_visible property ¶

is_silent property ¶

no_gravity property ¶

max_health property ¶

movement_speed property ¶

armor property ¶

attack_speed property ¶

on_fire property ¶

crouched property ¶

sprinting property ¶

invisible property ¶

glowing property ¶

flying_with_elytra property ¶

update_metadata ¶

update_properties ¶

get_attribute ¶

get_metadata_value ¶

AreaEffectCloud ¶

radius property ¶

color property ¶

ignore_radius property ¶

particle_id property ¶

particle_param1 property ¶

particle_param2 property ¶

air property ¶

custom_name property ¶

item `property` ¶

has_item `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

has_nbt `property` ¶

is_damaged `property` ¶

is_enchanted `property` ¶

count `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

type `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

radius `property` ¶

color `property` ¶

ignore_radius `property` ¶

particle_id `property` ¶

particle_param1 `property` ¶

particle_param2 `property` ¶

air `property` ¶

custom_name `property` ¶

is_custom_name_visible `property` ¶

is_silent `property` ¶

no_gravity `property` ¶

max_health `property` ¶

movement_speed `property` ¶

armor `property` ¶

attack_speed `property` ¶

on_fire `property` ¶

crouched `property` ¶

sprinting `property` ¶

invisible `property` ¶

glowing `property` ¶

flying_with_elytra `property` ¶

is_small `property` ¶

has_arms `property` ¶

has_base_plate `property` ¶

is_marker `property` ¶

head_rotation `property` ¶

body_rotation `property` ¶

left_arm_rotation `property` ¶