unreal.MovieSceneScriptingByteChannel
¶
- class unreal.MovieSceneScriptingByteChannel(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
MovieSceneScriptingChannel
Movie Scene Scripting Byte Channel
C++ Source:
Plugin: SequencerScripting
Module: SequencerScripting
File: MovieSceneScriptingByte.h
Editor Properties: (see get_editor_property/set_editor_property)
channel_name
(Name): [Read-Write] Channel Name
- add_key(time, new_value, sub_frame=0.000000, time_unit=SequenceTimeUnit.DISPLAY_RATE, interpolation=MovieSceneKeyInterpolation.AUTO) MovieSceneScriptingByteKey ¶
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 (uint8) – 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.
interpolation (MovieSceneKeyInterpolation) – Interpolation method the key should use.
- Returns:
The key that was created with the specified values at the specified time.
- Return type:
- get_default() uint8 ¶
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:
uint8
- get_keys() Array[MovieSceneScriptingKey] ¶
Gets all of the keys in this channel.
- Returns:
An array of UMovieSceneScriptingByteKey’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:
- 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) –