Ajouter des classes, des modules et des plug-ins Unreal Engine dans Visual Studio
Dans cet article, apprenez à utiliser Visual Studio Tools for Unreal Engine pour :
- Ajouter des modules Unreal Engine dans Visual Studio
- Ajouter des classes Unreal Engine dans Visual Studio
- Ajouter des plug-ins Unreal Engine dans Visual Studio
Prérequis
Les éléments suivants doivent être installés :
- Visual Studio version 17.11 (17.11 preview versions ok) ou ultérieure.
- Unreal Engine version 5 ou ultérieure.
- Visual Studio Tools pour Unreal Engine. Pour obtenir des instructions sur l’installation, consultez Installer Visual Studio Tools pour Unreal Engine.
- Complétez le Guide de démarrage rapide : Visual Studio Tools for Unreal Engine pour télécharger et créer le jeu Lyra et le configurer pour utiliser Visual Studio Tools for Unreal Engine.
Ajouter des modules Unreal Engine dans Visual Studio
Vous pouvez désormais ajouter des modules Unreal Engine à votre projet Unreal Engine à partir de Visual Studio. Vous n'avez plus besoin de basculer entre l'éditeur Unreal Engine et Visual Studio pour ajouter un module, ni de synchroniser la solution Visual Studio avec votre fichier de projet Unreal Engine par la suite.
Les modules sont un moyen d'organiser votre code dans Unreal Engine. Ils vous aident à regrouper des classes et des ressources connexes et à organiser votre code en unités autonomes qui peuvent être chargées et déchargées au moment de l'exécution. La création de modules peut s'avérer fastidieuse et sujette aux erreurs si vous le faites manuellement, car elle nécessite l'édition de fichiers de configuration et l'ajout de code standard. Visual Studio facilite la création de modules en proposant une boîte de dialogue qui vous guide tout au long du processus et qui se charge de la configuration et de l'ajout du code standard à votre place.
Pour ajouter un module Unreal Engine dans Visual Studio, suivez les étapes suivantes après avoir terminé le guide de démarrage rapide : Visual Studio Tools pour Unreal Engine pour télécharger et créer le jeu Lyra. Ces étapes supposent que la solution LyraStarterGame.sln
est ouverte dans Visual Studio :
- Dans l'Explorateur de solutions, choisissez un projet, tel que LyraStarterGame, dans lequel vous souhaitez insérer le nouveau module.
- Cliquez avec le bouton droit de la souris sur le projet (assurez-vous qu'un projet est sélectionné et non un dossier) et choisissez Ajouter>Élément Unreal Engine... pour ouvrir la boîte de dialogue Ajouter un nouvel élément pour les éléments Unreal Engine :
- Choisissez le module Unreal Engine, indiquez un nom de module dans le champ Nom, puis cliquez sur Ajouter pour ouvrir la boîte de dialogue Ajouter un module Unreal Engine :
La boîte de dialogue Add Unreal Engine Module comporte un champ pour le nom du module, des menus déroulants pour le type de module (Runtime est sélectionné) et la phase de chargement du module (Default est sélectionné). Le chemin d'accès au module, l'en-tête, la source et les chemins d'accès aux fichiers de construction sont répertoriés. La case à cocher Refresh IntelliSense information using Unreal Editor tools (Actualiser les informations IntelliSense à l'aide des outils de l'éditeur Unreal) est cochée.
- Utilisez les menus déroulants pour sélectionner le type de module et la phase de chargement du module.
- Choisissez OK pour ajouter le module au projet et mettre à jour le fichier de solution Visual Studio.
Les modules ne peuvent être créés que dans le dossier Source ou en tant que module d'un plug-in dans le dossier Plug-ins.
Le chemin Build indique l'endroit où le fichier Build.cs
est créé. Le fichier Build.cs
contient des informations sur la configuration du module.
Ajouter des classes Unreal Engine dans Visual Studio
Vous pouvez désormais ajouter des classes Unreal Engine à votre projet Unreal Engine à partir de Visual Studio. Vous n'avez plus besoin de basculer entre l'éditeur Unreal et Visual Studio pour ajouter une classe, ni de synchroniser la solution Visual Studio avec votre fichier de projet Unreal Engine par la suite.
Pour ajouter une classe Unreal Engine dans Visual Studio, suivez les étapes suivantes après avoir terminé le guide de démarrage rapide : Visual Studio Tools pour Unreal Engine pour télécharger et créer le jeu Lyra. Les étapes supposent que la solution LyraStarterGame.sln
est ouverte dans Visual Studio :
- Dans l'Explorateur de solutions, choisissez un dossier dans lequel vous souhaitez placer la nouvelle classe. Dans le projet LyraStarterGame, vous pouvez ajouter une nouvelle classe dans le dossier LyraStarterGame> source, par exemple.
- Cliquez avec le bouton droit de la souris sur le dossier et choisissez Ajouter>Élément Unreal Engine... pour ouvrir la boîte de dialogue Ajouter un nouvel élément :
Elle propose des options pour ajouter une classe commune Unreal Engine (qui est sélectionnée), un module Unreal Engine vide et des plug-ins Unreal Engine.
- Choisissez Classes communes Unreal Engine, puis choisissez Ajouter pour ouvrir la boîte de dialogue Ajouter une classe Unreal Engine :
Les options de sélection d'une base telle que Actor, Character, etc. sont visibles. Il y a un champ pour le nom de la classe et une liste déroulante pour le module auquel ajouter la classe. Les chemins d'accès au fichier d'en-tête et au fichier source sont indiqués. Une case à cocher permet de rafraîchir les informations IntelliSense à l'aide des outils de l'Unreal Editor.
- Choisissez un nom de classe. Visual Studio vous avertit si le nom entre en conflit avec une classe ou un fichier existant.
- Choisissez une classe de base. La sélection d'une classe de base garantit que les bons en-têtes et macros sont inclus pour ce type de classe.
- Choisissez un module à ajouter à votre classe à l'aide du menu déroulant Sélectionnez un module à ajouter à la classe. Le nom du module est le nom du dossier qui contient le module.
- Cochez la case Actualiser les informations IntelliSense à l'aide des outils de l'éditeur Unreal pour indiquer si Visual Studio utilise les outils de l'éditeur Unreal pour mettre à jour les informations IntelliSense. Choisissez cette option pour que l'outil de construction Unreal régénère le fichier de solution Visual Studio.
- Choisissez OK pour générer les fichiers d'en-tête et de source de la nouvelle classe et les ajouter au fichier de solution Visual Studio. Il en résulte une requête pour recharger le projet. Choisissez Recharger pour recharger le projet.
Ajouter des plug-ins Unreal Engine dans Visual Studio
Vous pouvez désormais ajouter des plug-ins Unreal Engine à votre projet Unreal Engine à partir de Visual Studio. Vous n'avez plus à basculer entre l'éditeur Unreal et Visual Studio pour ajouter un plug-in, ni à synchroniser ensuite la solution Visual Studio avec votre fichier de projet Unreal Engine.
Pour ajouter un plug-in Unreal Engine dans Visual Studio, suivez les étapes suivantes après avoir terminé le guide de démarrage rapide : Visual Studio Tools pour Unreal Engine pour télécharger et créer le jeu Lyra. Les étapes supposent que la solution LyraStarterGame.sln
est ouverte dans Visual Studio :
- Dans l'Explorateur de solutions, choisissez un dossier dans lequel vous souhaitez placer le nouveau plug-in. Dans le projet LyraStarterGame, vous pouvez ajouter un nouveau plug-in dans le dossier LyraStarterGame> source, par exemple.
- Cliquez avec le bouton droit de la souris sur le dossier et choisissez Ajouter>Élément Unreal Engine... pour ouvrir la boîte de dialogue Ajouter un nouvel élément :
Il dispose d'options pour ajouter un Unreal Engine Common Classes, Empty Unreal Engine Module, et Unreal Engine Plugins (qui est sélectionné).
- Choisissez Plug-ins Unreal Engine puis choisissez Ajouter pour ouvrir la boîte de dialogue Ajouter un plug-in Unreal Engine :
Il y a une liste de types de plugins (Advanced est sélectionné), et des champs pour le nom du plugin, le chemin, l'auteur, la description et l'URL. Il y a une case à cocher Is plug-in in beta (non cochée) et une case à cocher Refresh IntelliSense information using Unreal Editor Tools (cochée).
- Choisissez le type de votre plug-in dans la liste Type de plug-in.
- Indiquez le nom, l'auteur, la description et l'url du plug-in.
- Cochez la case Le plug-in est-il en version bêta si nécessaire.
- Cochez la case Actualiser les informations IntelliSense à l'aide des outils de l'éditeur Unreal pour indiquer si Visual Studio utilise les outils de l'éditeur Unreal pour mettre à jour les informations IntelliSense. L'outil de construction Unreal régénère alors le fichier de la solution Visual Studio.
- Choisissez Ajouter pour générer les fichiers d'en-tête et de source du nouveau plug-in et les ajouter au fichier de solution Visual Studio. Il en résulte une requête pour recharger le projet. Choisissez Recharger pour recharger le projet.
Contenu connexe
Visual Studio Tools pour Unreal Engine
Visualiser les Blueprints de l'Unreal Engine dans Visual Studio
Visualiser le journal de l'Unreal Engine dans Visual Studio
Visualiser les macros Unreal Engine dans Visual Studio