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...

如何阅读 Godot API

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

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

继承

../../_images/class_api_inheritance.webp

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

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

“派生”部分列出了所有直接继承自当前类的类，此处 Control 和 Node2D 都继承了 CanvasItem 。

简要描述

../../_images/class_api_brief_description.webp

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

描述

../../_images/class_api_description.webp

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

你可以在这里找到：

  1. 类的具体原理。

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

  3. 适用于类中所有方法