Fast Ref / API Reference / Export

export_fbx_all()

Download Markdown

Exports all registered references as FBX files in batch. Each output file is named automatically using the reference's namespace. ({namespace}.fbx)

Signature

api.export_fbx_all(output_folder: str, fbx_options: dict = None, preset: str = None) -> dict

Parameters

Parameter Type Description
output_folder str Output folder path
fbx_options dict FBX option overrides (applied after preset, or over defaults if no preset)
preset str Saved preset name [v2 new]

Return Value

{
    "success": bool,
    "message": str,
    "exported_count": int,
    "failed_count": int,
    "results": [
        {
            "slot": int,
            "name": str,
            "success": bool,
            "output_path": str,   # on success
            "error": str,         # on failure
        },
        ...
    ]
}

Errors

Error Cause
ValueError Output folder does not exist, invalid preset name
TypeError fbx_options is not dict

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()

# Default preset
result = api.export_fbx_all(output_folder=r"J:\output")
print(f"Exported: {result['exported_count']}, Failed: {result['failed_count']}")

# Named preset (v2)
result = api.export_fbx_all(output_folder=r"J:\output", preset="Unreal_Ani")

for r in result['results']:
    status = "OK" if r['success'] else "FAIL"
    print(f"  [{r['slot']}] {r['name']}: {status}")

💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support