Class EditorFeatureProfile
An editor feature profile which can be used to disable specific features.
- Inheritance
-
EditorFeatureProfile
Remarks
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
get_feature_name(int)
Returns the specified feature's human-readable name.
String get_feature_name(int feature)Parameters
featureint
is_class_disabled(StringName)
Qualifiers: const
Returns true if the class specified by class_name is disabled. When disabled, the class won't appear in the Create New Node dialog.
bool is_class_disabled(StringName class_name)Parameters
class_nameStringName
is_class_editor_disabled(StringName)
Qualifiers: const
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.
bool is_class_editor_disabled(StringName class_name)Parameters
class_nameStringName
is_class_property_disabled(StringName, StringName)
Qualifiers: const
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.
bool is_class_property_disabled(StringName class_name, StringName property)Parameters
class_nameStringNamepropertyStringName
is_feature_disabled(int)
Qualifiers: const
Returns true if the feature is disabled. When a feature is disabled, it will disappear from the editor entirely.
bool is_feature_disabled(int feature)Parameters
featureint
load_from_file(String)
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 EditorFeatureProfile.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 get_config_dir.
int load_from_file(String path)Parameters
pathString
save_to_file(String)
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 EditorFeatureProfile.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 get_config_dir.
int save_to_file(String path)Parameters
pathString
set_disable_class(StringName, bool)
If disable is true, disables the class specified by class_name. When disabled, the class won't appear in the Create New Node dialog.
void set_disable_class(StringName class_name, bool disable)Parameters
class_nameStringNamedisablebool
set_disable_class_editor(StringName, 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_editor(StringName class_name, bool disable)Parameters
class_nameStringNamedisablebool
set_disable_class_property(StringName, StringName, bool)
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.
void set_disable_class_property(StringName class_name, StringName property, bool disable)Parameters
class_nameStringNamepropertyStringNamedisablebool
set_disable_feature(int, bool)
If disable is true, disables the editor feature specified in feature. When a feature is disabled, it will disappear from the editor entirely.
void set_disable_feature(int feature, bool disable)