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 引擎的腳本編輯器是一個強大且完整整合的文字編輯器,它不僅簡化了撰寫和偵錯 GDScript 程式碼的流程,還允許處理純文字檔案,為開發者提供一個無縫的環境來編寫遊戲邏輯和行為腳本。它可以高亮您的程式碼、自動縮排、執行語法檢查等等。您還可以建立中斷點來偵錯您的專案,而無需切換到其他視窗。此文字編輯器也作為離線的類別參考檢視器,可以透過多種方式存取,詳情請參閱 如何撰寫類別參照文件

../../_images/text_editor.webp

功能

以下列出文本編輯器的一些主要功能:

  • 完整整合的 GDScript 程式碼編輯器。

  • 支援 GDScript 和 JSON 檔案的語法高亮度顯示。

  • GDScript 和 JSON 檔案的語法檢查。

  • 書籤與中斷點支援。

  • 自動縮排。

  • 程式碼摺疊。

  • 可自訂佈景主題。

  • 多重游標,可以使用 Alt + 左鍵點擊 來啟用。

  • 變數、函式、常數等的自動完成。

  • 選取符號後使用 Ctrl + D 進行符號的行內重構。

  • 跨專案檔案大量尋找並取代。

用法

如果您在專案中使用 GDScript,Godot 內建的文字編輯器提供了您所需的一切,作為充分利用 Godot 引擎的一站式地點。幾乎所有可以透過使用者介面調整的參數,也可以直接透過程式碼修改。

備註

如果您想要使用外部文字編輯器,或者偏好在專案中使用 C#,請參閱 使用外部文字編輯器設定外部編輯器

小訣竅

如同 Godot 介面的許多部分,文字編輯器也能透過更改設定來客製化成您喜歡的樣子。您可以透過開啟 編輯器 > 編輯器設定 並前往 文字編輯器 群組來存取這些設定。

../../_images/editor_ui_script_editor_open.webp

您可以使用工作區選擇器中的 Script 按鈕來開啟腳本編輯器,該按鈕位於 Godot 介面頂部中央。或者,您可以使用場景樹停靠面板中節點旁的 開啟腳本 按鈕,或在檔案系統停靠面板中雙擊 .gd 檔案或受辨識的文字檔案,以直接在腳本編輯器中開啟它。

../../_images/editor_ui_script_editor_menu.webp

開啟後,您會在頂部、場景切換器下方看到文字編輯器的選單。選單旁邊是開啟線上文件或在內建類別參考中搜尋的按鈕。這些按鈕的右邊是兩個導覽箭頭,可讓您瀏覽檢視歷史記錄。最後,您可以使用浮動按鈕將文字編輯器從 Godot 視窗分離出來,這在您使用多個螢幕時非常有用。

在左側選單下方,您會看到腳本面板。在中央,與腳本面板相鄰的是程式碼編輯區。程式碼編輯區下方是狀態列,它會顯示程式碼中的錯誤和警告計數。點擊錯誤或警告圖示將會顯示包含行號的錯誤列表。點擊其中一個錯誤將會跳到該行。您也可以選擇忽略警告,方法是開啟列表並點擊 Ignore 。狀態列也允許您透過點擊百分比數值來更改程式碼的縮放比例。您也可以使用 Ctrl + 滑鼠滾輪 (Cmd + 滑鼠滾輪 在 Mac 上) 來達到相同的效果。狀態列也會顯示游標目前的行號和列號,以及縮排是使用 Tab 鍵還是空格。

文字編輯器中執行的許多動作也可以使用快速鍵來執行。動作旁邊會顯示其對應的快速鍵。如需完整的快速鍵列表,請參閱 文字編輯器快速鍵

在接下來的章節中,我們將介紹文字編輯器的不同面向。您也可以選擇以下章節跳到特定主題:

腳本面板

../../_images/editor_ui_script_editor_script_panel.webp

在選單下方,左側面板中,您會看到開啟的檔案和文件頁面列表。根據檔案類型,此列表中的檔案名稱旁會帶有圖示。例如, 腳本 圖示表示它是 GDScript; C# 腳本 表示它是 C# 腳本; 說明文件 表示這是內建類別參考. 最後, 工具腳本 表示它是一個目前正在執行的工具腳本(關於此內容的更多資訊,請參閱 tool annotation ). 將滑鼠懸停在檔案上會顯示一個工具提示,其中包含其在專案資料夾中的相對路徑。

在狀態列上,點擊向左箭頭會隱藏腳本面板,點擊向右箭頭則會顯示它。

如果您沒有更改任何設定,檔案名稱的顏色可能也會不同。這能幫助您透過醒目提示來識別最近編輯過的檔案。您可以在 編輯器 > 編輯器設定 中,調整 文字編輯器 區段裡的 腳本溫度 屬性來更改此行為。

檔案名稱上方的篩選器提供方便的、不區分大小寫的搜尋功能,以尋找特定檔案。即使您只在篩選器中輸入檔案名稱的字母,包含這些依序字母的檔案也會出現。假設列表中有名為 button.gd 的檔案。如果您在篩選器中輸入 btn,此檔案將會出現在結果中。要重設篩選器,請清除篩選器內容。

檔案名稱旁的星號 (*) 表示該檔案有未儲存的變更。

小訣竅

如果您在篩選器列中只輸入 "*",您可以顯示所有未儲存的檔案。

您可以拖曳檔案來更改順序。中鍵點擊檔案會關閉它。右鍵點擊檔案會提供儲存或關閉檔案,或複製檔案相對路徑等多個選項。在這個選單中:

您也可以使用 向上移動向下移動 來更改檔案順序,或使用 排序 來依字母順序排列所有檔案。切換腳本面板 會隱藏面板,您可以之後使用狀態列上的向右箭頭再次顯示它。關閉文件 會關閉所有開啟的內建參考文件,只留下腳本檔案開啟。在檔案系統中顯示 會在檔案系統停靠區中尋找並醒目提示該檔案。

在檔案列表下方,您會看到目前開啟的檔案名稱。此名稱旁的按鈕可以切換此檔案中定義的方法的排序方式,在字母順序和出現順序之間切換。下方是檔案的大綱。如果這是腳本檔案,它將包含已定義的方法列表。然而,如果開啟的是類別參考頁面,此區域將顯示此文件的目錄。點擊此列表中的項目將跳轉到檔案中對應的函式或段落。同樣地,「篩選方法」列可讓您在選定的文件中搜尋特定的函式或段落,其行為與篩選腳本相同。

程式碼編輯區

備註

本節僅涵蓋程式碼編輯區在使用者介面方面的基礎知識。若要深入了解 Godot 的腳本功能,請參閱 GDScriptScripting 文件。

../../_images/editor_ui_script_editor_coding_area.webp

程式碼編輯區是您在使用內建文字編輯器時輸入腳本的地方。它提供語法高亮和自動完成功能,以協助您編寫程式碼。

程式碼編輯區會在左側顯示行號。在右側的導覽箭頭下方,有一個可點擊的迷你地圖,提供整個腳本的概覽,讓您可以捲動瀏覽。

如果程式碼行夠長(預設超過 80 個字元),文字編輯器會顯示一條垂直線作為柔性參考線。至於硬性參考線,預設值是 100 個字元。這兩個數值都可以更改,或者可以在文字編輯器的「外觀」設定中切換顯示這條線。

在腳本中,函數定義的左側您可能會看到額外的圖示。 覆寫 圖示表示此函數是現有函數的 override。點擊它會開啟原始函數的說明文件。 接收器 圖示表示它是一個信號的接收方法。點擊它會顯示信號的來源。行首的 可摺疊 圖示表示這是一個可摺疊的區塊。您可以點擊來收合或展開它。或者,也可以點擊省略符號 (...) 圖示來展開已收合的區塊。

下面的範例總結了上面的段落。第 52、56 和 58 行是可摺疊區塊,第 57 行是名為「New Code Region」的程式碼區域(您也可以摺疊它),而第 62 行是已摺疊區塊。第 53 行是書籤,可以使用 前往 > 書籤 選單快速跳轉。第 55 行是中斷點,可用於 debugging

../../_images/text_editor_coding_area_indicators.webp

文字編輯器的許多顏色都可以自訂,例如醒目提示顏色,甚至是中斷點或書籤圖示的顏色。您可以開啟文字編輯器設定進行實驗,路徑為 編輯器 > 編輯器設定 > 文字編輯器 區段。