`unreal.MovieSceneScriptingIntegerChannel`¶

class unreal.MovieSceneScriptingIntegerChannel(outer=None, name='None')¶

Movie Scene Scripting Integer Channel

C++ Source:

Editor Properties: (see get_editor_property/set_editor_property)

add_key(time, new_value, sub_frame=0.0, time_unit=SequenceTimeUnit.DISPLAY_RATE) → MovieSceneScriptingIntegerKey ¶

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 (int32) – 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 (SequenceTimeUnit) – 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

MovieSceneScriptingIntegerKey

get_default() → int32¶

Get this channel’s default value that will be used when no keys are present. Only a valid value when HasDefault() returns true.

get_keys()¶

Gets all of the keys in this channel.

Returns: An array of UMovieSceneScriptingIntegerKey’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)

has_default() → bool ¶

remove_default() → None ¶: Remove this channel’s default value causing the channel to have no effect where no keys are present

remove_key(key) → None ¶

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

set_default(default_value) → None ¶

Set this channel’s default value that should be used when no keys are present. Sets bHasDefaultValue to true automatically.

unreal.MovieSceneScriptingIntegerChannel¶