unreal.MovieSceneFolderExtensions

class unreal.MovieSceneFolderExtensions(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Function library containing methods that should be hoisted onto UMovieSceneFolders for scripting

C++ Source:

  • Plugin: SequencerScripting

  • Module: SequencerScripting

  • File: MovieSceneFolderExtensions.h

classmethod add_child_folder(target_folder, folder_to_add) bool

Add a child folder to the target folder

Parameters:
Returns:

True if the addition is successful

Return type:

bool

classmethod add_child_master_track(folder, track) bool

Add Child Master Track deprecated: AddChildMasterTrack is deprecated. Please use AddChildTrack instead

Parameters:
Return type:

bool

classmethod add_child_object_binding(folder, object_binding) bool

Add a guid for an object binding to this folder

Parameters:
Returns:

True if the addition is successful

Return type:

bool

classmethod add_child_track(folder, track) bool

Add a track to this folder

Parameters:
Returns:

True if the addition is successful

Return type:

bool

classmethod get_child_folders(folder) Array[MovieSceneFolder]

Get the child folders of a given folder

Parameters:

folder (MovieSceneFolder) – The folder to get the child folders of

Returns:

The child folders associated with the given folder

Return type:

Array[MovieSceneFolder]

classmethod get_child_master_tracks(folder) Array[MovieSceneTrack]

Get Child Master Tracks deprecated: GetChildMasterTracks is deprecated. Please use GetChildTracks instead

Parameters:

folder (MovieSceneFolder) –

Return type:

Array[MovieSceneTrack]

classmethod get_child_object_bindings(folder) Array[MovieSceneBindingProxy]

Get the object bindings contained by this folder

Parameters:

folder (MovieSceneFolder) – The folder to get the bindings of

Returns:

The object bindings under the given folder

Return type:

Array[MovieSceneBindingProxy]

classmethod get_child_tracks(folder) Array[MovieSceneTrack]

Get the tracks contained by this folder

Parameters:

folder (MovieSceneFolder) – The folder to get the tracks of

Returns:

The tracks under the given folder

Return type:

Array[MovieSceneTrack]

classmethod get_folder_color(folder) Color

Get the display color of the given folder

Parameters:

folder (MovieSceneFolder) – The folder to get the display color of

Returns:

The display color of the given folder

Return type:

Color

classmethod get_folder_name(folder) Name

Get the given folder’s display name

Parameters:

folder (MovieSceneFolder) – The folder to use

Returns:

The target folder’s name

Return type:

Name

classmethod remove_child_folder(target_folder, folder_to_remove) bool

Remove a child folder from the given folder

Parameters:
Returns:

True if the removal succeeds

Return type:

bool

classmethod remove_child_master_track(folder, track) bool

Remove Child Master Track deprecated: RemoveChildMasterTrack is deprecated. Please use RemoveChildTrack instead

Parameters:
Return type:

bool

classmethod remove_child_object_binding(folder, object_binding) bool

Remove an object binding from the given folder

Parameters:
Returns:

True if the operation succeeds

Return type:

bool

classmethod remove_child_track(folder, track) bool

Remove a track from the given folder

Parameters:
Returns:

True if the removal succeeds

Return type:

bool

classmethod set_folder_color(folder, folder_color) bool

Set the display color of the given folder

Parameters:
  • folder (MovieSceneFolder) – The folder to set the display color of

  • folder_color (Color) – The new display color for the folder

Returns:

True if the folder’s display color is set successfully

Return type:

bool

classmethod set_folder_name(folder, folder_name) bool

Set the name of the given folder

Parameters:
  • folder (MovieSceneFolder) – The folder to set the name of

  • folder_name (Name) – The new name for the folder

Returns:

True if the setting of the folder name succeeds

Return type:

bool