Method set_default_instance

unity_cli/client.py:480–516

Set the default Unity instance. Args: instance_id: Project path to set as default. Returns: True if successfully set. Raises: InstanceError: If instance not found. ConnectionError: If cannot connect to relay server.

(self, instance_id: str)

        )

    def set_default_instance(self, instance_id: str) -> bool:
        """Set the default Unity instance.

        Args:
            instance_id: Project path to set as default.

        Returns:
            True if successfully set.

        Raises:
            InstanceError: If instance not found.
            ConnectionError: If cannot connect to relay server.
            ProtocolError: For unexpected message types.
        """
        message = {
            "type": "SET_DEFAULT",
            "id": _generate_request_id(self._client_id),
            "instance": instance_id,
            "ts": int(time.time() * 1000),
        }

        response = self._send_admin_message(message)

        if response.get("type") == "RESPONSE":
            success: bool = response.get("success", False)
            return success
        if response.get("type") == "ERROR":
            error: dict[str, str] = response.get("error", {})
            raise InstanceError(
                error.get("message", "Failed to set default instance"),
                error.get("code", "UNKNOWN_ERROR"),
            )

        raise ProtocolError(
            f"Unexpected response type: {response.get('type')}",
            "PROTOCOL_ERROR",
        )


# =============================================================================