EditorExportPlugin

public void AddAppleEmbeddedPlatformBundleFile(string path);

Adds an Apple embedded platform bundle file from the given path to the exported project.

public void AddAppleEmbeddedPlatformCppCode(string code);

Adds C++ code to the Apple embedded platform export. The final code is created from the code appended by each active export plugin.

public void AddAppleEmbeddedPlatformEmbeddedFramework(string path);

Adds a dynamic library (*.dylib, .framework) to the Linking Phase in the Apple embedded platform's Xcode project and embeds it into the resulting binary. Note: For static libraries (.a), this works in the same way as EditorExportPlugin.AddAppleEmbeddedPlatformFramework. Note: This method should not be used for System libraries as they are already present on the device.

public void AddAppleEmbeddedPlatformFramework(string path);

Adds a static library (.a) or a dynamic library (.dylib, *.framework) to the Linking Phase to the Apple embedded platform's Xcode project.

public void AddAppleEmbeddedPlatformLinkerFlags(string flags);

Adds linker flags for the Apple embedded platform export.

public void AddAppleEmbeddedPlatformPlistContent(string plistContent);

Adds additional fields to the Apple embedded platform's project Info.plist file.

public void AddAppleEmbeddedPlatformProjectStaticLib(string path);

Adds a static library from the given path to the Apple embedded platform project.

public void AddAppleEmbeddedPlatformSpmPackage(string url, string version, ReadOnlySpan<string> products);

Adds a Swift Package Manager package to the Apple embedded platform's Xcode project. The url is the URL of the package, version is the version requirement (e.g. "1.0.0"), and products is an array of product names to include from the package. Note: Only supported on iOS and visionOS.

public void AddAppleEmbeddedPlatformSpmPackage(string url, string version, string[] products);

Adds a Swift Package Manager package to the Apple embedded platform's Xcode project. The url is the URL of the package, version is the version requirement (e.g. "1.0.0"), and products is an array of product names to include from the package. Note: Only supported on iOS and visionOS.

public void AddFile(string path, byte[] file, bool remap);

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. When called inside EditorExportPlugin._ExportFile and remap is true, the current file will not be exported, but instead remapped to this custom file. remap is ignored when called in other places. file will not be imported, so consider using EditorExportPlugin._CustomizeResource to remap imported resources.

public void AddFile(string path, ReadOnlySpan<byte> file, bool remap);

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. When called inside EditorExportPlugin._ExportFile and remap is true, the current file will not be exported, but instead remapped to this custom file. remap is ignored when called in other places. file will not be imported, so consider using EditorExportPlugin._CustomizeResource to remap imported resources.

public void AddIosBundleFile(string path);

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

public void AddIosCppCode(string code);

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

public void AddIosEmbeddedFramework(string path);

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), this works the in same way as EditorExportPlugin.AddAppleEmbeddedPlatformFramework. Note: This method should not be used for System libraries as they are already present on the device.

public void AddIosFramework(string path);

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

public void AddIosLinkerFlags(string flags);

Adds linker flags for the iOS export.

public void AddIosPlistContent(string plistContent);

Adds additional fields to the iOS project Info.plist file.

public void AddIosProjectStaticLib(string path);

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

public void AddMacOSPluginFile(string path);

Adds file or directory matching path to PlugIns directory of macOS app bundle. Note: This is useful only for macOS exports.

public void AddSharedObject(string path, ReadOnlySpan<string> tags, string target);

Adds a shared object or a directory containing only shared objects with the given tags and destination path. Note: In case of macOS exports, those shared objects will be added to Frameworks directory of app bundle. In case of a directory code-sign will error if you place non code object in directory.

public void AddSharedObject(string path, string[] tags, string target);

Adds a shared object or a directory containing only shared objects with the given tags and destination path. Note: In case of macOS exports, those shared objects will be added to Frameworks directory of app bundle. In case of a directory code-sign will error if you place non code object in directory.

public EditorExportPlatform GetExportPlatform();

Returns currently used export platform.

public EditorExportPreset GetExportPreset();

Returns currently used export preset.

public Variant GetOption(StringName name);

Returns the current value of an export option supplied by EditorExportPlugin._GetExportOptions.

public void Skip();

To be called inside EditorExportPlugin._ExportFile. Skips the current file, so it's not included in the export.

public virtual bool _BeginCustomizeResources(EditorExportPlatform platform, string[] features);

Return true if this plugin will customize resources based on the platform and features used. When enabled, EditorExportPlugin._GetCustomizationConfigurationHash and EditorExportPlugin._CustomizeResource will be called and must be implemented.

public virtual bool _BeginCustomizeScenes(EditorExportPlatform platform, string[] features);

Return true if this plugin will customize scenes based on the platform and features used. When enabled, EditorExportPlugin._GetCustomizationConfigurationHash and EditorExportPlugin._CustomizeScene will be called and must be implemented. Note: EditorExportPlugin._CustomizeScene will only be called for scenes that have been modified since the last export.

public virtual Resource _CustomizeResource(Resource resource, string path);

Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return null. When a new resource is returned, resource will be replaced by a copy of the new resource. The path argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty. Implementing this method is required if EditorExportPlugin._BeginCustomizeResources returns true. Note: When customizing any of the following types and returning another resource, the other resource should not be skipped using EditorExportPlugin.Skip in EditorExportPlugin._ExportFile:

• AtlasTexture
• CompressedCubemap
• CompressedCubemapArray
• CompressedTexture2D
• CompressedTexture2DArray
• CompressedTexture3D

public virtual Entity _CustomizeScene(Entity scene, string path);

Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return null. If a new scene is returned, it is up to you to dispose of the old one. Implementing this method is required if EditorExportPlugin._BeginCustomizeScenes returns true. Note: To change a variable in your scene, use the @export annotation when declaring it.

public virtual void _EndCustomizeResources();

This is called when the customization process for resources ends.

public virtual void _EndCustomizeScenes();

This is called when the customization process for scenes ends.

public virtual void _EndGenerateAppleEmbeddedProject(string path, bool willBuildArchive);

This is called after Xcode project generation, but before it is built. Note: Only supported on iOS and visionOS.

public virtual void _ExportBegin(string[] features, bool isDebug, string path, uint flags);

Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. features 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.

public virtual void _ExportEnd();

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

public virtual void _ExportFile(string path, string type, string[] features);

Virtual method to be overridden by the user. Called for each exported file before EditorExportPlugin._CustomizeResource and EditorExportPlugin._CustomizeScene. The arguments can be used to identify the file. path is the path of the file, type is the Resource represented by the file (e.g. PackedEntity), and features is the list of features for the export. Calling EditorExportPlugin.Skip inside this callback will make the file not included in the export.

public virtual string[] _GetAndroidDependencies(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: org.reckfell.example:my-plugin:0.0.0 For more information see Android documentation on dependencies. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual string[] _GetAndroidDependenciesMavenRepos(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin. For more information see Gradle documentation on dependency management. Note: Google's Maven repo and the Maven Central repo are already included by default. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual string[] _GetAndroidLibraries(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin. Note: Relative paths must be relative to Reckfell's asset://addons/ directory. For example, an AAR file located under asset://addons/hello_world_plugin/HelloWorld.release.aar can be returned as an absolute path using asset://addons/hello_world_plugin/HelloWorld.release.aar or a relative path using hello_world_plugin/HelloWorld.release.aar. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual string _GetAndroidManifestActivityElementContents(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is used at export time to update the contents of the activity element in the generated Android manifest. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual string _GetAndroidManifestApplicationElementContents(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is used at export time to update the contents of the application element in the generated Android manifest. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual string _GetAndroidManifestElementContents(EditorExportPlatform platform, bool debug);

Virtual method to be overridden by the user. This is used at export time to update the contents of the manifest element in the generated Android manifest. Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

public virtual ulong _GetCustomizationConfigurationHash();

Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. Implementing this method is required if EditorExportPlugin._BeginCustomizeResources returns true. Note: EditorExportPlugin._CustomizeResource and EditorExportPlugin._CustomizeScene will not be called when the EditorExportPlugin script is modified unless this hash changes too.

public virtual string[] _GetExportFeatures(EditorExportPlatform platform, bool debug);

Return a string[] of additional features this preset, for the given platform, should have.

public virtual bool _GetExportOptionVisibility(EditorExportPlatform platform, string option);

Validates option and returns the visibility for the specified platform. The default implementation returns true for all options.

public virtual string _GetExportOptionWarning(EditorExportPlatform platform, string option);

Check the requirements for the given option and return a non-empty warning string if they are not met. Note: Use EditorExportPlugin.GetOption to check the value of the export options.

public virtual Reckfell.Collections.Array<Reckfell.Collections.Dictionary> _GetExportOptions(EditorExportPlatform platform);

Return a list of export options that can be configured for this export plugin. Each element in the return value is a Reckfell.Collections.Dictionary with the following keys:

• option: A dictionary with the structure documented by ReckfellObject.GetPropertyList, but all keys are optional.
• default_value: The default value for this option.
• update_visibility: An optional boolean value. If set to true, the preset will emit ReckfellObject.PropertyListChanged when the option is changed.

public virtual Reckfell.Collections.Dictionary _GetExportOptionsOverrides(EditorExportPlatform platform);

Return a Reckfell.Collections.Dictionary of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface.

public virtual string _GetName();

Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting. Implementing this method is required.

public virtual bool _ShouldUpdateExportOptions(EditorExportPlatform platform);

Return true if the result of EditorExportPlugin._GetExportOptions has changed and the export options of the preset corresponding to platform should be updated.

public virtual bool _SupportsPlatform(EditorExportPlatform platform);

Return true if the plugin supports the given platform.

public virtual byte[] _UpdateAndroidPrebuiltManifest(EditorExportPlatform platform, byte[] manifestData);

Provide access to the Android prebuilt manifest and allows the plugin to modify it if needed. Implementers of this virtual method should take the binary manifest data from manifest_data, copy it, modify it, and then return it with the modifications. If no modifications are needed, then an empty byte[] should be returned.