`unreal.MovieSceneScriptingEventChannel`¶

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

Movie Scene Scripting Event Channel

C++ Source:

Editor Properties: (see get_editor_property/set_editor_property)

add_key(time, new_value, sub_frame=0.000000, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → MovieSceneScriptingEventKey¶

Add a key to this channel. This initializes a new key and returns a reference to it.

Parameters:

time (FrameNumber) – The frame this key should go on. Respects TimeUnit to determine if it is a display rate frame or a tick resolution frame.
new_value (MovieSceneEvent) – The value that this key should be created with.
sub_frame (float) – Optional [0-1) clamped sub-frame to put this key on. Ignored if TimeUnit is set to Tick Resolution.
time_unit (MovieSceneTimeUnit) – Is the specified InTime in Display Rate frames or Tick Resolution.

Returns:

The key that was created with the specified values at the specified time.

Return type:

MovieSceneScriptingEventKey

Gets all of the keys in this channel.

Returns:: An array of UMovieSceneScriptingEventKey’s contained by this channel. Returns all keys even if clipped by the owning section’s boundaries or outside of the current sequence play range.
Return type:: Array[MovieSceneScriptingKey]

get_keys_by_index(indices) → Array[MovieSceneScriptingKey]¶

Gets the keys in this channel specified by the specific index Indices: The indices from which to get the keys from

Parameters:: indices (Array[int32]) –
Returns:: An array of UMovieSceneScriptingKey’s contained by this channel. Returns all keys specified by the indices, even if out of range.
Return type:: Array[MovieSceneScriptingKey]

remove_key(key) → None¶

Removes the specified key. Does nothing if the key is not specified or the key belongs to another channel.

unreal.MovieSceneScriptingEventChannel¶