Depuração

O Studio oferece muitas ferramentas e fluxos de trabalho de depuração comumente encontrados em Ambientes de Desenvolvimento Integrados (IDEs). Essas ferramentas ajudam você a inspecionar e resolver erros em scripts enquanto eles são executados.

Depuração com Pontos de Interrupção

Pontos de interrupção são pontos de verificação que pausam ou "quebram" a execução de seus scripts em linhas específicas. Você pode usar as pausas para inspecionar e depurar seu jogo, assistir variáveis e inspecionar a pilha de chamadas. Pontos de interrupção são uma das maneiras mais eficazes de depurar funções, portanto, são uma das ferramentas de depuração mais importantes.

Gerenciamento

No Editor de Scripts, você pode inserir vários tipos de pontos de interrupção e editar a configuração de um ponto de interrupção a qualquer momento, incluindo durante sessões de teste. Se você editar pontos de interrupção durante uma sessão de teste, as edições persistem mesmo após você terminá-la. Você também pode editar um ponto de interrupção que está pausando ativamente sua sessão de teste, mas as alterações não se aplicam até a próxima sessão de teste.

Inserir

Pontos de interrupção têm várias variações e podem ser inseridos em qualquer linha de código executável da seguinte forma:

Para inserir um ponto de interrupção padrão em uma linha de código, clique na margem diretamente à direita do número da linha. Alternativamente, clique com o botão direito na margem e selecione Inserir Ponto de Interrupção. O ícone do ponto de interrupção aparece como um círculo vermelho.

Desativar

Para desativar temporariamente um ponto de interrupção sem excluí-lo, use qualquer um dos seguintes fluxos de trabalho:

• Clique no ícone do ponto de interrupção.
• Clique com o botão direito no ícone do ponto de interrupção e selecione Desativar Ponto de Interrupção.
• Edite o ponto de interrupção e altere a caixa de seleção Habilitado.

Um ponto de interrupção desativado aparece como uma versão vazia de seu ícone habilitado, por exemplo, um círculo vazio para um ponto de interrupção padrão desativado, ou um losango vazio para um logpoint desativado.

Excluir

Para excluir um ponto de interrupção, clique com o botão do meio em seu ícone ou clique com o botão direito em seu ícone e selecione Excluir Ponto de Interrupção.

Editar

Você pode editar a configuração de um ponto de interrupção a qualquer momento, incluindo durante sessões de teste. Se você editar pontos de interrupção durante uma sessão de teste, as edições persistem mesmo após você terminá-la. Você também pode editar um ponto de interrupção que está pausando ativamente sua sessão de teste, mas as alterações não se aplicam até a próxima sessão de teste.

Para editar um ponto de interrupção:

1. Clique com o botão direito no ícone do ponto de interrupção e selecione Editar Ponto de Interrupção.

2. Na janela Editar Ponto de Interrupção, configure o ponto de interrupção conforme desejado. Você pode misturar essas configurações para melhor atender às suas necessidades de depuração.

   Opção	Descrição
   Condição	Uma expressão opcional que determina se o ponto de interrupção é ativado. Se a condição estiver vazia, o ponto de interrupção sempre é ativado. Se a condição existir, o ponto de interrupção se torna um ponto de interrupção condicional e é ativado apenas se a condição for verdadeira. Por exemplo, se você quiser que o ponto de interrupção seja ativado apenas se a variável var for igual a 10, defina a condição como var == 10.
   Mensagem de Log	Uma expressão que imprime na janela Saída quando o ponto de interrupção é atingido. O formato da mensagem de log é o mesmo que o de uma declaração print(). Por exemplo, defina a mensagem de log como "O valor de var:", var para gerar a mesma mensagem que print("O valor de var:", var).
   Continuar Execução	Determina se o ponto de interrupção pausa o script se for ativado. Esta opção está desativada por padrão, a menos que o ponto de interrupção inserido seja um logpoint.
   Remover Ponto de Interrupção ao Atingir	Se marcado, o ponto de interrupção se remove automaticamente após a primeira sessão de teste, efetivamente tornando-se um temporário ponto de interrupção.
   Ativar Em	O contexto de um ponto de interrupção determina se ele deve ser ativado no Cliente (scripts do lado do cliente), Servidor (scripts do lado do servidor) ou Edição (scripts de plugin de depuração). Se você escolher Contexto Personalizado, a janela indica os contextos de ativação atuais.

Fluxo de Trabalho

O fluxo de trabalho típico para depuração com pontos de interrupção é o seguinte:

1. Abra o script que você gostaria de depurar e insira pontos de interrupção nas linhas de código que você deseja examinar.

2. A partir do mezzanine do Studio, inicie um teste para começar a depurar.

   

3. Quando o script atinge um ponto de interrupção, a sessão de teste pausa a menos que esse ponto de interrupção esteja configurado para continuar a execução. Uma seta amarela sobre o ponto de interrupção indica qual linha de código será executada a seguir.

   

4. Enquanto o script está pausado, inspecione a janela Pontos de Interrupção, a janela Assistir, a janela Pilha de Chamadas, a janela Saída e o Editor de Scripts para encontrar informações sobre valores de variáveis e execuções de funções.

5. Para continuar executando o código após atingir um ponto de interrupção, clique em Retomar Scripts no mezzanine.

   

   Você também pode executar o código linha por linha com os botões de passo no mezzanine:

   

   Ação	Atalho	Descrição
   Passo Dentro	F11	O botão Passo Dentro move o depurador para o código da função na linha atual. Se não houver função na linha atual, o depurador se move para a próxima linha.
   Passo Sobre	F10	O botão Passo Sobre move o depurador para a próxima linha de código, não se movendo para dentro das funções.
   Passo Fora	ShiftF11	O botão Passo Fora move o depurador para fora da função atual e para a próxima linha de código após a chamada da função. Se a linha atual não estiver dentro de uma função, o depurador se move para a próxima linha.

6. Quando você terminar de depurar a sessão atual, clique no botão Parar.

   

Monitoramento

O Studio inclui várias janelas e ferramentas para monitorar valores de variáveis e execuções de funções enquanto depura. Com essas informações, você pode encontrar a causa raiz da maioria dos problemas em seus scripts.

Pontos de Interrupção

A janela Pontos de Interrupção é uma visão unificada que mostra todos os pontos de interrupção em todos os scripts. Para abri-la, clique em Pontos de Interrupção na barra de ferramentas da aba Script do Studio, ou navegue até o menu Janela ⟩ Depurar e ative Pontos de Interrupção.

Na janela, as colunas Script e Linha sempre são exibidas, e você pode ativar/desativar outras colunas de configuração através do menu ⋮ no canto superior direito. Dentro da coluna Script, clique com o botão direito em qualquer ponto de interrupção para revelar um menu de opções para editar, desativar/ativar, excluir ou pular para a linha do ponto de interrupção dentro do script.

Enquanto estiver em uma sessão de depuração, a coluna mais à esquerda mostra (x3) que indica os múltiplos contextos (Cliente, Servidor, Edição) para o ponto de interrupção. Ao expandir qualquer ramo de ponto de interrupção, você pode clicar no ícone ao lado de um contexto específico para desativar/ativar para esse contexto, como desativar um ponto de interrupção apenas no contexto Cliente enquanto o mantém ativado no contexto Servidor.

Pilha de Chamadas

A janela Pilha de Chamadas, acessível a partir da barra de ferramentas da aba Script do Studio ou do menu Janela ⟩ Depurar, mostra qual linha de código será executada a seguir quando o depurador atingir um ponto de interrupção. Se você chamar funções de dentro de outras funções, ela indica quais linhas essas funções foram chamadas, permitindo que você confirme se o fluxo de chamada real corresponde ao fluxo esperado.

À medida que o script pausa em pontos de interrupção, use os botões de passo no mezzanine para entrar, passar ou sair de uma função/linha, conforme descrito no fluxo de trabalho.

Assistir

A janela Assistir, acessível a partir da barra de ferramentas da aba Script do Studio ou do menu Janela ⟩ Depurar, permite que você assista ativamente os valores de variáveis e expressões enquanto avança pelos pontos de interrupção.

A aba Variáveis mostra informações sobre as variáveis atuais em escopo, filtráveis clicando no botão Todos Os Escopos na barra superior da janela. Expandir um ramo mostra os membros daquela variável ou instância e seus valores. Você também pode assistir a qualquer variável destacando-a duas vezes no Editor de Scripts, clicando com o botão direito e selecionando Adicionar Assistir no menu pop-up.

Editor de Scripts

O depurador está integrado ao Editor de Scripts. Quando seu jogo pausa em um ponto de interrupção em um script, você pode passar o mouse sobre o nome de uma variável para ver seu valor. Por exemplo, você pode ver a composição de uma tabela e suas chaves/valores contidos.

Ferramentas de depuração adicionais

Além do depurador, o Studio oferece ferramentas de depuração adicionais para você corrigir problemas e bugs em seu jogo.

Barra de Comandos

A Barra de Comandos permite que você execute comandos Luau enquanto o jogo está em execução. Ela está disponível no Studio no menu Janela ⟩ Script e no Console do Desenvolvedor.

Console do Desenvolvedor

O Console do Desenvolvedor fornece uma ampla gama de detalhes, incluindo saída do cliente e do servidor, uso de memória, desempenho de rede e mais. Para abrir o console enquanto testa ou joga um jogo, digite /console no chat ou pressione F9.

Arquivos de Log

Quando um script imprime ou gera erros no Studio ou no aplicativo do jogador, o aplicativo registra a mensagem em um arquivo de log no sistema de arquivos local. Esses arquivos estão localizados em lugares diferentes dependendo do sistema operacional.

Windows

Para acessar arquivos de log no Windows:

1. Abra o Explorador de Arquivos.
2. Navegue até o diretório %LOCALAPPDATA%\Roblox\logs.
3. Clique duas vezes em um log para abri-lo. Logs com o mesmo valor XXXXX são da mesma sessão do Studio.

Mac

Para acessar arquivos de log no Mac:

1. Abra o Finder.
2. Na barra de menu, selecione Ir ⟩ Ir para a Pasta....
3. No diálogo, insira ~/Library/Logs/Roblox.
4. Clique duas vezes no resultado para navegar até o diretório de logs do Roblox.
5. Dentro do diretório, clique duas vezes em um log para abri-lo.

iOS

Você pode coletar logs do iOS usando um Mac ou um dispositivo iOS.

Para acessar arquivos de log do iOS em um Mac:

1. Conecte o dispositivo iOS a um Mac.
2. Abra o Finder.
3. Navegue até Utilitários e abra o aplicativo Console.
4. Para preencher logs em tempo real no aplicativo Console, selecione o dispositivo iOS na barra lateral, clique no botão Iniciar e reproduza o problema no dispositivo iOS.
5. Para preencher logs arquivados no aplicativo Console, execute sudo log collect --device-name "[Nome do Dispositivo iOS]" no Terminal. Certifique-se de que não haja apóstrofes no nome do dispositivo ou você pode receber um erro ao executar o comando.

Android

Para acessar arquivos de log no Android:

1. Navegue até Ajustes ⟩ Sistema ⟩ Opções de Desenvolvedor.
2. Ative Opções de Desenvolvedor.
3. Em um computador, baixe e instale Android Studio.
4. No Android Studio, clique em Logcat.
5. Conecte o dispositivo Android ao computador para preencher automaticamente o Logcat com logs.