unreal.MovieSceneBindingExtensions

class unreal.MovieSceneBindingExtensions(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

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

C++ Source:

  • Plugin: SequencerScripting

  • Module: SequencerScripting

  • File: MovieSceneBindingExtensions.h

classmethod add_track(binding, track_type) → MovieSceneTrack

Add a new track to the specified binding

Parameters

  • binding (SequencerBindingProxy) – The binding to add tracks to

  • track_type (type(Class)) – A UMovieSceneTrack class type specifying the type of track to create

Returns

The newly created track, if successful

Return type

MovieSceneTrack

classmethod find_tracks_by_exact_type(binding, track_type)

Find all tracks within a given binding of the specified type, not allowing sub-classed types

Parameters

  • binding (SequencerBindingProxy) – The binding to find tracks in

  • track_type (type(Class)) – A UMovieSceneTrack class type specifying the exact types of track to return

Returns

An array containing any tracks that are exactly the same as the type specified

Return type

Array(MovieSceneTrack)

classmethod find_tracks_by_type(binding, track_type)

Find all tracks within a given binding of the specified type

Parameters

  • binding (SequencerBindingProxy) – The binding to find tracks in

  • track_type (type(Class)) – A UMovieSceneTrack class type specifying which types of track to return

Returns

An array containing any tracks that match the type specified

Return type

Array(MovieSceneTrack)

classmethod get_child_possessables(binding)

Get all the children of this binding

Parameters

binding (SequencerBindingProxy) – The binding to to get children of

Returns

An array containing all the binding’s children

Return type

Array(SequencerBindingProxy)

classmethod get_display_name(binding) → Text

Get this binding’s name

Parameters

binding (SequencerBindingProxy) – The binding to get the name of

Returns

The display name of the binding

Return type

Text

classmethod get_id(binding) → Guid

Get this binding’s ID

Parameters

binding (SequencerBindingProxy) – The binding to get the ID of

Returns

The guid that uniquely represents this binding

Return type

Guid

classmethod get_name(binding) → str

Get this binding’s object non-display name

Parameters

binding (SequencerBindingProxy) – The binding to get the name of

Returns

The name of the binding

Return type

str

classmethod get_object_template(binding) → Object

Get this binding’s object template

Parameters

binding (SequencerBindingProxy) – The binding to get the object template of

Returns

The object template of the binding

Return type

Object

classmethod get_parent(binding) → SequencerBindingProxy

Get the parent of this binding

Parameters

binding (SequencerBindingProxy) – The binding to get the parent of

Returns

The binding’s parent

Return type

SequencerBindingProxy

classmethod get_possessed_object_class(binding)

Get this binding’s possessed object class

Parameters

binding (SequencerBindingProxy) – The binding to get the possessed object class of

Returns

The possessed object class of the binding

Return type

type(Class)

classmethod get_tracks(binding)

Get all the tracks stored within this binding

Parameters

binding (SequencerBindingProxy) – The binding to find tracks in

Returns

An array containing all the binding’s tracks

Return type

Array(MovieSceneTrack)

classmethod is_valid(binding) → bool

Check whether the specified binding is valid

Parameters

binding (SequencerBindingProxy) –

Returns

Return type

bool

classmethod move_binding_contents(source_binding_id, destination_binding_id) → None

Move all the contents (tracks, child bindings) of the specified binding ID onto another

Parameters

  • source_binding_id (SequencerBindingProxy) – The identifier of the binding ID to move all tracks and children from

  • destination_binding_id (SequencerBindingProxy) – The identifier of the binding ID to move the contents to

classmethod remove(binding) → None

Remove the specified binding

Parameters

binding (SequencerBindingProxy) – The binding to remove the track from

classmethod remove_track(binding, track_to_remove) → None

Remove the specified track from this binding

Parameters
classmethod set_display_name(binding, display_name) → None

Set this binding’s name

Parameters
classmethod set_name(binding, name) → None

Set this binding’s object non-display name

Parameters
classmethod set_parent(binding, parent_binding) → None

Set the parent to this binding

Parameters