Vehicles

Boat ¶

Python

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

Bases: Entity

Boat entity for water transportation.

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

time_since_last_hit `property` ¶

Python

time_since_last_hit: int

Time since last hit in ticks.

RETURNS	DESCRIPTION
`int`	Time since last hit.

forward_direction `property` ¶

Python

forward_direction: int

Forward direction of the boat.

RETURNS	DESCRIPTION
`int`	Forward direction, default 1.

damage_taken `property` ¶

Python

damage_taken: float

Damage taken by the boat.

RETURNS	DESCRIPTION
`float`	Damage taken.

boat_type `property` ¶

Python

boat_type: int

Type of boat wood.

RETURNS	DESCRIPTION
`int`	Boat type (0=oak, 1=spruce, 2=birch, 3=jungle, 4=acacia, 5=dark oak)

right_paddle_turning `property` ¶

Python

right_paddle_turning: bool

Whether right paddle is turning.

RETURNS	DESCRIPTION
`bool`	Right paddle state.

left_paddle_turning `property` ¶

Python

left_paddle_turning: bool

Whether left paddle is turning.

RETURNS	DESCRIPTION
`bool`	Left paddle state.

wood_type_name `property` ¶

Python

wood_type_name: str

Human-readable name of the boat wood type.

RETURNS	DESCRIPTION
`str`	Wood type name corresponding to boat_type value.

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

Minecart ¶

Python

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

Bases: Entity

Base minecart entity for rail transportation.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 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

MinecartRideable ¶

Python

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

Bases: Minecart

Rideable minecart that can carry passengers.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartContainer ¶

Python

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

Bases: Minecart

Base class for minecarts that can store items.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartChest ¶

Python

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

Bases: MinecartContainer

Chest minecart for item storage and transportation.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartHopper ¶

Python

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

Bases: MinecartContainer

Hopper minecart for item collection and transportation.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartFurnace ¶

Python

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

Bases: Minecart

Furnace minecart for self-propelled transportation.

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

is_powered `property` ¶

Python

is_powered: bool

Whether furnace minecart is currently powered.

RETURNS	DESCRIPTION
`bool`	True if the furnace minecart is powered, 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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartTNT ¶

Python

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

Bases: Minecart

TNT minecart for explosive transportation.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartSpawner ¶

Python

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

Bases: Minecart

Spawner minecart for mobile mob spawning.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

MinecartCommandBlock ¶

Python

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

Bases: Minecart

Command block minecart for mobile command execution.

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

command `property` ¶

Python

command: str

Command string to execute.

RETURNS	DESCRIPTION
`str`	Command.

last_output `property` ¶

Python

last_output: str

Last command output as chat component.

RETURNS	DESCRIPTION
`str`	Last output, default '{"text":""}'.

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

shaking_power `property` ¶

Python

shaking_power: int

Power of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking power.

shaking_direction `property` ¶

Python

shaking_direction: int

Direction of minecart shaking.

RETURNS	DESCRIPTION
`int`	Shaking direction, default 1.

shaking_multiplier `property` ¶

Python

shaking_multiplier: float

Multiplier for minecart shaking effect.

RETURNS	DESCRIPTION
`float`	Shaking multiplier.

custom_block_id `property` ¶

Python

custom_block_id: int

Custom block ID and damage value.

RETURNS	DESCRIPTION
`int`	Custom block ID.

custom_block_y_position `property` ¶

Python

custom_block_y_position: int

Custom block Y position in 16ths of a block.

RETURNS	DESCRIPTION
`int`	Custom block Y position, default 6.

show_custom_block `property` ¶

Python

show_custom_block: bool

Whether to show custom block instead of default.

RETURNS	DESCRIPTION
`bool`	Show custom block flag.

is_shaking `property` ¶

Python

is_shaking: bool

Whether minecart is currently shaking.

RETURNS	DESCRIPTION
`bool`	True if shaking_power > 0.

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

Vehicles

Boat ¶

time_since_last_hit property ¶

forward_direction property ¶

damage_taken property ¶

boat_type property ¶

right_paddle_turning property ¶

left_paddle_turning property ¶

wood_type_name 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 ¶

Minecart ¶

shaking_power property ¶

shaking_direction property ¶

shaking_multiplier property ¶

custom_block_id property ¶

custom_block_y_position property ¶

show_custom_block property ¶

is_shaking 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 ¶

MinecartRideable ¶

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 ¶

shaking_power property ¶

shaking_direction property ¶

shaking_multiplier property ¶

custom_block_id property ¶

custom_block_y_position property ¶

show_custom_block property ¶

is_shaking property ¶

update_metadata ¶

update_properties ¶

time_since_last_hit `property` ¶

forward_direction `property` ¶

damage_taken `property` ¶

boat_type `property` ¶

right_paddle_turning `property` ¶

left_paddle_turning `property` ¶

wood_type_name `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` ¶

shaking_power `property` ¶

shaking_direction `property` ¶

shaking_multiplier `property` ¶

custom_block_id `property` ¶

custom_block_y_position `property` ¶

show_custom_block `property` ¶

is_shaking `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` ¶

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` ¶

shaking_power `property` ¶

shaking_direction `property` ¶

shaking_multiplier `property` ¶

custom_block_id `property` ¶

custom_block_y_position `property` ¶

show_custom_block `property` ¶

is_shaking `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` ¶