unreal.TypedElementWorldInterface
¶
- class unreal.TypedElementWorldInterface(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Interface
Typed Element World Interface
C++ Source:
Module: Engine
File: TypedElementWorldInterface.h
- can_delete_element(element_handle) bool ¶
Can the given element be deleted?
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- can_duplicate_element(element_handle) bool ¶
Can the given element be duplicated?
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- can_edit_element(element_handle) bool ¶
Can this element actually be edited in the world?
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- can_move_element(element_handle, world_type) bool ¶
Can the given element be moved within the world?
- Parameters:
element_handle (ScriptTypedElementHandle) –
world_type (TypedElementWorldType) –
- Return type:
- can_promote_element(element_handle) bool ¶
Can the element be promoted Generally available when the element is a lighter representation of another element. Like an instance for example.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- can_scale_element(element_handle) bool ¶
Can the given element be scaled?
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- delete_element(element_handle, world, selection_set, deletion_options) bool ¶
Delete the given element. note: Default version calls DeleteElements with a single element.
- Parameters:
element_handle (ScriptTypedElementHandle) –
world (World) –
selection_set (TypedElementSelectionSet) –
deletion_options (TypedElementDeletionOptions) –
- Return type:
- duplicate_element(element_handle, world, location_offset) ScriptTypedElementHandle ¶
Duplicate the given element. note: Default version calls DuplicateElements with a single element.
- Parameters:
element_handle (ScriptTypedElementHandle) –
world (World) –
location_offset (Vector) –
- Return type:
- get_bounds(element_handle) BoxSphereBounds or None ¶
Get the bounds of this element, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Returns:
out_bounds (BoxSphereBounds):
- Return type:
BoxSphereBounds or None
- get_owner_level(element_handle) Level ¶
Get the owner level associated with this element, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- get_owner_world(element_handle) World ¶
Get the owner world associated with this element, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- get_pivot_offset(element_handle) Vector or None ¶
Get the local space offset of this element that should be added to its pivot location, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Returns:
out_pivot_offset (Vector):
- Return type:
Vector or None
- get_relative_transform(element_handle) Transform or None ¶
Get the transform of this element relative to its parent, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Returns:
out_transform (Transform):
- Return type:
Transform or None
- get_world_transform(element_handle) Transform or None ¶
Get the transform of this element within its owner world, if any.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Returns:
out_transform (Transform):
- Return type:
Transform or None
- is_template_element(element_handle) bool ¶
Is this element considered a template within its world (eg, a CDO or archetype).
- Parameters:
element_handle (ScriptTypedElementHandle) –
- Return type:
- notify_movement_ended(element_handle) None ¶
Notify that this element is done being moved.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- notify_movement_ongoing(element_handle) None ¶
Notify that this element is currently being moved.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- notify_movement_started(element_handle) None ¶
Notify that this element is about to be moved.
- Parameters:
element_handle (ScriptTypedElementHandle) –
- promote_element(element_handle, override_world=None) ScriptTypedElementHandle ¶
Promote an element when possible Generally available when the element is a lighter representation of another element. Like an instance for example.
- Parameters:
element_handle (ScriptTypedElementHandle) –
override_world (World) – Override the world in which the promotion might create new elements. Leave it to null to use the world from the handle.
- Return type:
- set_pivot_offset(element_handle, pivot_offset) bool ¶
Attempt to set the local space offset of this element that should be added to its pivot location.
- Parameters:
element_handle (ScriptTypedElementHandle) –
pivot_offset (Vector) –
- Return type:
- set_relative_transform(element_handle, transform) bool ¶
Attempt to set the transform of this element relative to its parent.
- Parameters:
element_handle (ScriptTypedElementHandle) –
transform (Transform) –
- Return type:
- set_world_transform(element_handle, transform) bool ¶
Attempt to set the transform of this element within its owner world.
- Parameters:
element_handle (ScriptTypedElementHandle) –
transform (Transform) –
- Return type: