convert_to_reference() — Fast Ref API Reference

Converts currently selected objects in 3ds Max into a Fast Ref reference. Objects must be selected in 3ds Max before calling this API.

Signature

api.convert_to_reference(namespace: str = None) -> dict

Parameters

Parameter	Type	Description
`namespace`	`str`	Namespace name. If `None`, auto-generated

Return Value

{
    "success": True,
    "message": str,
    "slot": int,
    "namespace": str,
    "node_count": int,
}

Errors

Error	Cause
`ValueError`	No objects selected or no available slot
`RuntimeError`	Conversion failed

Example

# Select objects in 3ds Max first, then call:
from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
result = api.convert_to_reference(namespace="MyCharacter")

print(f"Converted to slot {result['slot']}  (ns: {result['namespace']})")

v2: Confirmation dialog is suppressed automatically.