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.

如何阅读 Godot API

在这个页面,你将学习如何阅读 Godot API 的类参考。

API,也就是应用(A)程序(P)接口(I),是 Godot 提供给用户的一个目录,提供了一些简要的信息,包括有那些类,如何找到它们,它们有哪些特性,以及如何使用它们。

继承

../../_images/class_api_inheritance.webp

在每个文件的开头,你可以看到类的名称。

“继承”部分列出了当前的类继承了哪些类,此处 CanvasItem 继承自 Node 以及 Node 继承 自 Object

“派生”部分列出了所有直接继承自当前类的类,此处 ControlNode2D 都继承了 CanvasItem

简要描述

../../_images/class_api_brief_description.webp

接下来是类的简要描述,这些文字会出现在 Godot 编辑器用于创建节点或其他类型的弹出窗口里。

描述

../../_images/class_api_description.webp

接下来是类更详细的描述,有哪些特性,以及使用示例。

你可以在这里找到:

  1. 类的具体原理。

  2. 常见用法的代码示例。

  3. 适用于类中所有方法的用法细节。

  4. 关于必要依赖项或配置的警告。

  5. 和 Godot API 其他部分的链接。

教程

../../_images/class_api_tutorials.webp

这一页提供了用户手册中提到或使用了该类的链接。

属性

../../_images/class_api_properties_table.webp

属性表列出了属于该类每个实例的变量

左边一列包含了属性的数据类型,同时文字也链接到了 Godot API 中有关该类型的页面。

中间一列包含了属性的名称,名称链接到了该属性完整描述的页面,可以使用属性的名称来获取属性对应的值或者将属性设置为新值。

右边一列包含了属性的默认值。要想将其初始化为不同的值,你需要通过代码或者检视器将其设置为不同的值。

方法

../../_images/class_api_methods_table.webp

方法一栏列出了属于该类每个实例的函数

左侧一栏包含了方法返回值的类型。

右侧一列包含了方法的名称,参数和限定符。方法的名字就是括号前的文字,可以使用这个名字来调用方法,同时,该文字也链接到方法的完整描述。

对于每个属性,该页面详细给出了数据类型,名称,和默认值(如果有)。

一些可能包含的限定符...

  • const: 该方法不会改变类实例的任何数据。

  • virtual: 该方法什么都不做,等待脚本重写。

  • vararg: