Index · Object → RefCounted → EditorFeatureProfile

EditorFeatureProfile

An editor feature profile which can be used to disable specific features.

Class Description

An editor feature profile can be used to disable specific features of the Godot editor. When disabled, the features won't appear in the editor, which makes the editor less cluttered. This is useful in education settings to reduce confusion or when working in a team. For example, artists and level designers could use a feature profile that disables the script editor to avoid accidentally making changes to files they aren't supposed to edit.

To manage editor feature profiles visually, use Editor > Manage Feature Profiles... at the top of the editor window.

Methods

func get_feature_name(feature: EditorFeatureProfile.Feature) -> String

Returns the specified feature's human-readable name.

func is_class_disabled(class_name: StringName) -> bool

Returns true if the class specified by class_name is disabled. When disabled, the class won't appear in the Create New Node dialog.

func is_class_editor_disabled(class_name: StringName) -> bool

Returns true if editing for the class specified by class_name is disabled. 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.

func is_class_property_disabled(class_name: StringName, property: StringName) -> bool

Returns true if property is disabled in the class specified by class_name. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by class_name.

func is_feature_disabled(feature: EditorFeatureProfile.Feature) -> bool

Returns true if the feature is disabled. When a feature is disabled, it will disappear from the editor entirely.

func load_from_file(path: String) -> Error

Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's Export button or the save_to_file() method.

Note: Feature profiles created via the user interface are loaded from the feature_profiles directory, as a file with the .profile extension. The editor configuration folder can be found by using EditorPaths.get_config_dir().

func save_to_file(path: String) -> Error

Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's Import button or the load_from_file() method.

Note: Feature profiles created via the user interface are saved in the feature_profiles directory, as a file with the .profile extension. The editor configuration folder can be found by using EditorPaths.get_config_dir().

func set_disable_class(class_name: StringName, disable: bool) -> void

If disable is true, disables the class specified by class_name. When disabled, the class won't appear in the Create New Node dialog.

func set_disable_class_editor(class_name: StringName, disable: bool) -> void

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.

func set_disable_class_property(class_name: StringName, property: StringName, disable: bool) -> void

If disable is true, disables editing for property in the class specified by class_name. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by class_name.

func set_disable_feature(feature: EditorFeatureProfile.Feature, disable: bool) -> void

If disable is true, disables the editor feature specified in feature. When a feature is disabled, it will disappear from the editor entirely.

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

enum Feature
FEATURE_3D = 0

The 3D editor. If this feature is disabled, the 3D editor won't display but 3D nodes will still display in the Create New Node dialog.

FEATURE_SCRIPT = 1

The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won't display.

FEATURE_ASSET_LIB = 2

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

FEATURE_SCENE_TREE = 3

Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only.

FEATURE_NODE_DOCK = 4

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

FEATURE_FILESYSTEM_DOCK = 5

The FileSystem dock. If this feature is disabled, the FileSystem dock won't be visible.

FEATURE_IMPORT_DOCK = 6

The Import dock. If this feature is disabled, the Import dock won't be visible.

FEATURE_HISTORY_DOCK = 7

The History dock. If this feature is disabled, the History dock won't be visible.

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_SIGNALS_DOCK = 9

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

FEATURE_GROUPS_DOCK = 10

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

FEATURE_MAX = 11

Represents the size of the Feature enum.