
Description
Visual Studio Integration Tool is an Unreal Engine plugin that works in conjunction with Visual Studio to display Unreal Engine Tests in VS. As of Visual Studio 2022 version 17.9, you no longer need this plugin to view information about Blueprints in C++ code.
Installing
Visual Studio
The tool requires the IDE support for Unreal Engine component from Visual Studio to be installed. You can find it under the "Game development with C++" workload in the Visual Studio Installer (figure 1).
Unreal Engine
You can install the plugin in a couple of ways:
- Through the Epic Games Launcher:
- Select the "Install to Engine" option within the Launcher. From there, you can select an engine version for installation.
- If you're using the Marketplace website, you can add the plugin to your account and you will have an option to open the Launcher in order to install it as detailed above.
- If you already added the plugin to your account, go Library -> Vault in the and locate the plugin there.
- Through source distribution:
- If you're unable to use the Marketplace-based distribution (e.g. you're building the Unreal Engine from source), then you can install the plugin manually by following the instructions found at https://github.com/microsoft/vc-ue-extensions#readme
Enabling the plugin
- Through the Unreal Editor
- Open your project and then use the Plugin Manager to enable "VisualStudioTools".
- See official documentation for more information on how to install and enable plugins.
- (Advanced) Alternatively, you can manually edit the '.uproject' descriptor for your project and add an entry for the "VisualStudioTools" plugin.
Usage
Unreal Engine Test Adapter in Visual Studio 2022
- Begin by installing and enabling the plugin.
- Add the "Unreal Engine Test Adapter" Component in the Visual Studio Installer
- Open your solution in Visual Studio.
- Open Test Explorer via View > Test Explorer
- You should now see your Unreal Engine tests in Visual Studio
Blueprints Integration in Visual Studio 2022 (Obsolete since VS2022 v17.9)
- Begin by installing and enabling the Blueprints Integration plugin.
- Open your solution in Visual Studio.
- You should now be able to see Code Lens hints with Blueprints references when opening files that contain UCLASS macros.
- Click on the Code Lens to show a pop-up that will display your Blueprint information. (figure 2).
- You can find the logs from the plugin execution in the Output Window.
- To refresh your blueprint information in the IDE, you can select the "Rescan UE Blueprint for <project>" option under the “Project” menu. (figure 3).
Troubleshooting
If you encounter any issues when setting up Visual Studio in conjunction with the Unreal Editor plugin, please refer to the Troubleshooting guide in the repository. This guide provides solutions for common issues and is periodically updated to ensure that the latest solutions are available.
Reporting issues
To report new issues, provide feedback, or request new features, please use the following options: Report a Problem and Suggest a Feature. These options will allow you to submit your issue or feedback directly to our team and help us improve the plugin moving forward.