animation_toolset.toolsets.keyframing.SequencerKeyframingTools¶
Tools for keyframing and animating properties on the Sequencer timeline. Use when adding, querying, or removing keyframes on channels, setting default values, evaluating channels at specific times, working with the Curve Editor, or managing channel selection. Covers float, bool, integer, and string key types with configurable interpolation.
22 tool(s).
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.add_key_bool¶
Add a bool key to a channel on a section.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
frame: The frame number for the key.
value: The bool value.
Returns:
True when the key was added successfully.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"value": {
"type": "boolean"
}
},
"required": [
"section",
"channel_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.add_key_float¶
Add a float key to a channel on a section.
Args:
section: The section containing the channel.
channel_name: Name of the channel (e.g. 'Location.X').
frame: The frame number for the key.
value: The float value.
interpolation: Key interpolation mode as a string:
"cubic", "linear", "constant", "break", or "" for default (smart auto).
Returns:
True when the key was added successfully.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"interpolation": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"value": {
"type": "number"
}
},
"required": [
"section",
"channel_name",
"frame",
"value",
"interpolation"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.add_key_integer¶
Add an integer key to a channel on a section.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
frame: The frame number for the key.
value: The integer value.
Returns:
True when the key was added successfully.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"value": {
"type": "integer"
}
},
"required": [
"section",
"channel_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.add_key_string¶
Add a string key to a channel on a section.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
frame: The frame number for the key.
value: The string value.
Returns:
True when the key was added successfully.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"section",
"channel_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.bake_channel_keys¶
Bake a channel's values over a frame range.
Evaluates the channel curve at every frame in the range and
returns the computed values. Useful for extracting animation
data or verifying interpolation results.
Args:
section: The section containing the channel.
channel_name: Name of the channel (e.g. 'Location.X').
start_frame: Start of the evaluation range.
end_frame: End of the evaluation range.
Returns:
List of float values, one per frame in the range.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"end_frame": {
"type": "integer"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"start_frame": {
"type": "integer"
}
},
"required": [
"section",
"channel_name",
"start_frame",
"end_frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.close_curve_editor¶
Close the Sequencer Curve Editor panel.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.curve_editor_empty_selection¶
Clear all key selection in the Curve Editor.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.curve_editor_select_keys¶
Select keys by index in the Curve Editor.
Args:
channel: The channel proxy containing the keys.
indices: List of integer key indices to select.
Input schema
{
"properties": {
"channel": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
},
"indices": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [
"channel",
"indices"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_channel_names¶
Get the names of all channels on a section.
For example, a 3D Transform section has channels named
'Location.X', 'Location.Y', 'Location.Z', 'Rotation.X', etc.
Args:
section: The section to query.
Returns:
List of channel name strings.
Input schema
{
"properties": {
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_curve_editor_selected_keys¶
Get selected key indices for a channel in the Curve Editor.
Args:
channel: The channel proxy to query.
Returns:
List of integer key indices that are selected.
Input schema
{
"properties": {
"channel": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_default_value¶
Get the default value of a float channel.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
Returns:
The default value of the channel.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"channel_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "number"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_keys¶
Get all keys on a channel, returned as a JSON array.
Each key entry includes its frame number and value.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
Returns:
JSON string with a list of key objects, each with 'frame'
and 'value' fields. For numeric channels the value is a
native JSON number; for exotic channel types that don't
round-trip through JSON natively, the value is stringified.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"channel_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_keys_by_index¶
Get specific keys on a channel by their indices, returned as JSON.
Useful for resolving the keys behind a Curve Editor selection,
which provides indices rather than key objects.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
indices: Key indices to look up (0-based).
Returns:
JSON string with a list of key objects, each with 'frame',
'value', and 'index' fields. An entry is emitted for EVERY
requested index in the input order; out-of-range indices are
reported with 'frame': None and 'value': None so callers can
correlate results with the request. Value uses a native JSON
number for numeric channels and a string for exotic types.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"indices": {
"items": {
"type": "integer"
},
"type": "array"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"channel_name",
"indices"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_selected_channels¶
Get the currently selected channels in the Sequencer editor.
Returns:
List of selected SequencerChannelProxy objects.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.get_selected_key_channels¶
Get channels that have selected keys in the Curve Editor.
Returns:
List of SequencerChannelProxy objects with selected keys.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.is_curve_editor_open¶
Check whether the Curve Editor panel is currently open.
Returns:
True if the Curve Editor is open.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.is_curve_shown¶
Check if a curve is visible in the Curve Editor.
Args:
channel: The channel proxy to check.
Returns:
True if the curve is displayed.
Input schema
{
"properties": {
"channel": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.open_curve_editor¶
Open the Sequencer Curve Editor panel.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.remove_key_at_frame¶
Remove a key at a specific frame from a channel.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
frame: The frame number of the key to remove.
Returns:
True if a key was found and removed, False if no key at that frame.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"channel_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.select_channels¶
Set the channel selection in the Sequencer editor.
Args:
channels: List of SequencerChannelProxy objects to select.
Input schema
{
"properties": {
"channels": {
"items": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
},
"type": "array"
}
},
"required": [
"channels"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.set_default_value¶
Set the default value of a channel.
Args:
section: The section containing the channel.
channel_name: Name of the channel.
value: The default value.
Input schema
{
"properties": {
"channel_name": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
},
"value": {
"type": "number"
}
},
"required": [
"section",
"channel_name",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.keyframing.SequencerKeyframingTools.show_curve¶
Show or hide a curve in the Curve Editor.
Args:
channel: The channel proxy for the curve.
show: True to show, False to hide.
Input schema
{
"properties": {
"channel": {
"properties": {
"channelName": {
"type": "string"
},
"section": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"channelName",
"section"
],
"title": "SequencerChannelProxy",
"type": "object"
},
"show": {
"type": "boolean"
}
},
"required": [
"channel",
"show"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}