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.

EditorFeatureProfile

繼承: RefCounted < Object

編輯器功能配置,可用於禁用特定功能。

說明

編輯器功能配置可以用來禁用 Godot 編輯器的特定功能。當禁用時,這些功能將不會出現在編輯器中,從而使編輯器不那麼混亂。這個設定使編輯器更簡潔,在團隊中工作時。例如,遊戲美術和關卡設計師可以使用禁用腳本編輯器的功能配置,以避免意外地對他們不應該編輯的檔進行更改。

要視覺化地管理編輯器功能配置,請使用編輯器視窗頂部的編輯器 >管理功能配置...

方法

String

get_feature_name(feature: Feature)

bool

is_class_disabled(class_name: StringName) const

bool

is_class_editor_disabled(class_name: StringName) const

bool

is_class_property_disabled(class_name: StringName, property: StringName) const

bool

is_feature_disabled(feature: Feature) const

Error

load_from_file(path: String)

Error

save_to_file(path: String)

void

set_disable_class(class_name: StringName, disable: bool)

void

set_disable_class_editor(class_name: StringName, disable: bool)

void

set_disable_class_property(class_name: StringName, property: StringName, disable: bool)

void

set_disable_feature(feature: Feature, disable: bool)


列舉

enum Feature: 🔗

Feature FEATURE_3D = 0

3D 編輯器。如果禁用此功能,3D 編輯器將不顯示,但 3D 節點仍將顯示在“建立新 Node”對話方塊中。

Feature FEATURE_SCRIPT = 1

腳本分頁,它包含腳本編輯器和類引用流覽器。如果該功能被禁用,腳本分頁將不會顯示。

Feature FEATURE_ASSET_LIB = 2

The Asset Store tab. If this feature is disabled, the Asset Store tab won't display.

Feature FEATURE_SCENE_TREE = 3

場景樹編輯。如果禁用此功能,場景樹面板仍將可見,但將是唯讀的。

Feature FEATURE_NODE_DOCK = 4

已棄用: Replaced by the Signals and Groups docks.

節點面板。如果此功能被禁用,訊號和組將不可見,也不能從編輯器中修改。

Feature FEATURE_FILESYSTEM_DOCK = 5

檔案系統面板。如果禁用此功能,則檔案系統面板將不可見。

Feature FEATURE_IMPORT_DOCK = 6

匯入面板。如果禁用此功能,則匯入面板將不可見。

Feature FEATURE_HISTORY_DOCK = 7

歷史面板。如果禁用此功能,則歷史面板將不可見。

Feature FEATURE_GAME = 8

The Game tab, which allows embedding the game window and selecting nodes by clicking inside of it. If this feature is disabled, the Game tab won't display.

Feature FEATURE_SIGNALS_DOCK = 9

The Signals dock. If this feature is disabled, signals won't be visible and modifiable from the editor.

Feature FEATURE_GROUPS_DOCK = 10

The Groups dock. If this feature is disabled, groups won't be visible and modifiable from the editor.

Feature FEATURE_MAX = 11

代表 Feature 列舉的大小。


方法說明

String get_feature_name(feature: Feature) 🔗

返回指定功能 feature 的人類可讀名稱。


bool is_class_disabled(class_name: StringName) const 🔗

如果 class_name 指定的類被禁用,則返回 true。被禁用時,該類不會出現在“建立 Node”對話方塊中。


bool is_class_editor_disabled(class_name: StringName) const 🔗

如果對於由 class_name 指定的類別的編輯已停用,則回傳 true。停用時,該類別仍會顯示在新增節點對話框中,但選取繼承該類別的節點時,屬性檢視器將會是唯讀。


bool is_class_property_disabled(class_name: StringName, property: StringName) const 🔗

如果 property 在由 class_name 指定的類別中被停用,則回傳 true。當屬性被停用時,在選取繼承由 class_name 指定的類別的節點時,它將不會出現在屬性檢視器中。


bool is_feature_disabled(feature: Feature) const 🔗

如果 feature 被禁用,則返回 true。當一個功能被禁用時,它將從編輯器中完全消失。


Error load_from_file(path: String) 🔗

從檔案載入編輯器功能設定檔。該檔案必須遵循使用功能設定檔管理員的 Export 按鈕或 save_to_file() 方法取得的 JSON 格式。

注意: 透過使用者介面建立的功能設定檔從 feature_profiles 目錄加載,作為副檔名為 .profile 的檔案。可以使用EditorPaths.get_config_dir()找到編輯器設定資料夾。


Error save_to_file(path: String) 🔗

將編輯器功能設定檔儲存到JSON 格式的檔案。然後可以使用功能設定檔管理器的Import 按鈕或load_from_file() 方法匯入它。

注意: 透過使用者介面建立的功能設定檔會以副檔名為 .profile 的檔案保存在 feature_profiles 目錄中。可以使用EditorPaths.get_config_dir()找到編輯器設定資料夾。


void set_disable_class(class_name: StringName, disable: bool) 🔗

如果 disabletrue,則禁用 class_name 指定的類。禁用後,該類不會出現在“建立新 Node”對話方塊中。


void set_disable_class_editor(class_name: StringName, disable: bool) 🔗

If disable is true, disables editing for the class specified by class_name. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class.


void set_disable_class_property(class_name: StringName, property: StringName, disable: bool) 🔗

如果 disabletrue,則停用由 class_name 指定之類別中 property 的編輯功能。當一個屬性被停用時,在選取繼承自由 class_name 指定之類別的節點時,它將不會出現在屬性檢視器中。


void set_disable_feature(feature: Feature, disable: bool) 🔗

如果 disabletrue,則禁用 feature 中指定的編輯器功能。當一個功能被禁用時,它將從編輯器中完全消失。