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, _exportBegin is called at the beginning of the export process and then _exportFile is called for each exported file.

@GodotBaseClass

struct EditorExportPlugin {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(EditorExportPlugin other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static EditorExportPlugin _new();

void _exportBegin(PoolStringArray features, bool is_debug, String path, long flags);

void _exportEnd();

void _exportFile(String path, String type, PoolStringArray features);

void addFile(String path, PoolByteArray file, bool remap);

void addIosBundleFile(String path);

void addIosCppCode(String code);

void addIosEmbeddedFramework(String path);

void addIosFramework(String path);

void addIosLinkerFlags(String flags);

void addIosPlistContent(String plist_content);

void addIosProjectStaticLib(String path);

void addSharedObject(String path, PoolStringArray tags);

void skip();

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_exportBegin void _exportBegin(PoolStringArray features, bool is_debug, String path, long 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.
_exportEnd void _exportEnd(): Virtual method to be overridden by the user. Called when the export is finished.
_exportFile void _exportFile(String path, String type, PoolStringArray features): Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. path is the path of the file, type is the Resource represented by the file (e.g. PackedScene) and features is the list of features for the export. Calling skip inside this callback will make the file not included in the export.
addFile void addFile(String path, PoolByteArray 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. If remap is true, file will not be exported, but instead remapped to the given path.
addIosBundleFile void addIosBundleFile(String path): Adds an iOS bundle file from the given path to the exported project.
addIosCppCode void addIosCppCode(String code): Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
addIosEmbeddedFramework 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) works in same way as addIosFramework. This method should not be used for System libraries as they are already present on the device.
addIosFramework void addIosFramework(String path): Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.
addIosLinkerFlags void addIosLinkerFlags(String flags): Adds linker flags for the iOS export.
addIosPlistContent void addIosPlistContent(String plist_content): Adds content for iOS Property List files.
addIosProjectStaticLib void addIosProjectStaticLib(String path): Adds a static lib from the given path to the iOS project.
addSharedObject void addSharedObject(String path, PoolStringArray tags): Adds a shared object with the given tags and destination path.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(EditorExportPlugin other)
opEquals bool opEquals(typeof(null) n)
skip void skip(): To be called inside _exportFile. Skips the current file, so it's not included in the export.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new EditorExportPlugin _new(): Construct a new instance of EditorExportPlugin. Note: use memnew!EditorExportPlugin instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

EditorExportPlugin

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

EditorExportPlugin

From mixin baseCasts

From `mixin baseCasts`