class_editorexportplugin.rst 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the EditorExportPlugin.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_EditorExportPlugin:
  6. EditorExportPlugin
  7. ==================
  8. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A script that is executed when exporting projects.
  10. Methods
  11. -------
  12. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`_export_begin<class_EditorExportPlugin_method__export_begin>` **(** :ref:`PoolStringArray<class_PoolStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual |
  14. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`_export_end<class_EditorExportPlugin_method__export_end>` **(** **)** virtual |
  16. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`_export_file<class_EditorExportPlugin_method__export_file>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PoolStringArray<class_PoolStringArray>` features **)** virtual |
  18. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`add_file<class_EditorExportPlugin_method_add_file>` **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` file, :ref:`bool<class_bool>` remap **)** |
  20. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`add_ios_bundle_file<class_EditorExportPlugin_method_add_ios_bundle_file>` **(** :ref:`String<class_String>` path **)** |
  22. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`add_ios_cpp_code<class_EditorExportPlugin_method_add_ios_cpp_code>` **(** :ref:`String<class_String>` code **)** |
  24. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`add_ios_framework<class_EditorExportPlugin_method_add_ios_framework>` **(** :ref:`String<class_String>` path **)** |
  26. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`add_ios_linker_flags<class_EditorExportPlugin_method_add_ios_linker_flags>` **(** :ref:`String<class_String>` flags **)** |
  28. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`add_ios_plist_content<class_EditorExportPlugin_method_add_ios_plist_content>` **(** :ref:`String<class_String>` plist_content **)** |
  30. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`add_ios_project_static_lib<class_EditorExportPlugin_method_add_ios_project_static_lib>` **(** :ref:`String<class_String>` path **)** |
  32. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`add_shared_object<class_EditorExportPlugin_method_add_shared_object>` **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` tags **)** |
  34. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`skip<class_EditorExportPlugin_method_skip>` **(** **)** |
  36. +------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. Method Descriptions
  38. -------------------
  39. .. _class_EditorExportPlugin_method__export_begin:
  40. - void **_export_begin** **(** :ref:`PoolStringArray<class_PoolStringArray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_String>` path, :ref:`int<class_int>` flags **)** virtual
  41. Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export.
  42. ----
  43. .. _class_EditorExportPlugin_method__export_end:
  44. - void **_export_end** **(** **)** virtual
  45. Virtual method to be overridden by the user. Called when the export is finished.
  46. ----
  47. .. _class_EditorExportPlugin_method__export_file:
  48. - void **_export_file** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type, :ref:`PoolStringArray<class_PoolStringArray>` features **)** virtual
  49. ----
  50. .. _class_EditorExportPlugin_method_add_file:
  51. - void **add_file** **(** :ref:`String<class_String>` path, :ref:`PoolByteArray<class_PoolByteArray>` file, :ref:`bool<class_bool>` remap **)**
  52. ----
  53. .. _class_EditorExportPlugin_method_add_ios_bundle_file:
  54. - void **add_ios_bundle_file** **(** :ref:`String<class_String>` path **)**
  55. ----
  56. .. _class_EditorExportPlugin_method_add_ios_cpp_code:
  57. - void **add_ios_cpp_code** **(** :ref:`String<class_String>` code **)**
  58. ----
  59. .. _class_EditorExportPlugin_method_add_ios_framework:
  60. - void **add_ios_framework** **(** :ref:`String<class_String>` path **)**
  61. ----
  62. .. _class_EditorExportPlugin_method_add_ios_linker_flags:
  63. - void **add_ios_linker_flags** **(** :ref:`String<class_String>` flags **)**
  64. ----
  65. .. _class_EditorExportPlugin_method_add_ios_plist_content:
  66. - void **add_ios_plist_content** **(** :ref:`String<class_String>` plist_content **)**
  67. ----
  68. .. _class_EditorExportPlugin_method_add_ios_project_static_lib:
  69. - void **add_ios_project_static_lib** **(** :ref:`String<class_String>` path **)**
  70. ----
  71. .. _class_EditorExportPlugin_method_add_shared_object:
  72. - void **add_shared_object** **(** :ref:`String<class_String>` path, :ref:`PoolStringArray<class_PoolStringArray>` tags **)**
  73. ----
  74. .. _class_EditorExportPlugin_method_skip:
  75. - void **skip** **(** **)**