Fast Ref
/
API Reference
/
Advanced
set_unpack()
Download MarkdownToggles the Unpack state ON/OFF for the specified slot. When Unpack is ON, reference nodes are detached from the top-level group container and moved to the world level.
Signature
api.set_unpack(slot: int, on: bool) -> dict
Parameters
| Parameter | Type | Description |
|---|---|---|
slot |
int |
Slot number (0-9) |
on |
bool |
True = Unpack, False = Repack (restore group) |
Return Value
{"success": bool, "message": str}
Errors
| Error | Cause |
|---|---|
TypeError |
slot is not int (including bool) [v2 added] |
ValueError |
Slot is invalid or empty |
Example
from os_fast_ref.api import FastRefAPI
api = FastRefAPI()
api.set_unpack(slot=0, on=True) # Unpack (detach from group)
api.set_unpack(slot=0, on=False) # Repack (restore group)