Fast Ref API
/
API Reference
/
Get Nodes
get_all_objects()
Download MarkdownQueries all reference nodes in the given slot. Matches the right-click menu All Objects.
Signature
api.get_all_objects(slot, select=0) -> dict
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
slot |
int |
Yes | Slot number (0–9). bool/str/float → TypeError |
select |
int (0/1) or bool |
No (default 0) |
0=query only, 1=query then select in scene |
Return Value
{
"success": bool,
"slot": int,
"category": "all_objects",
"count": int,
"handles": list, # list[int], valid nodes only
"names": list, # list[str], 1:1 with handles
"selected": int, # normalized select (0 or 1)
"selected_count": int,
"reference_name": str, # reference display name
"message": str,
}
Example
from os_fast_ref.api import FastRefAPI
api = FastRefAPI()
# Query only
r = api.get_all_objects(slot=0)
print(r["reference_name"], r["count"], r["names"][:5])
# Query + scene selection
api.get_all_objects(slot=0, select=1)
Notes
- An empty result (
count=0) is not an error. - Invalid
slot/selectraises immediately (TypeError/ValueError). - See the Get Nodes overview page for the shared contract and exception table.
- Also returns the
reference_namefield.