EditorExportPlugin

    A script that is executed when exporting the project.

    Editor export plugins are automatically activated whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, is called at the beginning of the export process and then _export_file is called for each exported file.

    • void _export_begin ( features, bool is_debug, path, int flags ) virtual

    Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. is the list of features for the export, is_debug is true for debug builds, path is the target path for the exported project. flags is only used when running a runnable profile, e.g. when using native run on Android.


    Virtual method to be overridden by the user. Called when the export is finished.


    • void _export_file ( path, String type, features ) virtual

    Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. is the path of the file, type is the Resource represented by the file (e.g. ) and features is the list of features for the export.


    Adds a custom file to be exported. path is the virtual path that can be used to load the file, file is the binary data of the file. If is true, file will not be exported, but instead remapped to the given path.


    • void add_ios_bundle_file ( path )

    Adds an iOS bundle file from the given path to the exported project.


    • void add_ios_cpp_code ( String code )

    Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.


    Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS’s Xcode project and embeds it into resulting binary.

    Note: For static libraries (*.a) works in same way as .


    • void add_ios_framework ( String path )

    Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS’s Xcode project.


    • void add_ios_linker_flags ( flags )

    Adds linker flags for the iOS export.


    • void add_ios_plist_content ( String plist_content )

    Adds content for iOS Property List files.


    • void add_ios_project_static_lib ( path )

    Adds a static lib from the given path to the iOS project.


    Adds a shared object with the given and destination path.


    • void skip ( )