animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools¶
Tools for converting and managing custom binding types in Sequencer. Use when converting between possessable, spawnable, and custom/replaceable bindings, querying what custom binding type a binding uses, accessing custom binding objects for property inspection, or changing the actor template class on spawnables/replaceables.
8 tool(s).
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.change_actor_template_class¶
Set the actor class for a spawnable or replaceable template.
Args:
binding: The spawnable/replaceable binding to modify.
actor_class: Full class path of the new actor class.
Returns:
True if the class was changed successfully.
Input schema
{
"properties": {
"actor_class": {
"type": "string"
},
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding",
"actor_class"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.convert_to_custom_binding¶
Convert a binding to a custom binding type.
Args:
binding: The binding to convert.
binding_type_class: Full class path of the custom binding type.
Returns:
The converted SequencerBindingProxy.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
},
"binding_type_class": {
"type": "string"
}
},
"required": [
"binding",
"binding_type_class"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.convert_to_possessable¶
Convert a spawnable binding to a possessable.
Args:
binding: The spawnable binding to convert.
Returns:
The new possessable SequencerBindingProxy.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.convert_to_spawnable¶
Convert a possessable binding to a spawnable.
Args:
binding: The possessable binding to convert.
Returns:
List of new spawnable SequencerBindingProxy objects.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.get_custom_binding_objects¶
Get the custom binding instances for a binding.
Args:
binding: The binding to query.
Returns:
List of UMovieSceneCustomBinding objects.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/MovieScene.MovieSceneCustomBinding",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.get_custom_binding_type¶
Get the custom binding class for a binding.
Returns the class path of the custom binding type, or an empty
string for standard possessable bindings.
Args:
binding: The binding to query.
Returns:
Class path string, or empty string.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.get_custom_bindings_of_type¶
Find all bindings of a given custom type in the current sequence.
Args:
binding_type_class: Full class path of the custom binding type.
Returns:
List of matching SequencerBindingProxy objects.
Input schema
{
"properties": {
"binding_type_class": {
"type": "string"
}
},
"required": [
"binding_type_class"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.custom_bindings.SequencerCustomBindingTools.save_default_spawnable_state¶
Save the current state of a spawnable as its default.
Args:
binding: The spawnable binding to save defaults for.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
}
},
"required": [
"binding"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}