Fast Ref / API Reference / Advanced

merge_all_references()

Download Markdown

Converts all references into regular scene objects and clears Fast Ref tracking data. This operation is irreversible.

Processing order:
- Phase 0 — Enable Space Activate for all
- Phase 1 — Disable Space Activate per namespace (consolidate to single .rN suffix)
- Phase 2 — Merge in order (Unpack → Merge → delete data)
- Phase 3 — Remove suffixes (based on options)

Signature

api.merge_all_references(
    remove_node_suffix: bool = True,
    remove_layer_suffix: bool = False,
    remove_selectionset_suffix: bool = True,
) -> dict

Parameters

Parameter Type Default Description
remove_node_suffix bool True Remove .rN suffix from node names after merge
remove_layer_suffix bool False Remove .rN suffix from layer names
remove_selectionset_suffix bool True Remove .rN suffix from SelectionSet names

Return Value

{
    "success": bool,
    "message": str,
    "merged_count": int,
    "failed_count": int,
}

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
result = api.merge_all_references(
    remove_node_suffix=True,
    remove_layer_suffix=True,
    remove_selectionset_suffix=True,
)
print(result['message'])
# e.g. "Merge complete: 3 succeeded, 0 failed"

Note: Setting remove_layer_suffix=True removes .rN suffix from layer names. If your pipeline relies on those names elsewhere, review before using.


💬

Need help with the API?

Open a support ticket or join the community discussion.

Contact Support