refresh_unity
Auto-generated from the Python tool registry. Do not hand-edit outside
<!-- examples:start --><!-- examples:end -->blocks — the generator (tools/generate_docs_reference.py) will overwrite them.
Group: core · Module: services.tools.refresh_unity
Description
Request a Unity asset database refresh and optionally a script compilation. Can optionally wait for readiness.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
mode | Literal['if_dirty', 'force'] | — | Refresh mode |
scope | Literal['assets', 'scripts', 'all'] | — | Refresh scope |
compile | Literal['none', 'request'] | — | Whether to request compilation |
wait_for_ready | bool | — | If true, wait until editor_state.advice.ready_for_tools is true |
Returns
A dict containing the Unity response. The exact shape depends on the action.
Examples
No examples yet. Add usage examples here — they will be preserved across regenerations.