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（應用程式介面）是 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 相關部分的連結。