BaseItem class
BaseItem is the base class for all 3D scene content.
Every BaseItem provides methods and properties that allow you to
- Edit Color
- Edit BaseItem.thought and BaseItem.speech
- Edit Transform for positioning and rotation
- Edit BaseItem.physics properties
Known subtypes
Methods
| add | (self, obj: BaseItem) -> None |
Adds a child to this item. |
|
| copy | (self) -> BaseItem |
Creates a copy of this item. |
|
| delete | (self) -> None |
Irreversibly removes this item from the scene. |
|
| delete_children | (self) -> None |
Deletes all children of this item. |
|
| get_property | (self, key: str) -> str |
Gets a custom property from this object. Returns |
|
| get_slot | (self, name: str) -> Slot |
Returns Slot by name. |
|
| on_collision_enter | (self, handler: Callable[[t: BaseItem], None]) -> None |
Handles the start of a collision between this item and another item. |
|
| on_collision_exit | (self, handler: Callable[[t: BaseItem], None]) -> None |
Handles the end of a collision between this item and another item. |
|
| on_property_changed | (self, id: str, handler: Callable[[t: str], None]) -> None |
Handles property value changes in this object. |
|
| remove_from_parent | (self) -> None |
Removes this item from its parent-item, disconnecting all inherited Transform settings. |
|
| set_property | (self, key: str, value: object) -> None |
Sets a custom property to this object. |
Properties
| active | bool |
Defines this item's |
|
| readonly | animated | bool |
Returns |
| readonly | center | Vector3 |
Returns the center point of this item. |
| readonly | children | ItemCollection |
Returns all first-level hierarchy children of this item. |
| color | Color |
Defines color of this item. |
|
| readonly | id | str |
The unique |
| input | object | ||
| name | str |
Name of this item displayed in their name tag and in the item hierarchy. |
|
| name_visible | bool |
Toggles visibility of the item name tag. |
|
| opacity | float |
Normalized opacity of this item. |
|
| readonly | parent | BaseItem |
Returns the parent of this item. |
| physics | object | ||
| readonly | relative_transform | Transform |
The relative Transform of this item in local space. |
| speech | Union[str, float] |
Defines the text in the speech-bubble of this item. |
|
| thought | Union[str, float] |
Defines the text in the thought-bubble of this item. |
|
| readonly | transform | Transform |
The Transform of this item in world space. |
| transition | object | ||
| visible | bool |
This API is deprecated |