unreal.SequencerBindingProxy

class unreal.SequencerBindingProxy(sequence=None)

Bases: unreal.StructBase

Sequencer Binding Proxy

C++ Source:

  • Plugin: SequencerScripting
  • Module: SequencerScripting
  • File: SequencerBindingProxy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • sequence (MovieSceneSequence): [Read-Write] Sequence
add_track(track_type) → MovieSceneTrack

Add a new track to the specified binding

Parameters: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
find_tracks_by_exact_type(track_type) -> Array(MovieSceneTrack)

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

Parameters: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)
find_tracks_by_type(track_type) -> Array(MovieSceneTrack)

Find all tracks within a given binding of the specified type

Parameters: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)
get_child_possessables() -> Array(SequencerBindingProxy)

Get all the children of this binding

Returns:An array containing all the binding’s children
Return type:Array(SequencerBindingProxy)
get_display_name() → Text

Get this binding’s name

Returns:The display name of the binding
Return type:Text
get_id() → Guid

Get this binding’s ID

Returns:The guid that uniquely represents this binding
Return type:Guid
get_name() → str

Get this binding’s object non-display name

Returns:The name of the binding
Return type:str
get_object_template() → Object

Get this binding’s object template

Returns:The object template of the binding
Return type:Object
get_parent() → SequencerBindingProxy

Get the parent of this binding

Returns:The binding’s parent
Return type:SequencerBindingProxy
get_possessed_object_class() -> type(Class)

Get this binding’s possessed object class

Returns:The possessed object class of the binding
Return type:type(Class)
get_tracks() -> Array(MovieSceneTrack)

Get all the tracks stored within this binding

Returns:An array containing all the binding’s tracks
Return type:Array(MovieSceneTrack)
is_valid() → bool

Check whether the specified binding is valid

Returns:
Return type:bool
remove() → None

Remove the specified binding

remove_track(track_to_remove) → None

Remove the specified track from this binding

Parameters:track_to_remove (MovieSceneTrack) – The track to remove
sequence

(MovieSceneSequence) – [Read-Only] Sequence

set_parent(parent_binding) → None

Set the parent to this binding

Parameters:parent_binding (SequencerBindingProxy) – The parent to set the InBinding to