Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 599a905250
Branches Tags
godot-docs
/
classes
/
class_editorfeatureprofile.rst

class_editorfeatureprofile.rst 13 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the EditorFeatureProfile.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_EditorFeatureProfile:
    8. 

  8. 

  9. EditorFeatureProfile
    10. 

  10. ====================
    11. 

  11. 

  12. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

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

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 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.
    20. 

  20. 

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

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`String<class_String>`           | :ref:`get_feature_name<class_EditorFeatureProfile_method_get_feature_name>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)**                                                                         |
    28. 

  28. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>`               | :ref:`is_class_disabled<class_EditorFeatureProfile_method_is_class_disabled>` **(** :ref:`String<class_String>` class_name **)** const                                                                                    |
    30. 

  30. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`bool<class_bool>`               | :ref:`is_class_editor_disabled<class_EditorFeatureProfile_method_is_class_editor_disabled>` **(** :ref:`String<class_String>` class_name **)** const                                                                      |
    32. 

  32. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`               | :ref:`is_class_property_disabled<class_EditorFeatureProfile_method_is_class_property_disabled>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property **)** const                            |
    34. 

  34. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`bool<class_bool>`               | :ref:`is_feature_disabled<class_EditorFeatureProfile_method_is_feature_disabled>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** const                                                             |
    36. 

  36. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_from_file<class_EditorFeatureProfile_method_load_from_file>` **(** :ref:`String<class_String>` path **)**                                                                                                      |
    38. 

  38. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_to_file<class_EditorFeatureProfile_method_save_to_file>` **(** :ref:`String<class_String>` path **)**                                                                                                          |
    40. 

  40. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | void                                  | :ref:`set_disable_class<class_EditorFeatureProfile_method_set_disable_class>` **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**                                                         |
    42. 

  42. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                                  | :ref:`set_disable_class_editor<class_EditorFeatureProfile_method_set_disable_class_editor>` **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**                                           |
    44. 

  44. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                                  | :ref:`set_disable_class_property<class_EditorFeatureProfile_method_set_disable_class_property>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property, :ref:`bool<class_bool>` disable **)** |
    46. 

  46. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                                  | :ref:`set_disable_feature<class_EditorFeatureProfile_method_set_disable_feature>` **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature, :ref:`bool<class_bool>` disable **)**                                  |
    48. 

  48. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. 

  50. Enumerations
    51. 

  51. ------------
    52. 

  52. 

  53. .. _enum_EditorFeatureProfile_Feature:
    54. 

  54. 

  55. .. _class_EditorFeatureProfile_constant_FEATURE_3D:
    56. 

  56. 

  57. .. _class_EditorFeatureProfile_constant_FEATURE_SCRIPT:
    58. 

  58. 

  59. .. _class_EditorFeatureProfile_constant_FEATURE_ASSET_LIB:
    60. 

  60. 

  61. .. _class_EditorFeatureProfile_constant_FEATURE_SCENE_TREE:
    62. 

  62. 

  63. .. _class_EditorFeatureProfile_constant_FEATURE_IMPORT_DOCK:
    64. 

  64. 

  65. .. _class_EditorFeatureProfile_constant_FEATURE_NODE_DOCK:
    66. 

  66. 

  67. .. _class_EditorFeatureProfile_constant_FEATURE_FILESYSTEM_DOCK:
    68. 

  68. 

  69. .. _class_EditorFeatureProfile_constant_FEATURE_MAX:
    70. 

  70. 

  71. enum **Feature**:
    72. 

  72. 

  73. - **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.
    74. 

  74. 

  75. - **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.
    76. 

  76. 

  77. - **FEATURE_ASSET_LIB** = **2** --- The AssetLib tab. If this feature is disabled, the AssetLib tab won't display.
    78. 

  78. 

  79. - **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.
    80. 

  80. 

  81. - **FEATURE_IMPORT_DOCK** = **4** --- The Import dock. If this feature is disabled, the Import dock won't be visible.
    82. 

  82. 

  83. - **FEATURE_NODE_DOCK** = **5** --- The Node dock. If this feature is disabled, signals and groups won't be visible and modifiable from the editor.
    84. 

  84. 

  85. - **FEATURE_FILESYSTEM_DOCK** = **6** --- The FileSystem dock. If this feature is disabled, the FileSystem dock won't be visible.
    86. 

  86. 

  87. - **FEATURE_MAX** = **7** --- Represents the size of the :ref:`Feature<enum_EditorFeatureProfile_Feature>` enum.
    88. 

  88. 

  89. Method Descriptions
    90. 

  90. -------------------
    91. 

  91. 

  92. .. _class_EditorFeatureProfile_method_get_feature_name:
    93. 

  93. 

  94. - :ref:`String<class_String>` **get_feature_name** **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)**
    95. 

  95. 

  96. Returns the specified ``feature``'s human-readable name.
    97. 

  97. 

  98. ----
    99. 

  99. 

  100. .. _class_EditorFeatureProfile_method_is_class_disabled:
    101. 

  101. 

  102. - :ref:`bool<class_bool>` **is_class_disabled** **(** :ref:`String<class_String>` class_name **)** const
    103. 

  103. 

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

  105. 

  106. ----
    107. 

  107. 

  108. .. _class_EditorFeatureProfile_method_is_class_editor_disabled:
    109. 

  109. 

  110. - :ref:`bool<class_bool>` **is_class_editor_disabled** **(** :ref:`String<class_String>` class_name **)** const
    111. 

  111. 

  112. 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.
    113. 

  113. 

  114. ----
    115. 

  115. 

  116. .. _class_EditorFeatureProfile_method_is_class_property_disabled:
    117. 

  117. 

  118. - :ref:`bool<class_bool>` **is_class_property_disabled** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property **)** const
    119. 

  119. 

  120. 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``.
    121. 

  121. 

  122. ----
    123. 

  123. 

  124. .. _class_EditorFeatureProfile_method_is_feature_disabled:
    125. 

  125. 

  126. - :ref:`bool<class_bool>` **is_feature_disabled** **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature **)** const
    127. 

  127. 

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

  129. 

  130. ----
    131. 

  131. 

  132. .. _class_EditorFeatureProfile_method_load_from_file:
    133. 

  133. 

  134. - :ref:`Error<enum_@GlobalScope_Error>` **load_from_file** **(** :ref:`String<class_String>` path **)**
    135. 

  135. 

  136. 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 :ref:`save_to_file<class_EditorFeatureProfile_method_save_to_file>` method.
    137. 

  137. 

  138. ----
    139. 

  139. 

  140. .. _class_EditorFeatureProfile_method_save_to_file:
    141. 

  141. 

  142. - :ref:`Error<enum_@GlobalScope_Error>` **save_to_file** **(** :ref:`String<class_String>` path **)**
    143. 

  143. 

  144. 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 :ref:`load_from_file<class_EditorFeatureProfile_method_load_from_file>` button.
    145. 

  145. 

  146. ----
    147. 

  147. 

  148. .. _class_EditorFeatureProfile_method_set_disable_class:
    149. 

  149. 

  150. - void **set_disable_class** **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**
    151. 

  151. 

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

  153. 

  154. ----
    155. 

  155. 

  156. .. _class_EditorFeatureProfile_method_set_disable_class_editor:
    157. 

  157. 

  158. - void **set_disable_class_editor** **(** :ref:`String<class_String>` class_name, :ref:`bool<class_bool>` disable **)**
    159. 

  159. 

  160. 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.
    161. 

  161. 

  162. ----
    163. 

  163. 

  164. .. _class_EditorFeatureProfile_method_set_disable_class_property:
    165. 

  165. 

  166. - void **set_disable_class_property** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` property, :ref:`bool<class_bool>` disable **)**
    167. 

  167. 

  168. 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``.
    169. 

  169. 

  170. ----
    171. 

  171. 

  172. .. _class_EditorFeatureProfile_method_set_disable_feature:
    173. 

  173. 

  174. - void **set_disable_feature** **(** :ref:`Feature<enum_EditorFeatureProfile_Feature>` feature, :ref:`bool<class_bool>` disable **)**
    175. 

  175. 

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

  177.