MediaItem class

extends BaseItem

Parent class for billboard-items that display media (videos, images) on a flat plane.

Note: This item uses pivot orientation that differs from BaseItem.

Known subtypes

Methods

add(self, obj: BaseItem) -> None

Inherited from BaseItem.

Adds a child to this item.

copy(self) -> BaseItem

Inherited from BaseItem.

Creates a copy of this item.

delete(self) -> None

Inherited from BaseItem.

Irreversibly removes this item from the scene.

delete_children(self) -> None

Inherited from BaseItem.

Deletes all children of this item.

get_property(self, key: str) -> str

Inherited from BaseItem.

Gets a custom property from this object. Returns null if the property can not be found.

get_slot(self, name: str) -> Slot

Inherited from BaseItem.

Returns Slot by name.

on_collision_enter(self, handler: Callable[[t: BaseItem], None]) -> None

Inherited from BaseItem.

Handles the start of a collision between this item and another item.

on_collision_exit(self, handler: Callable[[t: BaseItem], None]) -> None

Inherited from BaseItem.

Handles the end of a collision between this item and another item.

on_property_changed(self, id: str, handler: Callable[[t: str], None]) -> None

Inherited from BaseItem.

Handles property value changes in this object.

remove_from_parent(self) -> None

Inherited from BaseItem.

Removes this item from its parent-item, disconnecting all inherited Transform settings.

set_property(self, key: str, value: object) -> None

Inherited from BaseItem.

Sets a custom property to this object.

Properties

active bool

Inherited from BaseItem.

Defines this item's active state.

readonly animated bool

Inherited from BaseItem.

Returns true if this item has animation tracks.

readonly center Vector3

Inherited from BaseItem.

Returns the center point of this item.

readonly children ItemCollection

Inherited from BaseItem.

Returns all first-level hierarchy children of this item.

color Color

Inherited from BaseItem.

Defines color of this item.

readonly id str

Inherited from BaseItem.

The unique id of this item.

inputobject

Inherited from BaseItem.

name str

Inherited from BaseItem.

Name of this item displayed in their name tag and in the item hierarchy.

name_visible bool

Inherited from BaseItem.

Toggles visibility of the item name tag.

opacity float

Inherited from BaseItem.

Normalized opacity of this item.

readonly parent BaseItem

Inherited from BaseItem.

Returns the parent of this item.

physicsobject

Inherited from BaseItem.

readonly relative_transform Transform

Inherited from BaseItem.

The relative Transform of this item in local space.

speech Union[str, float]

Inherited from BaseItem.

Defines the text in the speech-bubble of this item.

thought Union[str, float]

Inherited from BaseItem.

Defines the text in the thought-bubble of this item.

readonly transform Transform

Inherited from BaseItem.

The Transform of this item in world space.

transitionobject

Inherited from BaseItem.

visible bool

Inherited from BaseItem.

Toggles this item's visibility. If false, items retains its opacity value, but is not displayed.