Documentation
¶
Overview ¶
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.
Index ¶
- type Advanced
- type Any
- type Extension
- type Feature
- type ID
- type Instance
- func (self Instance) AsEditorFeatureProfile() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) GetFeatureName(feature Feature) string
- func (self Instance) ID() ID
- func (self Instance) IsClassDisabled(class_name string) bool
- func (self Instance) IsClassEditorDisabled(class_name string) bool
- func (self Instance) IsClassPropertyDisabled(class_name string, property string) bool
- func (self Instance) IsFeatureDisabled(feature Feature) bool
- func (self Instance) LoadFromFile(path string) error
- func (self Instance) SaveToFile(path string) error
- func (self Instance) SetDisableClass(class_name string, disable bool)
- func (self Instance) SetDisableClassEditor(class_name string, disable bool)
- func (self Instance) SetDisableClassProperty(class_name string, property string, disable bool)
- func (self Instance) SetDisableFeature(feature Feature, disable bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEditorFeatureProfile ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type Feature ¶
type Feature int //gd:EditorFeatureProfile.Feature
const ( // 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. Feature3d Feature = 0 // The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won't display. FeatureScript Feature = 1 // The AssetLib tab. If this feature is disabled, the AssetLib tab won't display. FeatureAssetLib Feature = 2 // Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only. FeatureSceneTree Feature = 3 // The Node dock. If this feature is disabled, signals and groups won't be visible and modifiable from the editor. FeatureNodeDock Feature = 4 // The FileSystem dock. If this feature is disabled, the FileSystem dock won't be visible. FeatureFilesystemDock Feature = 5 // The Import dock. If this feature is disabled, the Import dock won't be visible. FeatureImportDock Feature = 6 // The History dock. If this feature is disabled, the History dock won't be visible. FeatureHistoryDock Feature = 7 // 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. FeatureGame Feature = 8 // Represents the size of the [Feature] enum. FeatureMax Feature = 9 )
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.EditorFeatureProfile
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEditorFeatureProfile ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) GetFeatureName ¶
Returns the specified 'feature”s human-readable name.
func (Instance) IsClassDisabled ¶
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 (Instance) IsClassEditorDisabled ¶
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 (Instance) IsClassPropertyDisabled ¶
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 (Instance) IsFeatureDisabled ¶
Returns true if the 'feature' is disabled. When a feature is disabled, it will disappear from the editor entirely.
func (Instance) LoadFromFile ¶
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 SaveToFile 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.GetConfigDir.
func (Instance) SaveToFile ¶
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 LoadFromFile 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.GetConfigDir.
func (Instance) SetDisableClass ¶
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 (Instance) SetDisableClassEditor ¶
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 (Instance) SetDisableClassProperty ¶
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 (Instance) SetDisableFeature ¶
If 'disable' is true, disables the editor feature specified in 'feature'. When a feature is disabled, it will disappear from the editor entirely.
Source Files