Skip to content

Projectiles

Projectile

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

Bases: Entity

Base projectile entity class.

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


Arrow

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

Bases: Projectile

Arrow projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for arrows.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the arrow.

TYPE: ClassVar[Tuple[float, float]]

shooter_entity_id property

Python
shooter_entity_id: int

Returns the entity ID of the shooter who fired the arrow.

RETURNS DESCRIPTION
int

The actual entity ID of the shooter.

is_critical property

Python
is_critical: bool

Whether the arrow is critical (deals extra damage).

RETURNS DESCRIPTION
bool

True if arrow is critical, 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

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


TippedArrow

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

Bases: Arrow

Tipped arrow projectile entity with potion effects.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for tipped arrows.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the tipped arrow.

TYPE: ClassVar[Tuple[float, float]]

color property

Python
color: int

Particle color for tipped arrows.

RETURNS DESCRIPTION
int

Color value (-1 for no particles, regular arrows).

is_tipped property

Python
is_tipped: bool

Whether this is a tipped arrow with potion effects.

RETURNS DESCRIPTION
bool

True if arrow has potion effects, False for regular arrows.

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

shooter_entity_id property

Python
shooter_entity_id: int

Returns the entity ID of the shooter who fired the arrow.

RETURNS DESCRIPTION
int

The actual entity ID of the shooter.

is_critical property

Python
is_critical: bool

Whether the arrow is critical (deals extra damage).

RETURNS DESCRIPTION
bool

True if arrow is critical, False otherwise.

update_metadata

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

Update entity metadata from metadata packet.

PARAMETER DESCRIPTION
metadata

New metadata values indexed by metadata ID

TYPE: Dict[int, Any]

update_properties

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

Update entity attributes from properties packet.

PARAMETER DESCRIPTION
properties

Attribute properties containing base values and modifiers

TYPE: Dict[str, Dict[str, Any]]

get_attribute

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

Get final attribute value.

PARAMETER DESCRIPTION
key

Attribute key name

TYPE: str

default

Default value if attribute not found.

TYPE: float DEFAULT: 0.0

RETURNS DESCRIPTION
float

Final attribute value after applying modifiers

get_metadata_value

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

Get metadata value by index with default fallback.

PARAMETER DESCRIPTION
index

Metadata index to retrieve

TYPE: int

default

Default value if metadata not found.

TYPE: Any DEFAULT: None

RETURNS DESCRIPTION
Any

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


SpectralArrow

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

Bases: Projectile

Spectral arrow projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for spectral arrows.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the spectral arrow.

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


Snowball

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

Bases: Projectile

Snowball projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for snowballs.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the snowball.

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


Egg

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

Bases: Projectile

Thrown egg projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for eggs.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the egg.

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


Potion

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

Bases: Projectile

Thrown potion projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for potions.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the potion.

TYPE: ClassVar[Tuple[float, float]]

potion_item property

Python
potion_item: Optional[Dict[str, Any]]

The potion item being thrown.

RETURNS DESCRIPTION
Optional[Dict[str, Any]]

Slot data for the potion item, None if empty.

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


ExpBottle

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

Bases: Projectile

Thrown experience bottle projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for experience bottles.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the experience bottle.

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


Enderpearl

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

Bases: Projectile

Thrown ender pearl projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for ender pearls.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the ender pearl.

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


EyeOfEnderSignal

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

Bases: Projectile

Eye of Ender signal projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for eye of ender signals.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the eye of ender signal.

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


Fireball

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

Bases: Projectile

Large fireball projectile entity (ghast).

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for fireballs.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the fireball.

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


SmallFireball

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

Bases: Projectile

Small fireball projectile entity (blaze).

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for small fireballs.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the small fireball.

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


DragonFireball

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

Bases: Projectile

Dragon fireball projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for dragon fireballs.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the dragon fireball.

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


WitherSkull

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

Bases: Projectile

Wither skull projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for wither skulls.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the wither skull.

TYPE: ClassVar[Tuple[float, float]]

is_invulnerable property

Python
is_invulnerable: bool

Whether the wither skull is invulnerable to damage.

RETURNS DESCRIPTION
bool

True if the wither skull is invulnerable, 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

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


ShulkerBullet

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

Bases: Projectile

Shulker bullet projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for shulker bullets.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the shulker bullet.

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


LlamaSpit

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

Bases: Projectile

Llama spit projectile entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for llama spit.

TYPE: ClassVar[str]

BOUNDING

The bounding box dimensions (width/depth, height) of the llama spit.

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


FireworksRocket

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

Bases: Projectile

Fireworks rocket projectile 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]]

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