Skip to content

Hanging

Hanging

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

Bases: Entity

Base class for hanging entities.

orientation property

Python
orientation: str

Gets the orientation/direction the hanging entity is facing.

RETURNS DESCRIPTION
str

The direction as a string ('south', 'west', 'north', or 'east').

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

ItemFrame

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

Bases: Hanging

Item frame hanging entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for item frames.

TYPE: ClassVar[str]

BOUNDING

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

TYPE: ClassVar[Tuple[float, float]]

item property

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

The item currently displayed in the frame.

RETURNS DESCRIPTION
Optional[Dict[str, Any]]

Slot data for the displayed item, None if frame is empty.

rotation_value property

Python
rotation_value: int

Rotation of the item in the frame.

RETURNS DESCRIPTION
int

Rotation value (0-7, representing 45-degree increments).

has_item property

Python
has_item: bool

Whether the item frame contains an item.

RETURNS DESCRIPTION
bool

True if frame has an item, False if empty.

rotation_degrees property

Python
rotation_degrees: float

Rotation of the item in degrees.

RETURNS DESCRIPTION
float

Rotation in degrees (0-315 in 45-degree increments).

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

orientation property

Python
orientation: str

Gets the orientation/direction the hanging entity is facing.

RETURNS DESCRIPTION
str

The direction as a string ('south', 'west', 'north', or 'east').

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

Painting

Python
Painting(*args, **kwargs)

Bases: Hanging

Painting hanging entity.

ATTRIBUTE DESCRIPTION
ENTITY_TYPE

The Minecraft entity type identifier for paintings.

TYPE: ClassVar[str]

BOUNDING

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

TYPE: ClassVar[Tuple[float, float]]

PAINTING_TYPES

Dictionary mapping painting names to their dimensions.

TYPE: ClassVar[Dict[str, Dict[str, int]]]

painting_type property

Python
painting_type: Optional[str]

Get the painting type name.

RETURNS DESCRIPTION
Optional[str]

The name of the painting (e.g., 'Kebab', 'Match'), or None if not set.

air property

Python
air: int

Remaining air ticks.

RETURNS DESCRIPTION
int

Number of air ticks remaining before drowning

custom_name property

Python
custom_name: Optional[str]

Custom name text component or None.

RETURNS DESCRIPTION
Optional[str]

Custom display name for the entity, or None if not set

is_custom_name_visible property

Python
is_custom_name_visible: bool

Whether custom name is visible above entity.

RETURNS DESCRIPTION
bool

True if custom name should be displayed above the entity

is_silent property

Python
is_silent: bool

Whether entity makes sounds.

RETURNS DESCRIPTION
bool

True if entity is silent and won't produce sounds

no_gravity property

Python
no_gravity: bool

Whether entity is affected by gravity.

RETURNS DESCRIPTION
bool

True if entity ignores gravity effects

max_health property

Python
max_health: float

Maximum health attribute value.

RETURNS DESCRIPTION
float

Maximum health points for this entity

movement_speed property

Python
movement_speed: float

Movement speed attribute value.

RETURNS DESCRIPTION
float

Movement speed multiplier for this entity

armor property

Python
armor: float

Armor attribute value.

RETURNS DESCRIPTION
float

Armor points providing damage reduction

attack_speed property

Python
attack_speed: float

Attack speed attribute value.

RETURNS DESCRIPTION
float

Attack speed multiplier for this entity

on_fire property

Python
on_fire: bool

Whether entity is on fire (bit 0).

RETURNS DESCRIPTION
bool

True if entity is currently on fire

crouched property

Python
crouched: bool

Whether entity is crouching (bit 1).

RETURNS DESCRIPTION
bool

True if entity is in crouching state

sprinting property

Python
sprinting: bool

Whether entity is sprinting (bit 3).

RETURNS DESCRIPTION
bool

True if entity is currently sprinting

invisible property

Python
invisible: bool

Whether entity is invisible (bit 5).

RETURNS DESCRIPTION
bool

True if entity has invisibility effect active

glowing property

Python
glowing: bool

Whether entity is glowing (bit 6).

RETURNS DESCRIPTION
bool

True if entity has glowing outline effect

flying_with_elytra property

Python
flying_with_elytra: bool

Whether entity is flying with elytra (bit 7).

RETURNS DESCRIPTION
bool

True if entity is gliding with elytra wings

orientation property

Python
orientation: str

Gets the orientation/direction the hanging entity is facing.

RETURNS DESCRIPTION
str

The direction as a string ('south', 'west', 'north', or 'east').

set_painting_type

Python
set_painting_type(painting_name: str) -> None

Set the painting type by name.

PARAMETER DESCRIPTION
painting_name

Name of the painting type to set.

TYPE: str

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