unreal.MovieSceneScriptingStringChannel

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

Bases: MovieSceneScriptingChannel

Movie Scene Scripting String Channel

C++ Source:

  • Plugin: SequencerScripting

  • Module: SequencerScripting

  • File: MovieSceneScriptingString.h

Editor Properties: (see get_editor_property/set_editor_property)

  • channel_name (Name): [Read-Write]

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

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 (str) – 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:

MovieSceneScriptingStringKey

get_default() → str

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

Return type:

str

get_keys() → Array[MovieSceneScriptingKey]

Gets all of the keys in this channel.

Returns:

An array of UMovieSceneScriptingStringKey’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]

has_default() → bool
Returns:

Does this channel have a default value set?

Return type:

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.

Parameters:

key (MovieSceneScriptingKey)

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.

Parameters:

default_value (str)

transform(offset_frame, scale, pivot_frame, scripting_range, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Transform the OffsetFrame in time in the channel by an offset, scale and pivot

Parameters:

  • offset_frame (FrameNumber)

  • scale (double) – The amount to scale the keys by

  • pivot_frame (FrameNumber) – The frame to pivot around when scaling the keys

  • scripting_range (SequencerScriptingRange) – The time range of the keys to transform

  • time_unit (MovieSceneTimeUnit) – Is the specified OffsetFrame, PivotFrame, and ScriptingRange in Display Rate frames or Tick Resolution.