unreal.MovieSceneScriptingBoolChannel
¶
-
class
unreal.
MovieSceneScriptingBoolChannel
(outer=None, name='None')¶ Bases:
unreal.MovieSceneScriptingChannel
Movie Scene Scripting Bool Channel
C++ Source:
Plugin: SequencerScripting
Module: SequencerScripting
File: MovieSceneScriptingBool.h
-
add_key
(time, new_value, sub_frame=0.0, time_unit=SequenceTimeUnit.DISPLAY_RATE) → MovieSceneScriptingBoolKey¶ 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 (bool) – 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
-
compute_effective_range
() → SequencerScriptingRange¶ Compute the effective range of this channel, for example, the extents of its key times
- Returns
A range that represents the greatest range of times occupied by this channel, in the sequence’s frame resolution
- Return type
-
evaluate_keys
(range, frame_rate)¶ Gets baked keys in this channel.
- Parameters
range (SequencerScriptingRange) –
frame_rate (FrameRate) –
- Returns
An array of values contained by this channel. Returns baked keys in the specified range.
- Return type
-
get_default
() → bool¶ Get this channel’s default value that will be used when no keys are present. Only a valid value when HasDefault() returns true.
- Returns
- Return type
-
get_keys
()¶ Gets all of the keys in this channel.
- Returns
An array of UMovieSceneScriptingBoolKey’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
-
get_num_keys
() → int32¶ Returns number of keys in this channel.
- Returns
- Return type
int32
-
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) –