Éditeur de Script

Introduction

L'éditeur de script du moteur Godot est un éditeur de texte puissant et entièrement intégré qui rationalise non seulement le processus d'écriture et de débogage de code écrit en GDScript mais permet également de travailler avec des fichiers texte bruts, fournissant aux développeurs un environnement sans coupures pour scripter la logique et les comportements de jeu. Il peut mettre en valeur votre code, l'identifier automatiquement, effectuer des vérifications de syntaxe, et bien plus encore. Vous pouvez également créer des points d'arrêt pour déboguer votre projet sans passer à une autre fenêtre. L'éditeur de texte sert également de visualisateur de la référence de classe hors ligne, qui peut être consulté de plusieurs façons comme décrit dans le Référence de classe intégrée.

../../_images/text_editor.webp

Fonctionnalités

Certaines des fonctionnalités clés de l'éditeur de texte sont listées ci-dessous :

  • Éditeur de code complètement intégré pour GDScript.

  • Support de la coloration syntaxique pour les fichiers JSON et GDScript.

  • Vérification de la syntaxe pour les fichiers GDScript et JSON.

  • Support des marque-pages et des points d'arrêt.

  • Indentation automatique.

  • Pliage de code.

  • Thème personnalisable.

  • Plusieurs curseurs, qui peuvent être activés en utilisant Alt + Left Click.

  • Auto-complétion des variables, fonctions, constantes, etc.

  • Inline refactoring of symbols by selecting them and using Ctrl + D.

  • Recherche et remplacement en masse dans les fichiers du projet.

Utilisation

Si vous utilisez du GDScript dans votre projet, l'éditeur de texte intégré dans Godot fournit tout ce dont vous avez besoin, servant comme un emplacement unique pour utiliser pleinement le moteur Godot. Presque tous les paramètres qui peuvent être ajustés via l'interface utilisateur peuvent également être modifiés directement par le code.

Note

Si vous souhaitez utiliser un éditeur de texte externe ou que vous préférez utiliser le C# dans votre projet, consultez Utiliser un éditeur de texte externe et Configuration d'un éditeur externe.

Astuce

Comme pour de nombreuses parties de l'interface de Godot, l'éditeur de texte peut également être personnalisé en changeant ses paramètres à votre goût. Vous pouvez accéder à ces paramètres en ouvrant Éditeur > Paramètres de l'éditeur et en allant dans le groupe Éditeur de texte.

../../_images/editor_ui_script_editor_open.webp

Vous pouvez ouvrir l'éditeur de script en utilisant le bouton Script dans le sélecteur de l'espace de travail, situé au centre supérieur de l'interface de Godot. Vous pouvez également utiliser le bouton Ouvrir script à côté d'un nœud dans le dock Scène, ou double-cliquez sur un fichier .gd ou un fichier texte reconnu dans le dock Systèmes de fichiers pour l'ouvrir directement dans l'éditeur de script.

../../_images/editor_ui_script_editor_menu.webp

Once it is open, you will see the text editor menus at the top, below the scene switcher. Next to the menus, you'll find buttons to open the online documentation or search within the built-in class reference. To the right of these buttons are two navigation arrows that allow you to navigate through your viewing history. Finally, you can use the float button to separate the text editor from Godot's window, which is useful if you are working with multiple monitors.

Sous les menus de gauche, vous verrez le panneau de script. Dans le centre, adjacent au panneau de script, est la zone de codage. Sous la zone de codage est la barre de statut, qui affiche le nombre d'erreurs et d'avertissement dans le code. Cliquez sur les icônes d'erreur ou d'avertissement affichera la liste des erreurs avec les numéros de ligne. En cliquant sur l'un, l'éditeur va sauter à cette ligne. Vous pouvez également choisir d'ignorer les avertissements en ouvrant la liste et en cliquant sur Ignore. La barre de statut vous permet également de modifier le niveau de zoom du code en cliquant sur la valeur de pourcentage. Vous pouvez également utiliser Ctrl + Molette Souris (Cmd + Molette Souris sur Mac) pour obtenir le même effet. La barre de statut montre également la position actuelle du curseur en termes de ligne et de colonne, et si l'indentation est faite en utilisant des tabulations ou des espaces.

De nombreuses actions effectuées dans l'éditeur de texte peuvent également être exécutées avec des raccourcis. Les actions montrent leurs raccourcis correspondants à côté d'eux. Pour une liste de raccourcis complète, voir les raccourcis de l'éditeur de texte.

Dans les sections suivantes, nous irons sur différents aspects de l'éditeur de texte. Vous pouvez également sélectionner une section ci-dessous pour sauter à un sujet spécifique :

Panneau de script

../../_images/editor_ui_script_editor_script_panel.webp

Sous les menus, sur le panneau gauche, vous verrez une liste de fichiers ouverts et des pages de documentation. Selon le type de fichier, cette liste aura une icône à côté du nom du fichier. Par exemple, l'icône script signifie que c'est un GDScript. scriptcsharp signifie que c'est un script C#. Le documentation signifie que c'est une référence de classe intégrée. Enfin, le toolscript signifie qu'il s'agit d'un script en cours d'exécution (Voir annotation outil pour plus d'info sur ceci). Passer la souris sur un fichier affichera une info-bulle avec son emplacement relatif dans le dossier du projet.

Sur la barre de statut, cliquer sur la flèche gauche cache le panneau de script, cliquer sur la flèche droite le montre.

Si vous n'avez pas changé de paramètres, les noms de fichiers peuvent également avoir une coloration différente. Cela vous aide à identifier les fichiers récemment édités en les mettant en évidence. Ce comportement peut être modifié dans la section Éditeur > Réglages de l'éditeur en ajustant les propriétés Température de script dans la section Éditeur de texte.

La barre de filtre au-dessus des noms de fichiers introduit une recherche pratique insensible à la casse pour trouver un fichier spécifique. Même si vous tapez simplement les lettres d'un nom de fichier dans la barre, les fichiers contenant ces lettres dans l'ordre apparaîtront également. Supposons qu'il y ait un fichier nommé button.gd dans la liste. Si vous tapez btn dans la barre de filtre, ce fichier apparaîtra dans les résultats. Pour réinitialiser le filtre, videz la barre de filtre.

Une astérisque (*) à côté d'un nom de fichier indique que le fichier a des changements non sauvegardés.

Astuce

Si vous tapez juste "*" dans la barre de filtre, vous pouvez afficher tous les fichiers non sauvegardés.

Vous pouvez glisser un fichier pour changer l'ordre. Le clic du milieu sur un fichier le ferme. Le clic droit sur un fichier offre plusieurs options pour enregistrer ou fermer des fichiers, ou pour copier le chemin relatif du fichier. Dans ce menu :

You can also use Move Up and Move Down to change the order of the file, or use Sort to sort all files alphabetically. Toggle Scripts Panel hides the panel, which can be displayed again using the right arrow on the status bar. Close Docs closes all opened in-class reference documents leaving only script files open. Show in FileSystem finds and highlights the file in the FileSystem dock.

Below the file list, you'll see the name of the currently open file. The button next to this switches the ordering of the methods defined in this file between alphabetical and as they appear. Under this is the outline of the file. If this is a script file, it will contain the list of defined methods. If, however, a class reference page is open, this area will show the table of contents of this document. Clicking on an item in this list will jump to the respective function or section in the file. Similarly, the Filter Methods bar lets you search for a specific function or section within the selected document with the same behavior as filtering scripts.

Zone de programmation

Note

This section will only cover the basics of the coding area in terms of the user interface. To learn more about scripting in Godot, refer to the GDScript or Scripting documentation.

../../_images/editor_ui_script_editor_coding_area.webp

The coding area is where you will type your scripts if you are using the built-in text editor. It offers highlighting and auto-completion features to help you while you code.

The coding area shows line numbers on the left side. Below the navigation arrows on the right side, there is a clickable minimap that provides an overview of the entire script, allowing you to scroll through it.

If a line of code is long enough (more than 80 characters, by default), the text editor will display a vertical line that can be used as a soft guideline. For a hard guideline, this value is set to 100 characters, by default. Both values can be changed, or the display of the line can be toggled in the "Appearance" settings of the text editor.

In the script, to the left of function definitions, you might see additional icons. The override icon indicates that this function is an override of an existing function. Clicking it opens the documentation of the original function. The récepteur icon means that it is a receiving method of a signal. Clicking it shows where the signal is coming from. A foldable icon to the left of the line denotes a foldable block. You can click to collapse or expand it. Alternatively, the ellipsis (...) icon can also be clicked to expand a folded block.

L'exemple ci-dessous récapitule le paragraphe ci-dessus. Les lignes 52, 56 et 58 sont des blocs pliables, la ligne 57 est une région de code avec le nom "Nouvelle région de code", que vous pouvez également plier, et la ligne 62 est un bloc plié. La ligne 53 est un signet, qui peut être rapidement atteint à l'aide du menu Aller à > Signets. La ligne 55 est un point de rupture qui peut être utilisé dans déboguage.

../../_images/text_editor_coding_area_indicators.webp

Many of the colors of the text editor such as highlighting colors, or even breakpoint or bookmark icon colors can be customized. You can experiment them by opening the text editor settings navigating to Editor > Editor Settings > Text Editor section.