跳到主要内容

EditorExportPlugin

继承​

Reference

简要描述​

导出项目时执行的脚本。

描述​

每当用户导出项目时，编辑器导出插件都会自动激活。它们最常见的用途是确定导出的项目中包含哪些文件。对于每一个插件，_export_begin被称为在出口过程的开始，然后_export_file被每导出的文件。

方法​

返回值类型方法名称
void_export_begin(features: PoolStringArray, is_debug: bool, path: String, flags: int) virtual
void_export_end() virtual
void_export_file(path: String, type: String, features: PoolStringArray) virtual
voidadd_file(path: String, file: PoolByteArray, remap: bool)
voidadd_ios_bundle_file(path: String)
voidadd_ios_cpp_code(code: String)
voidadd_ios_framework(path: String)
voidadd_ios_linker_flags(flags: String)
voidadd_ios_plist_content(plist_content: String)
voidadd_shared_object(path: String, tags: PoolStringArray)
voidskip()

方法说明​

  • _export_begin _export_begin(features: PoolStringArray, is_debug: bool, path: String, flags: int) virtual

用户要重写的虚拟方法。导出开始时将调用它，并提供有关导出的所有信息。features是的功能，为出口名单，is_debug是true建立调试，path是对出口项目的目标路径。flags仅在运行可运行配置文件时使用，例如，在Android上使用本机运行时。

  • _export_end _export_end() virtual

用户要重写的虚拟方法。导出完成时调用。

  • _export_file _export_file(path: String, type: String, features: PoolStringArray) virtual

用户要重写的虚拟方法。为每个导出的文件调用，提供可用于识别文件的参数。path是文件的路径，是文件type所代表的资源（例如PackedScene），并且features是导出功能的列表。

在此回调中调用skip将使文件不包括在导出中。

  • add_file add_file(path: String, file: PoolByteArray, remap: bool)

添加要导出的自定义文件。path是可用于加载文件的虚拟路径，是文件file的二进制数据。如果remap为true，则不会导出文件，而是将其重新映射到给定的path。

  • add_ios_bundle_file add_ios_bundle_file(path: String)

将iOS捆绑包文件从中添加path到导出的项目中。

  • add_ios_cpp_code add_ios_cpp_code(code: String)

将C ++代码添加到iOS导出。最终代码是根据每个活动导出插件附加的代码创建的。

  • add_ios_framework add_ios_framework(path: String)

在iOS的Xcode项目的Linking Phase中添加静态库（.a）或动态库（.dylib，*.framework）。

  • add_ios_linker_flags add_ios_linker_flags(flags: String)

为iOS导出添加链接器标志。

  • add_ios_plist_content add_ios_plist_content(plist_content: String)

添加iOS属性列表文件的内容。

  • add_shared_object add_shared_object(path: String, tags: PoolStringArray)

添加具有给定tags和目标的共享库path。

  • skip skip()

在_export_file内部调用。跳过当前文件，因此它不包含在导出中。