get_reference_list()

Returns the complete list of all references registered in the current scene.

Signature

api.get_reference_list() -> dict

Return Value

{
    "success": True,
    "count": int,
    "data": [
        {
            "slot": int,
            "name": str,
            "filename": str,
            "namespace": str,
            "space_activate": bool,
            "unpack": bool,
        },
        ...
    ]
}

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
refs = api.get_reference_list()

print(f"Total: {refs['count']}")
for ref in refs['data']:
    space = "ON" if ref['space_activate'] else "OFF"
    print(f"  [{ref['slot']}] {ref['name']}  ns={ref['namespace']}  space={space}")

Output example:
plain text Total: 3 [0] dummy_female ns=dummy_female_01 space=ON [1] dummy_male ns=dummy_male_01 space=ON [2] prop_sword ns=prop_sword_01 space=ON