unreal.MovieSceneFolder
¶
-
class
unreal.
MovieSceneFolder
(outer=None, name='None')¶ Bases:
unreal.Object
Represents a folder used for organizing objects in tracks in a movie scene.
C++ Source:
Module: MovieScene
File: MovieSceneFolder.h
Editor Properties: (see get_editor_property/set_editor_property)
folder_color
(Color): [Read-Write] This folder’s color
-
add_child_folder
(folder_to_add) → bool¶ Add a child folder to the target folder
- Parameters
folder_to_add (MovieSceneFolder) – The child folder to be added
- Returns
True if the addition is successful
- Return type
-
add_child_master_track
(master_track) → bool¶ Add a master track to this folder
- Parameters
master_track (MovieSceneTrack) – The master track to add to the folder
- Returns
True if the addition is successful
- Return type
-
add_child_object_binding
(object_binding) → bool¶ Add a guid for an object binding to this folder
- Parameters
object_binding (SequencerBindingProxy) – The binding to add to the folder
- Returns
True if the addition is successful
- Return type
-
get_child_folders
()¶ Get the child folders of a given folder
- Returns
The child folders associated with the given folder
- Return type
-
get_child_master_tracks
()¶ Get the master tracks contained by this folder
- Returns
The master tracks under the given folder
- Return type
-
get_child_object_bindings
()¶ Get the object bindings contained by this folder
- Returns
The object bindings under the given folder
- Return type
-
get_folder_color
() → Color¶ Get the display color of the given folder
- Returns
The display color of the given folder
- Return type
-
get_folder_name
() → Name¶ Get the given folder’s display name
- Returns
The target folder’s name
- Return type
-
remove_child_folder
(folder_to_remove) → bool¶ Remove a child folder from the given folder
- Parameters
folder_to_remove (MovieSceneFolder) – The child folder to be removed
- Returns
True if the removal succeeds
- Return type
-
remove_child_master_track
(master_track) → bool¶ Remove a master track from the given folder
- Parameters
master_track (MovieSceneTrack) – The track to remove
- Returns
True if the removal succeeds
- Return type
-
remove_child_object_binding
(object_binding) → bool¶ Remove an object binding from the given folder
- Parameters
object_binding (SequencerBindingProxy) – The object binding to remove
- Returns
True if the operation succeeds
- Return type