Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Como ler a API do Godot
Nesta página, você aprenderá a ler a referência de classes para a API do Godot.
A API, ou Interface de Programação de Aplicações, é um índice do que o Godot oferece aos usuários. Ela fornece um breve resumo de quais classes existem, como elas se relacionam entre si, quais recursos possuem e como usá-las.
Herança
No topo de cada arquivo, você verá o nome da classe.
A seção "Inherits" (Herda) lista cada classe que a classe atual herda. Aqui, CanvasItem herda de Node e Node herda de Object.
A seção "Inherited By" (Herdado Por) lista cada classe que herda diretamente a classe atual. Aqui, tanto Control quanto Node2D herdam de CanvasItem.
Breve descrição
Em seguida, há uma breve descrição da classe. Esse texto aparece nas janelas pop-up do Editor do Godot para a criação de Nós, Recursos e outros tipos.
Descrição
A seguir, há uma descrição mais detalhada da classe, de seus recursos e de seu(s) caso(s) de uso.
Coisas que você pode encontrar aqui:
Especificidades de como a classe funciona.
Exemplos de código para casos de uso comuns.
Detalhes de uso que são compartilhados entre cada um os métodos da classe.
Avisos sobre dependências ou configurações necessárias.
Links para outras partes relacionadas da API do Godot.
Tutoriais
A página então fornece links para partes do manual que mencionam ou fazem uso da classe atual.
Propriedades
A tabela Properties lista as variáveis que pertencem a cada instância da classe, também conhecidas como as "propriedades."
A coluna da esquerda contém o tipo de dados da propriedade. O texto também é um link para a página da API do Godot correspondente a esse tipo de dados.
A coluna central contém o nome da propriedade. O texto também é um link para a descrição completa dessa propriedade na página. Use esse nome para obter os dados da propriedade ou para definir um novo valor para ela.
A coluna da direita contém o valor padrão da propriedade. Para inicializá-la com um valor diferente, você deve definir um valor diferente via script ou pelo Inspetor.
Métodos
A tabela Methods lista as funções que pertencem a cada instância da classe, também conhecidas como os "métodos."
A coluna da esquerda contém o tipo de dados do valor de retorno do método.
A coluna da direita contém o nome, os parâmetros e os qualificadores do método. O nome é o texto antes do parêntese de abertura. Ele também é um link para a descrição completa do método na página. Use esse nome para chamar o método.
Para cada parâmetro, a página detalha seu tipo de dados, nome e valor padrão, se houver.
Os qualificadores possíveis incluem...
const: o método não altera nenhum dado na instância da classe.virtual: o método não faz nada além de esperar que um script o sobrescreva (override).vararg: o método pode aceitar um número arbitrário de argumentos.
Sinais
A lista de Sinais (Signals) detalha os nomes e parâmetros dos eventos que "sinalizam" uma mudança no estado do jogo para outras instâncias de classes.
Assim como na tabela de Métodos, quaisquer parâmetros incluirão seu tipo de dados e nome.
Cada sinal também possui uma explicação detalhada de quando ele é emitido.
Enumerações
A lista de Enumerações (Enumerations) detalha os tipos de dados enumeráveis associados à classe atual.
Para cada enumeração, a página informa seu nome e, em seguida, lista seus valores possíveis.
Para cada valor de enumeração, a página informa seu nome, seu valor inteiro e uma explicação de seu(s) caso(s) de uso e/ou efeitos.
Constantes
A lista de Constantes (Constants) detalha as constantes inteiras nomeadas na classe atual.
Para cada constante, a página informa seu nome, seu valor inteiro e uma explicação de seu(s) caso(s) de uso e/ou efeitos.
As descrições das constantes NOTIFICATION_* indicarão qual evento do motor dispara a notificação.
Descrições de propriedades
A lista de Descrições de Propriedades detalha tudo sobre cada propriedade.
Ela reafirma o tipo de dado e o nome da propriedade.
Cada propriedade na API do Godot está vinculada a um par de funções setter e getter. O uso de qualquer uma delas é equivalente. Elas estão listadas aqui.
Abaixo disso, há um resumo detalhado do que os dados da propriedade representam, seu(s) caso(s) de uso e/ou os efeitos de alterá-los. Pode incluir exemplos de código e/ou links para partes relevantes da API do Godot.
Nota
Saber os nomes do setter e do getter é útil quando se precisa vincular o nome de um método ou um Callable a alguma coisa.
Descrições de métodos
A lista de Descrições de Métodos detalha tudo sobre cada método.
Ela reafirma o tipo de dados de retorno do método, nomes/tipos/padrões de parâmetros e qualificadores.
Abaixo disso, há um resumo detalhado do que o método faz e seu(s) caso(s) de uso. Pode incluir exemplos de código e/ou links para partes relevantes da API do Godot.