Unity CLI Client with all APIs. Provides access to Unity Editor functionality via relay server. APIs are lazily imported to avoid circular dependencies. Usage: client = UnityClient() # Check connected instances instances = client.list_instances() # Use
| 522 | |
| 523 | |
| 524 | class UnityClient: |
| 525 | """Unity CLI Client with all APIs. |
| 526 | |
| 527 | Provides access to Unity Editor functionality via relay server. |
| 528 | APIs are lazily imported to avoid circular dependencies. |
| 529 | |
| 530 | Usage: |
| 531 | client = UnityClient() |
| 532 | |
| 533 | # Check connected instances |
| 534 | instances = client.list_instances() |
| 535 | |
| 536 | # Use specific instance |
| 537 | client = UnityClient(instance="/path/to/project") |
| 538 | |
| 539 | # Console |
| 540 | client.console.get(types=["error"], count=10) |
| 541 | |
| 542 | # Editor |
| 543 | client.editor.play() |
| 544 | client.editor.stop() |
| 545 | |
| 546 | # GameObject |
| 547 | client.gameobject.create("Player", primitive_type="Cube") |
| 548 | |
| 549 | # Scene |
| 550 | client.scene.load(path="Assets/Scenes/Main.unity") |
| 551 | |
| 552 | Attributes: |
| 553 | console: Console log operations. |
| 554 | editor: Editor control (play/pause/stop). |
| 555 | gameobject: GameObject CRUD operations. |
| 556 | scene: Scene management. |
| 557 | component: Component inspection. |
| 558 | tests: Test execution. |
| 559 | menu: Menu item execution. |
| 560 | """ |
| 561 | |
| 562 | def __init__( |
| 563 | self, |
| 564 | relay_host: str = DEFAULT_RELAY_HOST, |
| 565 | relay_port: int = DEFAULT_RELAY_PORT, |
| 566 | timeout: float = 5.0, |
| 567 | instance: str | None = None, |
| 568 | timeout_ms: int = DEFAULT_TIMEOUT_MS, |
| 569 | retry_initial_ms: int = 500, |
| 570 | retry_max_ms: int = 8000, |
| 571 | retry_max_time_ms: int = 30000, |
| 572 | on_retry: RetryCallback | None = None, |
| 573 | on_version_info: Callable[[str, str], None] | None = None, |
| 574 | on_send: Callable[[dict[str, Any], dict[str, Any]], None] | None = None, |
| 575 | ) -> None: |
| 576 | """Initialize Unity client. |
| 577 | |
| 578 | Args: |
| 579 | relay_host: Relay server hostname (default: 127.0.0.1). |
| 580 | relay_port: Relay server port (default: 6500). |
| 581 | timeout: Socket timeout in seconds (default: 5.0). |