2
0

EditorScenePostImportPlugin.xml 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="EditorScenePostImportPlugin" inherits="RefCounted" version="4.0">
  3. <brief_description>
  4. Plugin to control and modifying the process of importing a scene.
  5. </brief_description>
  6. <description>
  7. 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.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="_get_import_options" qualifiers="virtual">
  13. <return type="void" />
  14. <description>
  15. Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced].
  16. </description>
  17. </method>
  18. <method name="_get_internal_import_options" qualifiers="virtual">
  19. <return type="void" />
  20. <argument index="0" name="category" type="int" />
  21. <description>
  22. Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced].
  23. </description>
  24. </method>
  25. <method name="_get_internal_option_update_view_required" qualifiers="virtual const">
  26. <return type="Variant" />
  27. <argument index="0" name="category" type="int" />
  28. <argument index="1" name="option" type="String" />
  29. <description>
  30. Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed.
  31. </description>
  32. </method>
  33. <method name="_get_internal_option_visibility" qualifiers="virtual const">
  34. <return type="Variant" />
  35. <argument index="0" name="category" type="int" />
  36. <argument index="1" name="option" type="String" />
  37. <description>
  38. Return true or false whether a given option should be visible. Return null to ignore.
  39. </description>
  40. </method>
  41. <method name="_get_option_visibility" qualifiers="virtual const">
  42. <return type="Variant" />
  43. <argument index="0" name="option" type="String" />
  44. <description>
  45. Return true or false whether a given option should be visible. Return null to ignore.
  46. </description>
  47. </method>
  48. <method name="_internal_process" qualifiers="virtual">
  49. <return type="void" />
  50. <argument index="0" name="category" type="int" />
  51. <argument index="1" name="base_node" type="Node" />
  52. <argument index="2" name="node" type="Node" />
  53. <argument index="3" name="resource" type="Resource" />
  54. <description>
  55. Process a specific node or resource for a given category.
  56. </description>
  57. </method>
  58. <method name="_post_process" qualifiers="virtual">
  59. <return type="void" />
  60. <argument index="0" name="scene" type="Node" />
  61. <description>
  62. Post process the scene. This function is called after the final scene has been configured.
  63. </description>
  64. </method>
  65. <method name="_pre_process" qualifiers="virtual">
  66. <return type="void" />
  67. <argument index="0" name="scene" type="Node" />
  68. <description>
  69. Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made.
  70. </description>
  71. </method>
  72. <method name="add_import_option">
  73. <return type="void" />
  74. <argument index="0" name="name" type="String" />
  75. <argument index="1" name="value" type="Variant" />
  76. <description>
  77. Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options].
  78. </description>
  79. </method>
  80. <method name="add_import_option_advanced">
  81. <return type="void" />
  82. <argument index="0" name="type" type="int" enum="Variant.Type" />
  83. <argument index="1" name="name" type="String" />
  84. <argument index="2" name="default_value" type="Variant" />
  85. <argument index="3" name="hint" type="int" enum="PropertyHint" default="0" />
  86. <argument index="4" name="hint_string" type="String" default="&quot;&quot;" />
  87. <argument index="5" name="usage_flags" type="int" default="7" />
  88. <description>
  89. Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options].
  90. </description>
  91. </method>
  92. <method name="get_option_value" qualifiers="const">
  93. <return type="Variant" />
  94. <argument index="0" name="name" type="StringName" />
  95. <description>
  96. Query the value of an option. This function can only be called from those querying visibility, or processing.
  97. </description>
  98. </method>
  99. </methods>
  100. <constants>
  101. <constant name="INTERNAL_IMPORT_CATEGORY_NODE" value="0" enum="InternalImportCategory">
  102. </constant>
  103. <constant name="INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE" value="1" enum="InternalImportCategory">
  104. </constant>
  105. <constant name="INTERNAL_IMPORT_CATEGORY_MESH" value="2" enum="InternalImportCategory">
  106. </constant>
  107. <constant name="INTERNAL_IMPORT_CATEGORY_MATERIAL" value="3" enum="InternalImportCategory">
  108. </constant>
  109. <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION" value="4" enum="InternalImportCategory">
  110. </constant>
  111. <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE" value="5" enum="InternalImportCategory">
  112. </constant>
  113. <constant name="INTERNAL_IMPORT_CATEGORY_MAX" value="6" enum="InternalImportCategory">
  114. </constant>
  115. </constants>
  116. </class>