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（應用程式介面）是 Godot 為使用者提供的內容的索引。它簡要概述了存在哪些類別、它們之間的關係、它們具有哪些功能以及如何使用它們。
繼承¶
在每個檔案的頂部，您將看到類別的名稱。
「繼承」部分列出了目前繼承的每個類別。這裡``CanvasItem``繼承了``Node``，Node``繼承了``Object。
「繼承者」部分列出了直接繼承目前類別的每個類別。這裡「Control」和「Node2D」都繼承了「CanvasItem」。
說明¶
接下來簡單介紹一下該類別。此文字出現在 Godot 編輯器彈出視窗中，用於建立節點、資源和其他型別。
說明¶
接下來更詳細地描述該類別、其功能及其用例。
你可以在這裡找到：
類的具體原理。
常見用法的程式碼範例。
適用於類中所有方法的用法細節。
關於必要依賴項或配置的警告。
和 Godot API 其他部分的連結。
教學¶
然後，該頁面提供指向手冊中提到或使用目前類別的部分的連結。
屬性¶
屬性表列出了屬於該類別的每個實例的變量，也稱為“屬性”。
左列包含屬性的資料型別。該文字也是該資料型別的 Godot API 頁面的連結。
中心列包含屬性的名稱。該文字也是指向該屬性在頁面上的完整描述的連結。使用此名稱取得屬性的資料或為其設定新值。
右列包含屬性的預設值。若要使用不同的值對其進行初始化，您必須透過腳本或屬性面板設定不同的值。
方法¶
方法表列出了屬於該類別的每個實例的函式，也稱為「方法」。
左列包含方法傳回值的資料型別。
右列包含方法的名稱、參數和限定符。名稱是左括號之前的文字。它也是頁面上該方法的完整描述的連結。使用該名稱來呼叫該方法。
對於每個參數，該頁面詳細介紹了其資料型別、名稱和預設值（如果有）。
可能的預選賽包括...
const：該方法不會更改類別實例中的任何資料。virtual：該方法什麼也不做，只是等待腳本覆蓋它。對每個索引鍵雜湊任意次。
訊號¶
訊號列表詳細介紹了向其他類別實例「發出」遊戲狀態變化訊號的事件的名稱和參數。
與方法表一樣，任何參數都將包含其資料型別和名稱。
每個訊號還詳細說明了該訊號何時發出。
列舉¶
列舉列表詳細說明了與目前類別關聯的可列舉資料型別。
對於每個列舉，該頁面都會說明其名稱，然後列出其可能的值。
對於每個列舉值，頁面都會說明其名稱、整數值以及其用例和/或影響的說明。
常數¶
常數列表詳細介紹了目前類別中命名的整型常數。
例和/或影響的解釋。
「NOTIFICATION_*」常數的描述將說明哪個引擎事件觸發通知。
屬性說明¶
屬性描述列表詳細介紹了每個屬性的所有資訊。
name 是要加入屬性面板中的分類別名稱稱；
Godot API 中的每個屬性都會綁定到一對 setter 和 getter 函式。使用其中任何一個都是等效的。它們列在這裡。
以下是屬性資料所代表的內容、其用例和/或更改它的影響的詳細摘要。它可能包括程式碼範例和/或指向 Godot API 相關部分的連結。
備註
當必須將方法名稱或 Callable<class_Callable>` 綁定到某物時，了解 setter 和 getter 名稱非常有用。
方法說明¶
方法描述列表詳細介紹了每種方法的所有內容。
它重申了方法的傳回資料型別、參數名稱/型別/預設值和限定符。
以下是該方法的用途及其用例的詳細摘要。它可能包括程式碼範例和/或指向 Godot API 相關部分的連結。