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: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_editorscenepostimportplugin.rst

class_editorscenepostimportplugin.rst 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177 
  1. :github_url: hide
    2. 

  2. 

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

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

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

  6. 

  7. .. _class_EditorScenePostImportPlugin:
    8. 

  8. 

  9. EditorScenePostImportPlugin
    10. 

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

  11. 

  12. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Plugin to control and modifying the process of importing a scene.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

  19. This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

  24. +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                          | :ref:`_get_import_options<class_EditorScenePostImportPlugin_method__get_import_options>` **(** :ref:`String<class_String>` path **)** |virtual|                                                                                                                                                                                                                                                         |
    26. 

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

  27. | void                          | :ref:`_get_internal_import_options<class_EditorScenePostImportPlugin_method__get_internal_import_options>` **(** :ref:`int<class_int>` category **)** |virtual|                                                                                                                                                                                                                                         |
    28. 

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

  29. | :ref:`Variant<class_Variant>` | :ref:`_get_internal_option_update_view_required<class_EditorScenePostImportPlugin_method__get_internal_option_update_view_required>` **(** :ref:`int<class_int>` category, :ref:`String<class_String>` option **)** |virtual| |const|                                                                                                                                                                   |
    30. 

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

  31. | :ref:`Variant<class_Variant>` | :ref:`_get_internal_option_visibility<class_EditorScenePostImportPlugin_method__get_internal_option_visibility>` **(** :ref:`int<class_int>` category, :ref:`String<class_String>` option **)** |virtual| |const|                                                                                                                                                                                       |
    32. 

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

  33. | :ref:`Variant<class_Variant>` | :ref:`_get_option_visibility<class_EditorScenePostImportPlugin_method__get_option_visibility>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` option **)** |virtual| |const|                                                                                                                                                                                                       |
    34. 

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

  35. | void                          | :ref:`_internal_process<class_EditorScenePostImportPlugin_method__internal_process>` **(** :ref:`int<class_int>` category, :ref:`Node<class_Node>` base_node, :ref:`Node<class_Node>` node, :ref:`Resource<class_Resource>` resource **)** |virtual|                                                                                                                                                    |
    36. 

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

  37. | void                          | :ref:`_post_process<class_EditorScenePostImportPlugin_method__post_process>` **(** :ref:`Node<class_Node>` scene **)** |virtual|                                                                                                                                                                                                                                                                        |
    38. 

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

  39. | void                          | :ref:`_pre_process<class_EditorScenePostImportPlugin_method__pre_process>` **(** :ref:`Node<class_Node>` scene **)** |virtual|                                                                                                                                                                                                                                                                          |
    40. 

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

  41. | void                          | :ref:`add_import_option<class_EditorScenePostImportPlugin_method_add_import_option>` **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**                                                                                                                                                                                                                                  |
    42. 

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

  43. | void                          | :ref:`add_import_option_advanced<class_EditorScenePostImportPlugin_method_add_import_option_advanced>` **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` default_value, :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hint=0, :ref:`String<class_String>` hint_string="", :ref:`int<class_int>` usage_flags=7 **)** |
    44. 

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

  45. | :ref:`Variant<class_Variant>` | :ref:`get_option_value<class_EditorScenePostImportPlugin_method_get_option_value>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                                                                                                                                                                                                                                         |
    46. 

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

  47. 

  48. Enumerations
    49. 

  49. ------------
    50. 

  50. 

  51. .. _enum_EditorScenePostImportPlugin_InternalImportCategory:
    52. 

  52. 

  53. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_NODE:
    54. 

  54. 

  55. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE:
    56. 

  56. 

  57. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MESH:
    58. 

  58. 

  59. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MATERIAL:
    60. 

  60. 

  61. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION:
    62. 

  62. 

  63. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE:
    64. 

  64. 

  65. .. _class_EditorScenePostImportPlugin_constant_INTERNAL_IMPORT_CATEGORY_MAX:
    66. 

  66. 

  67. enum **InternalImportCategory**:
    68. 

  68. 

  69. - **INTERNAL_IMPORT_CATEGORY_NODE** = **0**
    70. 

  70. 

  71. - **INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE** = **1**
    72. 

  72. 

  73. - **INTERNAL_IMPORT_CATEGORY_MESH** = **2**
    74. 

  74. 

  75. - **INTERNAL_IMPORT_CATEGORY_MATERIAL** = **3**
    76. 

  76. 

  77. - **INTERNAL_IMPORT_CATEGORY_ANIMATION** = **4**
    78. 

  78. 

  79. - **INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE** = **5**
    80. 

  80. 

  81. - **INTERNAL_IMPORT_CATEGORY_MAX** = **6**
    82. 

  82. 

  83. Method Descriptions
    84. 

  84. -------------------
    85. 

  85. 

  86. .. _class_EditorScenePostImportPlugin_method__get_import_options:
    87. 

  87. 

  88. - void **_get_import_options** **(** :ref:`String<class_String>` path **)** |virtual|
    89. 

  89. 

  90. Override to add general import options. These will appear in the main import dock on the editor. Add options via :ref:`add_import_option<class_EditorScenePostImportPlugin_method_add_import_option>` and :ref:`add_import_option_advanced<class_EditorScenePostImportPlugin_method_add_import_option_advanced>`.
    91. 

  91. 

  92. ----
    93. 

  93. 

  94. .. _class_EditorScenePostImportPlugin_method__get_internal_import_options:
    95. 

  95. 

  96. - void **_get_internal_import_options** **(** :ref:`int<class_int>` category **)** |virtual|
    97. 

  97. 

  98. Override to add internal import options. These will appear in the 3D scene import dialog. Add options via :ref:`add_import_option<class_EditorScenePostImportPlugin_method_add_import_option>` and :ref:`add_import_option_advanced<class_EditorScenePostImportPlugin_method_add_import_option_advanced>`.
    99. 

  99. 

  100. ----
    101. 

  101. 

  102. .. _class_EditorScenePostImportPlugin_method__get_internal_option_update_view_required:
    103. 

  103. 

  104. - :ref:`Variant<class_Variant>` **_get_internal_option_update_view_required** **(** :ref:`int<class_int>` category, :ref:`String<class_String>` option **)** |virtual| |const|
    105. 

  105. 

  106. Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed.
    107. 

  107. 

  108. ----
    109. 

  109. 

  110. .. _class_EditorScenePostImportPlugin_method__get_internal_option_visibility:
    111. 

  111. 

  112. - :ref:`Variant<class_Variant>` **_get_internal_option_visibility** **(** :ref:`int<class_int>` category, :ref:`String<class_String>` option **)** |virtual| |const|
    113. 

  113. 

  114. Return true or false whether a given option should be visible. Return null to ignore.
    115. 

  115. 

  116. ----
    117. 

  117. 

  118. .. _class_EditorScenePostImportPlugin_method__get_option_visibility:
    119. 

  119. 

  120. - :ref:`Variant<class_Variant>` **_get_option_visibility** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` option **)** |virtual| |const|
    121. 

  121. 

  122. Return true or false whether a given option should be visible. Return null to ignore.
    123. 

  123. 

  124. ----
    125. 

  125. 

  126. .. _class_EditorScenePostImportPlugin_method__internal_process:
    127. 

  127. 

  128. - void **_internal_process** **(** :ref:`int<class_int>` category, :ref:`Node<class_Node>` base_node, :ref:`Node<class_Node>` node, :ref:`Resource<class_Resource>` resource **)** |virtual|
    129. 

  129. 

  130. Process a specific node or resource for a given category.
    131. 

  131. 

  132. ----
    133. 

  133. 

  134. .. _class_EditorScenePostImportPlugin_method__post_process:
    135. 

  135. 

  136. - void **_post_process** **(** :ref:`Node<class_Node>` scene **)** |virtual|
    137. 

  137. 

  138. Post process the scene. This function is called after the final scene has been configured.
    139. 

  139. 

  140. ----
    141. 

  141. 

  142. .. _class_EditorScenePostImportPlugin_method__pre_process:
    143. 

  143. 

  144. - void **_pre_process** **(** :ref:`Node<class_Node>` scene **)** |virtual|
    145. 

  145. 

  146. Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made.
    147. 

  147. 

  148. ----
    149. 

  149. 

  150. .. _class_EditorScenePostImportPlugin_method_add_import_option:
    151. 

  151. 

  152. - void **add_import_option** **(** :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` value **)**
    153. 

  153. 

  154. Add a specific import option (name and default value only). This function can only be called from :ref:`_get_import_options<class_EditorScenePostImportPlugin_method__get_import_options>` and :ref:`_get_internal_import_options<class_EditorScenePostImportPlugin_method__get_internal_import_options>`.
    155. 

  155. 

  156. ----
    157. 

  157. 

  158. .. _class_EditorScenePostImportPlugin_method_add_import_option_advanced:
    159. 

  159. 

  160. - void **add_import_option_advanced** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`Variant<class_Variant>` default_value, :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hint=0, :ref:`String<class_String>` hint_string="", :ref:`int<class_int>` usage_flags=7 **)**
    161. 

  161. 

  162. Add a specific import option. This function can only be called from :ref:`_get_import_options<class_EditorScenePostImportPlugin_method__get_import_options>` and :ref:`_get_internal_import_options<class_EditorScenePostImportPlugin_method__get_internal_import_options>`.
    163. 

  163. 

  164. ----
    165. 

  165. 

  166. .. _class_EditorScenePostImportPlugin_method_get_option_value:
    167. 

  167. 

  168. - :ref:`Variant<class_Variant>` **get_option_value** **(** :ref:`StringName<class_StringName>` name **)** |const|
    169. 

  169. 

  170. Query the value of an option. This function can only be called from those querying visibility, or processing.
    171. 

  171. 

  172. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    173. 

  173. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    174. 

  174. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    175. 

  175. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    176. 

  176. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    177. 

  177. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    178.