Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
如何阅读 Godot API¶
在这个页面，你将学习如何阅读 Godot API 的类参考。
API，也就是应用(A)程序(P)接口(I),是 Godot 提供给用户的一个目录，提供了一些简要的信息，包括有那些类，如何找到它们，它们有哪些特性，以及如何使用它们。
继承¶
在每个文件的开头，你可以看到类的名称。
“继承”部分列出了当前的类继承了哪些类，此处 CanvasItem 继承自 Node 以及 Node 继承 自 Object 。
“派生”部分列出了所有直接继承自当前类的类，此处 Control 和 Node2D 都继承了 CanvasItem 。
简要描述¶
接下来是类的简要描述，这些文字会出现在 Godot 编辑器用于创建节点或其他类型的弹出窗口里。
描述¶
接下来是类更详细的描述，有哪些特性，以及使用示例。
你可以在这里找到：
类的具体原理。
常见用法的代码示例。
适用于类中所有方法的用法细节。
关于必要依赖项或配置的警告。
和 Godot API 其他部分的链接。
教程¶
这一页提供了用户手册中提到或使用了该类的链接。
属性¶
属性表列出了属于该类每个实例的变量
左边一列包含了属性的数据类型，同时文字也链接到了 Godot API 中有关该类型的页面。
中间一列包含了属性的名称，名称链接到了该属性完整描述的页面，可以使用属性的名称来获取属性对应的值或者将属性设置为新值。
右边一列包含了属性的默认值。要想将其初始化为不同的值，你需要通过代码或者检视器将其设置为不同的值。
方法¶
方法一栏列出了属于该类每个实例的函数
左侧一栏包含了方法返回值的类型。
右侧一列包含了方法的名称，参数和限定符。方法的名字就是括号前的文字，可以使用这个名字来调用方法，同时，该文字也链接到方法的完整描述。
对于每个属性，该页面详细给出了数据类型，名称，和默认值（如果有）。
一些可能包含的限定符...
const: 该方法不会改变类实例的任何数据。virtual: 该方法什么都不做，等待脚本重写。vararg: 方法可以接受任意数量的参数。
信号¶
信号列表详细介绍了向其他类实例“发出”游戏状态变化信号的事件的名称和参数。
和方法表一样，每个参数都包含其数据类型和名称。
每个信号也详细说明了其何时发出。
枚举¶
枚举列表详细说明了与当前类关联的可枚举数据类型。
对于每一个枚举，该页面说明了其名称，然后列出了可能的值。
对于每个枚举值，该页面都会说明其名称，对应的整数值，和其用例/或作用的解释。
常量¶
常量列表详细介绍了当前类中命名的整型常量。
对每个常量，该页面说明了其名称，整数值，和对其用例/或影响的解释。
NOTIFICATION_* 常量的描述将表明哪个引擎事件会触发通知。
属性说明¶
“属性说明”列表详细说明了每个属性的所有信息。
其重申了属性的数据类型和名称。
Godot API 中的每个属性都绑定了一对 setter 和 getter 函数，使用其中任何一个都是等效的。将其列在此处。
之后是每个属性数据代表的含义，其用例或改变它的影响的详细说明。此处可能包含代码示例或指向 Godot API 相关部分的链接。
备注
当必须将方法名称或 Callable 绑定到某物时，了解 setter 和 getter 名称非常有用。
方法描述¶
方法描述列表详细介绍了每个方法的所有内容。
它重申了方法的返回值类型，参数名称/类型/默认值/ ,以及限定符。
之后是方法的用途和用例的详细介绍。可能包含代码示例以及指向Godot API 相关部分的链接（有的话）。