Table of Contents

Class EditorExportPreset

Namespace
Godot
Assembly
GodotSharpEditor.dll

Export preset configuration. Instances of EditorExportPreset by editor UI and intended to be used a read-only configuration passed to the EditorExportPlatform methods when exporting the project.

public class EditorExportPreset : RefCounted, IDisposable
Inheritance
EditorExportPreset
Implements
Inherited Members

Methods

AreAdvancedOptionsEnabled()

Returns true if "Advanced" toggle is enabled in the export dialog.

public bool AreAdvancedOptionsEnabled()

Returns

bool

GetCustomFeatures()

Returns string with a comma separated list of custom features.

public string GetCustomFeatures()

Returns

string

GetCustomizedFiles()

Returns Dictionary of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - "strip", "keep", or "remove". See also GetFileExportMode(string, FileExportMode).

public Dictionary GetCustomizedFiles()

Returns

Dictionary

GetCustomizedFilesCount()

Returns number of files selected in the "Resources" tab of the export dialog.

public int GetCustomizedFilesCount()

Returns

int

GetEncryptDirectory()

Returns true, PCK directory encryption is enabled in the export dialog.

public bool GetEncryptDirectory()

Returns

bool

GetEncryptPck()

Returns true, PCK encryption is enabled in the export dialog.

public bool GetEncryptPck()

Returns

bool

GetEncryptionExFilter()

Returns file filters to exclude during PCK encryption.

public string GetEncryptionExFilter()

Returns

string

GetEncryptionInFilter()

Returns file filters to include during PCK encryption.

public string GetEncryptionInFilter()

Returns

string

GetEncryptionKey()

Returns PCK encryption key.

public string GetEncryptionKey()

Returns

string

GetExcludeFilter()

Returns file filters to exclude during export.

public string GetExcludeFilter()

Returns

string

GetExportFilter()

Returns export file filter mode selected in the "Resources" tab of the export dialog.

public EditorExportPreset.ExportFilter GetExportFilter()

Returns

EditorExportPreset.ExportFilter

GetExportPath()

Returns export target path.

public string GetExportPath()

Returns

string

GetFileExportMode(string, FileExportMode)

Returns file export mode for the specified file.

public EditorExportPreset.FileExportMode GetFileExportMode(string path, EditorExportPreset.FileExportMode @default = FileExportMode.NotCustomized)

Parameters

path string
default EditorExportPreset.FileExportMode

Returns

EditorExportPreset.FileExportMode

GetFilesToExport()

Returns array of files to export.

public string[] GetFilesToExport()

Returns

string[]

GetIncludeFilter()

Returns file filters to include during export.

public string GetIncludeFilter()

Returns

string

GetOrEnv(StringName, string)

Returns export option value or value of environment variable if it is set.

public Variant GetOrEnv(StringName name, string envVar)

Parameters

name StringName
envVar string

Returns

Variant

GetPatches()

Returns the list of packs on which to base a patch export on.

public string[] GetPatches()

Returns

string[]

GetPresetName()

Returns export preset name.

public string GetPresetName()

Returns

string

GetScriptExportMode()

Returns script export mode.

public int GetScriptExportMode()

Returns

int

GetVersion(StringName, bool)

Returns the preset's version number, or fall back to the ProjectSettings.application/config/version project setting if set to an empty string.

If windowsVersion is true, formats the returned version number to be compatible with Windows executable metadata.

public string GetVersion(StringName name, bool windowsVersion)

Parameters

name StringName
windowsVersion bool

Returns

string

Has(StringName)

Returns true if preset has specified property.

public bool Has(StringName property)

Parameters

property StringName

Returns

bool

HasExportFile(string)

Returns true if specified file is exported.

public bool HasExportFile(string path)

Parameters

path string

Returns

bool

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

IsDedicatedServer()

Returns true if dedicated server export mode is selected in the export dialog.

public bool IsDedicatedServer()

Returns

bool

IsRunnable()

Returns true if "Runnable" toggle is enabled in the export dialog.

public bool IsRunnable()

Returns

bool
Edit this page