Débogage

Studio offre de nombreux outils et workflows de débogage que l'on trouve couramment dans les environnements de développement intégrés (IDE). Ceux-ci vous aident à inspecter et à résoudre les erreurs dans les scripts pendant leur exécution.

Débogage par points d'arrêt

Les points d'arrêt sont des points de contrôle qui mettent en pause ou "cassent" l'exécution de vos scripts à des lignes spécifiques. Vous pouvez utiliser ces pauses pour inspecter et déboguer votre expérience, surveiller les variables et inspecter la pile d'appels. Les points d'arrêt sont l'une des manières les plus efficaces de déboguer des fonctions, c'est donc l'un des outils de débogage les plus importants.

Gestion

Dans l'éditeur de script, vous pouvez insérer plusieurs types de points d'arrêt et modifier la configuration d'un point d'arrêt à tout moment, même pendant les sessions de test. Si vous modifiez des points d'arrêt pendant une session de test, les modifications persistent même après la fin de celle-ci. Vous pouvez également modifier un point d'arrêt qui met activement en pause votre session de test, mais les changements ne s'appliquent qu'à la prochaine session de test.

Insérer

Les points d'arrêt prennent plusieurs variantes et peuvent être insérés à n'importe quelle ligne de code exécutable comme suit :

Pour insérer un point d'arrêt standard à une ligne de code, cliquez dans la marge directement à droite de son numéro de ligne. Alternativement, cliquez avec le bouton droit de la souris dans la marge et sélectionnez Insérer Point d'arrêt. L'icône du point d'arrêt apparaît comme un cercle rouge.

Désactiver

Pour désactiver temporairement un point d'arrêt sans le supprimer, utilisez l'un des workflows suivants :

• Cliquez sur l'icône du point d'arrêt.
• Cliquez avec le bouton droit sur l'icône du point d'arrêt et sélectionnez Désactiver le point d'arrêt.
• Modifier le point d'arrêt et basculez la case à cocher Activé.

Un point d'arrêt désactivé apparaît sous forme de version creuse de son icône activée, par exemple un cercle creux pour un point d'arrêt standard désactivé, ou un diamant creux pour un logpoint désactivé.

Supprimer

Pour supprimer un point d'arrêt, cliquez au milieu de son icône ou cliquez avec le bouton droit sur son icône et sélectionnez Supprimer le point d'arrêt.

Modifier

Vous pouvez modifier la configuration d'un point d'arrêt à tout moment, y compris pendant les sessions de test. Si vous modifiez des points d'arrêt durant une session de test, les modifications persistent même après la fin de celle-ci. Vous pouvez également modifier un point d'arrêt qui met activement en pause votre session de test, mais les changements ne s'appliquent qu'à la prochaine session de test.

Pour modifier un point d'arrêt :

1. Cliquez avec le bouton droit sur l'icône du point d'arrêt et sélectionnez Modifier le point d'arrêt.

2. Dans la fenêtre Modifier le point d'arrêt, configurez le point d'arrêt comme souhaité. Vous pouvez combiner ces configurations pour mieux répondre à vos besoins de débogage.

   Option	Description
   Condition	Une expression facultative qui détermine si le point d'arrêt s'active. Si la condition est vide, le point d'arrêt s'active toujours. Si la condition existe, le point d'arrêt devient un point d'arrêt conditionnel et s'active uniquement si la condition est vraie. Par exemple, si vous souhaitez que le point d'arrêt s'active uniquement si la variable var est égale à 10, définissez la condition sur var == 10.
   Message de journal	Une expression qui s'imprime dans la fenêtre Sortie lorsque le point d'arrêt est atteint. Le format du message de journal est le même que celui d'une instruction print(). Par exemple, définissez le message de journal comme "La valeur de var:", var pour afficher le même message que print("La valeur de var:", var).
   Continuer l'exécution	Détermine si le point d'arrêt met le script en pause s'il s'active. Cette option est désactivée par défaut, sauf si le point d'arrêt inséré est un logpoint.
   Supprimer le point d'arrêt sur hit	Si cochée, le point d'arrêt se supprime automatiquement après la première session de test, le rendant effectivement un point d'arrêt temporaire.
   Déclencher à	Le contexte d'un point d'arrêt détermine s'il doit s'activer sur le Client (scripts côté client), Serveur (scripts côté serveur), ou Édition (débogage de scripts plugin). Si vous choisissez Contexte personnalisé, la fenêtre indique les contextes de déclenchement actuels.

Workflow

Le workflow typique pour le débogage par points d'arrêt est le suivant :

1. Ouvrez le script que vous souhaitez déboguer et insérez des points d'arrêt sur les lignes de code que vous souhaitez examiner.

2. À partir de la mezzanine de Studio, initiez une session de test pour commencer à déboguer.

   

3. Lorsque le script atteint un point d'arrêt, la session de test met en pause sauf si ce point d'arrêt est configuré pour continuer l'exécution. Une flèche jaune au-dessus du point d'arrêt indique quelle ligne de code s'exécute ensuite.

   

4. Pendant que le script est en pause, inspectez la fenêtre Points d'arrêt, la fenêtre Surveiller, la fenêtre Pile d'appels, la fenêtre Sortie et l'éditeur de scripts pour trouver des informations sur les valeurs des variables et les exécutions de fonctions.

5. Pour continuer à exécuter le code après avoir atteint un point d'arrêt, cliquez sur Reprendre les scripts dans la mezzanine.

   

   Vous pouvez également exécuter le code ligne par ligne avec les boutons de pas dans la mezzanine :

   

   Action	Raccourci	Description
   Pas dans	F11	Le bouton Pas dans déplace le débogueur dans le code de la fonction à la ligne actuelle. S'il n'y a pas de fonction à la ligne actuelle, le débogueur se déplace vers la ligne suivante.
   Pas au-dessus	F10	Le bouton Pas au-dessus déplace le débogueur vers la ligne de code suivante, sans entrer dans les fonctions.
   Pas dehors	ShiftF11	Le bouton Pas dehors déplace le débogueur hors de la fonction actuelle et vers la ligne de code suivante après l'appel de la fonction. Si la ligne actuelle n'est pas à l'intérieur d'une fonction, le débogueur se déplace vers la ligne suivante.

6. Une fois que vous avez terminé de déboguer la session actuelle, cliquez sur le bouton Arrêter.

   

Surveillance

Studio comprend plusieurs fenêtres et outils pour surveiller les valeurs des variables et les exécutions de fonctions pendant le débogage. Avec ces informations, vous pouvez trouver la cause profonde de la plupart des problèmes dans vos scripts.

Points d'arrêt

La fenêtre Points d'arrêt est une vue unifiée qui montre tous les points d'arrêt dans tous les scripts. Pour l'ouvrir, cliquez sur Points d'arrêt dans la barre d'outils de l'onglet Script de Studio, ou allez dans le menu Fenêtre ⟩ Débogage et activez Points d'arrêt.

Dans la fenêtre, les colonnes Script et Ligne affichent toujours, et vous pouvez activer/désactiver d'autres colonnes de configuration via le menu ⋮ dans le coin supérieur droit. Dans la colonne Script, cliquez avec le bouton droit sur tout point d'arrêt pour révéler un menu d'options pour modifier, désactiver/activer, supprimer, ou sauter à la ligne du point d'arrêt dans le script.

Lors d'une session de débogage, la colonne la plus à gauche montre (x3) qui indique les multiples contextes (Client, Serveur, Édition) pour le point d'arrêt. En développant la branche de tout point d'arrêt, vous pouvez ensuite cliquer sur l'icône à côté d'un contexte spécifique pour désactiver/activer ce point d'arrêt pour ce contexte, comme désactiver un point d'arrêt uniquement dans le contexte Client tout en le maintenant actif dans le contexte Serveur.

Pile d'appels

La fenêtre Pile d'appels, accessible depuis la barre d'outils de l'onglet Script de Studio ou dans le menu Fenêtre ⟩ Débogage, montre quelle ligne de code va s'exécuter ensuite lorsque le débogueur atteint un point d'arrêt. Si vous appelez des fonctions depuis d'autres fonctions, elle indique quelles lignes ces fonctions ont été appelées, vous permettant de confirmer si le flux d'appel réel correspond à celui attendu.

Alors que le script est en pause à des points d'arrêt, utilisez les boutons de pas dans la mezzanine pour entrer, survoler ou sortir d'une fonction/ligne comme décrit dans le workflow.

Surveiller

La fenêtre Surveiller, accessible depuis la barre d'outils de l'onglet Script de Studio ou dans le menu Fenêtre ⟩ Débogage, vous permet de surveiller activement les valeurs des variables et des expressions pendant que vous vous déplacez à travers les points d'arrêt.

L'onglet Variables montre des informations sur les variables actuelles dans le scope, filtrables en cliquant sur le bouton Tous les Scopes dans la barre supérieure de la fenêtre. En développant une branche, vous voyez les membres de cette variable ou instance et leurs valeurs. Vous pouvez également surveiller n'importe quelle variable en la mettant en surbrillance dans l'éditeur de script, en cliquant avec le bouton droit et en sélectionnant Ajouter Surveillance dans le menu contextuel.

Éditeur de script

Le débogueur est intégré dans l'éditeur de script. Lorsque votre expérience est en pause à un point d'arrêt dans un script, vous pouvez survoler le nom d'une variable pour voir sa valeur. Par exemple, vous pouvez voir la composition d'un tableau et ses clés/valeurs contenues.

Outils de débogage supplémentaires

En plus du débogueur, Studio propose des outils de débogage supplémentaires pour vous aider à résoudre les problèmes et les bugs dans votre expérience.

Barre de commandes

La barre de commandes vous permet d'exécuter des commandes Luau pendant que l'expérience est en cours d'exécution. Elle est disponible dans Studio à partir du menu Fenêtre ⟩ Script et dans la console développeur.

Console développeur

La console développeur fournit une large gamme de détails, y compris la sortie client et serveur, l'utilisation de la mémoire, les performances du réseau, et plus encore. Pour ouvrir la console pendant le test ou le jeu d'une expérience, tapez /console dans le chat ou appuyez sur F9.

Fichiers journaux

Lorsqu'un script imprime ou génère une erreur dans Studio ou l'application joueur, l'application enregistre le message dans un fichier journal sur le système de fichiers local. Ces fichiers se trouvent à des endroits différents en fonction du système d'exploitation.

Windows

Pour accéder aux fichiers journaux sur Windows :

1. Ouvrez Explorateur de fichiers.
2. Accédez au répertoire %LOCALAPPDATA%\Roblox\logs.
3. Double-cliquez sur un journal pour l'ouvrir. Les journaux avec la même valeur XXXXX proviennent de la même session de Studio.

Mac

Pour accéder aux fichiers journaux sur Mac :

1. Ouvrez Finder.
2. Dans la barre de menu, sélectionnez Aller ⟩ Aller au dossier....
3. Dans la boîte de dialogue, entrez ~/Library/Logs/Roblox.
4. Double-cliquez sur le résultat pour accéder au répertoire des journaux Roblox.
5. À l'intérieur du répertoire, double-cliquez sur un journal pour l'ouvrir.

iOS

Vous pouvez collecter des journaux iOS en utilisant un Mac ou un appareil iOS.

Pour accéder aux fichiers journaux iOS sur un Mac :

1. Connectez l'appareil iOS à un Mac.
2. Ouvrez Finder.
3. Accédez à Utilitaires et ouvrez l'application Console.
4. Pour peupler les journaux en temps réel dans l'application Console, sélectionnez l'appareil iOS dans la barre latérale, cliquez sur le bouton Démarrer, et reproduisez le problème sur l'appareil iOS.
5. Pour peupler les journaux archivés dans l'application Console, exécutez sudo log collect --device-name "[Nom de l'appareil iOS]" dans le Terminal. Assurez-vous qu'il n'y ait pas d'apostrophes dans le nom de l'appareil, sinon vous pourriez obtenir une erreur lors de l'exécution de la commande.

Android

Pour accéder aux fichiers journaux sur Android :

1. Accédez à Réglages ⟩ Système ⟩ Options de développement.
2. Activez les Options de développement.
3. Sur un ordinateur, téléchargez et installez Android Studio.
4. Dans Android Studio, cliquez sur Logcat.
5. Connectez l'appareil Android à l'ordinateur pour peupler automatiquement Logcat avec les journaux.