animation_toolset.toolsets.import_export.SequencerImportExportTools

Tools for importing and exporting animation data to and from Sequencer. Use when exporting bindings or Control Rig animation to FBX files, importing FBX animation onto bindings or Control Rig tracks, exporting animation to AnimSequence assets, or linking AnimSequences for auto-updates.

6 tool(s).

animation_toolset.toolsets.import_export.SequencerImportExportTools.export_anim_sequence

Export animation from a sequence binding to an AnimSequence asset.

    Args:
        world: The world context.
        sequence: The source LevelSequence.
        anim_sequence: The destination AnimSequence asset.
        binding: The binding whose animation to export.
        create_link: Whether to create a link between the sequence and
            the exported AnimSequence.

    Returns:
        True if the export succeeded, False otherwise.

Input schema

{
  "properties": {
    "anim_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/Engine.AnimSequence",
      "type": "object"
    },
    "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"
    },
    "create_link": {
      "default": false,
      "type": "boolean"
    },
    "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/LevelSequence.LevelSequence",
      "type": "object"
    },
    "world": {
      "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/Engine.World",
      "type": "object"
    }
  },
  "required": [
    "world",
    "sequence",
    "anim_sequence",
    "binding"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.import_export.SequencerImportExportTools.export_fbx

Export a level sequence to FBX.

    Args:
        world: The world context.
        sequence: The LevelSequence to export.
        bindings: The bindings to include in the export.
        fbx_file_path: The output FBX file path.
        override_options: Optional FBX export options.

    Returns:
        True if the export succeeded, False otherwise.

Input schema

{
  "properties": {
    "bindings": {
      "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"
    },
    "fbx_file_path": {
      "type": "string"
    },
    "override_options": {
      "default": null,
      "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/UnrealEd.FbxExportOption",
      "type": "object"
    },
    "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/LevelSequence.LevelSequence",
      "type": "object"
    },
    "world": {
      "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/Engine.World",
      "type": "object"
    }
  },
  "required": [
    "world",
    "sequence",
    "bindings",
    "fbx_file_path"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.import_export.SequencerImportExportTools.get_linked_anim_sequences

Get content paths of all AnimSequences linked to a LevelSequence.

    Linked AnimSequences auto-update when the LevelSequence changes.
    They are created via export_anim_sequence with create_link=True.

    Args:
        sequence: The LevelSequence to query.

    Returns:
        List of content paths (e.g. '/Game/Anim/Test_Anim') for each
        linked AnimSequence. Empty list if no links exist.

Input schema

{
  "properties": {
    "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/LevelSequence.LevelSequence",
      "type": "object"
    }
  },
  "required": [
    "sequence"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.import_export.SequencerImportExportTools.get_linked_level_sequence

Get the content path of the LevelSequence linked to an AnimSequence.

    Args:
        anim_sequence: The AnimSequence to query.

    Returns:
        Content path of the linked LevelSequence, or empty string if
        no link exists.

Input schema

{
  "properties": {
    "anim_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/Engine.AnimSequence",
      "type": "object"
    }
  },
  "required": [
    "anim_sequence"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.import_export.SequencerImportExportTools.import_fbx

Import FBX data into a level sequence.

    Args:
        world: The world context.
        sequence: The LevelSequence to import into.
        bindings: The bindings to apply the import to.
        import_settings: The FBX import settings.
        fbx_file_path: The input FBX file path.

    Returns:
        True if the import succeeded, False otherwise.

Input schema

{
  "properties": {
    "bindings": {
      "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"
    },
    "fbx_file_path": {
      "type": "string"
    },
    "import_settings": {
      "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/MovieSceneTools.MovieSceneUserImportFBXSettings",
      "type": "object"
    },
    "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/LevelSequence.LevelSequence",
      "type": "object"
    },
    "world": {
      "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/Engine.World",
      "type": "object"
    }
  },
  "required": [
    "world",
    "sequence",
    "bindings",
    "import_settings",
    "fbx_file_path"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

animation_toolset.toolsets.import_export.SequencerImportExportTools.link_anim_sequence

Link an AnimSequence asset to a level sequence binding.

    When the sequence is modified, the linked AnimSequence can be
    automatically updated.

    Args:
        sequence: The LevelSequence to link from.
        anim_sequence: The AnimSequence to link to.
        binding: The binding to associate the link with.

    Returns:
        True on success. Returns False (via the tool_call decorator) if
        sequence or anim_sequence is None.

Input schema

{
  "properties": {
    "anim_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/Engine.AnimSequence",
      "type": "object"
    },
    "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"
    },
    "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/LevelSequence.LevelSequence",
      "type": "object"
    }
  },
  "required": [
    "sequence",
    "anim_sequence",
    "binding"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}