Class EditorExportPlatform

Namespace

Godot

Assembly

GodotSharpEditor.dll

Base resource that provides the functionality of exporting a release build of a project to a platform, from the editor. Stores platform-specific metadata such as the name and supported features of the platform, and performs the exporting of projects, PCK files, and ZIP files. Uses an export template for the platform provided at the time of project exporting.

Used in scripting by EditorExportPlugin to configure platform-specific customization of scenes and resources. See _BeginCustomizeScenes(EditorExportPlatform, string[]) and _BeginCustomizeResources(EditorExportPlatform, string[]) for more details.

public class EditorExportPlatform : RefCounted, IDisposable

Inheritance

object

GodotObject

RefCounted

EditorExportPlatform

Implements

IDisposable

Derived

EditorExportPlatformAndroid

EditorExportPlatformExtension

EditorExportPlatformIos

EditorExportPlatformMacOS

EditorExportPlatformPC

EditorExportPlatformWeb

Inherited Members

RefCounted.InitRef()

RefCounted.Reference()

RefCounted.Unreference()

RefCounted.GetReferenceCount()

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NotificationExtensionReloaded

GodotObject.InstanceFromId(ulong)

GodotObject.IsInstanceIdValid(ulong)

GodotObject.IsInstanceValid(GodotObject)

GodotObject.WeakRef(GodotObject)

GodotObject.Dispose()

GodotObject.Dispose(bool)

GodotObject.ToString()

GodotObject.ToSignal(GodotObject, StringName)

GodotObject._Get(StringName)

GodotObject._GetPropertyList()

GodotObject._IterGet(Variant)

GodotObject._IterInit(Array)

GodotObject._IterNext(Array)

GodotObject._Notification(int)

GodotObject._PropertyCanRevert(StringName)

GodotObject._PropertyGetRevert(StringName)

GodotObject._Set(StringName, Variant)

GodotObject._ValidateProperty(Dictionary)

GodotObject.Free()

GodotObject.GetClass()

GodotObject.IsClass(string)

GodotObject.Set(StringName, Variant)

GodotObject.Get(StringName)

GodotObject.SetIndexed(NodePath, Variant)

GodotObject.GetIndexed(NodePath)

GodotObject.GetPropertyList()

GodotObject.GetMethodList()

GodotObject.PropertyCanRevert(StringName)

GodotObject.PropertyGetRevert(StringName)

GodotObject.Notification(int, bool)

GodotObject.GetInstanceId()

GodotObject.SetScript(Variant)

GodotObject.GetScript()

GodotObject.SetMeta(StringName, Variant)

GodotObject.RemoveMeta(StringName)

GodotObject.GetMeta(StringName, Variant)

GodotObject.HasMeta(StringName)

GodotObject.GetMetaList()

GodotObject.AddUserSignal(string, Array)

GodotObject.HasUserSignal(StringName)

GodotObject.RemoveUserSignal(StringName)

GodotObject.EmitSignal(StringName, params Variant[])

GodotObject.EmitSignal(StringName, ReadOnlySpan<Variant>)

GodotObject.Call(StringName, params Variant[])

GodotObject.Call(StringName, ReadOnlySpan<Variant>)

GodotObject.CallDeferred(StringName, params Variant[])

GodotObject.CallDeferred(StringName, ReadOnlySpan<Variant>)

GodotObject.SetDeferred(StringName, Variant)

GodotObject.Callv(StringName, Array)

GodotObject.HasMethod(StringName)

GodotObject.GetMethodArgumentCount(StringName)

GodotObject.HasSignal(StringName)

GodotObject.GetSignalList()

GodotObject.GetSignalConnectionList(StringName)

GodotObject.GetIncomingConnections()

GodotObject.Connect(StringName, Callable, uint)

GodotObject.Disconnect(StringName, Callable)

GodotObject.IsConnected(StringName, Callable)

GodotObject.HasConnections(StringName)

GodotObject.SetBlockSignals(bool)

GodotObject.IsBlockingSignals()

GodotObject.NotifyPropertyListChanged()

GodotObject.SetMessageTranslation(bool)

GodotObject.CanTranslateMessages()

GodotObject.Tr(StringName, StringName)

GodotObject.TrN(StringName, StringName, int, StringName)

GodotObject.GetTranslationDomain()

GodotObject.SetTranslationDomain(StringName)

GodotObject.IsQueuedForDeletion()

GodotObject.CancelFree()

GodotObject.EmitSignalScriptChanged()

GodotObject.EmitSignalPropertyListChanged()

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddMessage(ExportMessageType, string, string)

Adds a message to the export log that will be displayed when exporting ends.

public void AddMessage(EditorExportPlatform.ExportMessageType type, string category, string message)

Parameters

type EditorExportPlatform.ExportMessageType

category string

message string

ClearMessages()

Clears the export log.

public void ClearMessages()

CreatePreset()

Create a new preset for this platform.

public EditorExportPreset CreatePreset()

Returns

EditorExportPreset

ExportPack(EditorExportPreset, bool, string, DebugFlags)

Creates a PCK archive at path for the specified preset.

public Error ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0)

Parameters

preset EditorExportPreset

debug bool

path string

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportPackPatch(EditorExportPreset, bool, string, ReadOnlySpan<string>, DebugFlags)

Creates a patch PCK archive at path for the specified preset, containing only the files that have changed since the last patch.

Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags)

Parameters

preset EditorExportPreset

debug bool

path string

patches ReadOnlySpan<string>

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportPackPatch(EditorExportPreset, bool, string, string[], DebugFlags)

Creates a patch PCK archive at path for the specified preset, containing only the files that have changed since the last patch.

Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0)

Parameters

preset EditorExportPreset

debug bool

path string

patches string[]

If the parameter is null, then the default value is Array.Empty<string>().

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportProject(EditorExportPreset, bool, string, DebugFlags)

Creates a full project at path for the specified preset.

public Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0)

Parameters

preset EditorExportPreset

debug bool

path string

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportProjectFiles(EditorExportPreset, bool, Callable, Callable)

Exports project files for the specified preset. This method can be used to implement custom export format, other than PCK and ZIP. One of the callbacks is called for each exported file.

saveCb is called for all exported files and have the following arguments: file_path: String, file_data: PackedByteArray, file_index: int, file_count: int, encryption_include_filters: PackedStringArray, encryption_exclude_filters: PackedStringArray, encryption_key: PackedByteArray.

sharedCb is called for exported native shared/static libraries and have the following arguments: file_path: String, tags: PackedStringArray, target_folder: String.

Note: file_index and file_count are intended for progress tracking only and aren't necessarily unique and precise.

public Error ExportProjectFiles(EditorExportPreset preset, bool debug, Callable saveCb, Callable sharedCb = default)

Parameters

preset EditorExportPreset

debug bool

saveCb Callable

sharedCb Callable

Returns

Error

ExportZip(EditorExportPreset, bool, string, DebugFlags)

Create a ZIP archive at path for the specified preset.

public Error ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0)

Parameters

preset EditorExportPreset

debug bool

path string

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportZipPatch(EditorExportPreset, bool, string, ReadOnlySpan<string>, DebugFlags)

Create a patch ZIP archive at path for the specified preset, containing only the files that have changed since the last patch.

Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags)

Parameters

preset EditorExportPreset

debug bool

path string

patches ReadOnlySpan<string>

flags EditorExportPlatform.DebugFlags

Returns

Error

ExportZipPatch(EditorExportPreset, bool, string, string[], DebugFlags)

Create a patch ZIP archive at path for the specified preset, containing only the files that have changed since the last patch.

Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0)

Parameters

preset EditorExportPreset

debug bool

path string

patches string[]

If the parameter is null, then the default value is Array.Empty<string>().

flags EditorExportPlatform.DebugFlags

Returns

Error

FindExportTemplate(string)

Locates export template for the platform, and returns Dictionary with the following keys: path: String and error: String. This method is provided for convenience and custom export platforms aren't required to use it or keep export templates stored in the same way official templates are.

public Dictionary FindExportTemplate(string templateFileName)

Parameters

templateFileName string

Returns

Dictionary

GenExportFlags(DebugFlags)

Generates array of command line arguments for the default export templates for the debug flags and editor settings.

public string[] GenExportFlags(EditorExportPlatform.DebugFlags flags)

Parameters

flags EditorExportPlatform.DebugFlags

Returns

string[]

GetCurrentPresets()

Returns array of EditorExportPresets for this platform.

public Array GetCurrentPresets()

Returns

Array

GetForcedExportFiles()

Returns array of core file names that always should be exported regardless of preset config.

public static string[] GetForcedExportFiles()

Returns

string[]

GetInternalExportFiles(EditorExportPreset, bool)

Returns additional files that should always be exported regardless of preset configuration, and are not part of the project source. The returned Dictionary contains filename keys (string) and their corresponding raw data (byte[]).

public Dictionary GetInternalExportFiles(EditorExportPreset preset, bool debug)

Parameters

preset EditorExportPreset

debug bool

Returns

Dictionary

GetMessageCategory(int)

Returns message category, for the message with index.

public string GetMessageCategory(int index)

Parameters

index int

Returns

string

GetMessageCount()

Returns number of messages in the export log.

public int GetMessageCount()

Returns

int

GetMessageText(int)

Returns message text, for the message with index.

public string GetMessageText(int index)

Parameters

index int

Returns

string

GetMessageType(int)

Returns message type, for the message with index.

public EditorExportPlatform.ExportMessageType GetMessageType(int index)

Parameters

index int

Returns

EditorExportPlatform.ExportMessageType

GetOsName()

Returns the name of the export operating system handled by this EditorExportPlatform class, as a friendly string. Possible return values are Windows, Linux, macOS, Android, iOS, and Web.

public string GetOsName()

Returns

string

GetWorstMessageType()

Returns most severe message type currently present in the export log.

public EditorExportPlatform.ExportMessageType GetWorstMessageType()

Returns

EditorExportPlatform.ExportMessageType

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

SavePack(EditorExportPreset, bool, string, bool)

Saves PCK archive and returns Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

If embed is true, PCK content is appended to the end of path file and return Dictionary additionally include following keys: embedded_start: int (embedded PCK offset) and embedded_size: int (embedded PCK size).

public Dictionary SavePack(EditorExportPreset preset, bool debug, string path, bool embed = false)

Parameters

preset EditorExportPreset

debug bool

path string

embed bool

Returns

Dictionary

SavePackPatch(EditorExportPreset, bool, string)

Saves patch PCK archive and returns Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Dictionary SavePackPatch(EditorExportPreset preset, bool debug, string path)

Parameters

preset EditorExportPreset

debug bool

path string

Returns

Dictionary

SaveZip(EditorExportPreset, bool, string)

Saves ZIP archive and returns Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Dictionary SaveZip(EditorExportPreset preset, bool debug, string path)

Parameters

preset EditorExportPreset

debug bool

path string

Returns

Dictionary

SaveZipPatch(EditorExportPreset, bool, string)

Saves patch ZIP archive and returns Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Dictionary SaveZipPatch(EditorExportPreset preset, bool debug, string path)

Parameters

preset EditorExportPreset

debug bool

path string

Returns

Dictionary

SshPushToRemote(string, string, ReadOnlySpan<string>, string, string)

Uploads specified file over SCP protocol to the remote host.

public Error SshPushToRemote(string host, string port, ReadOnlySpan<string> scpArgs, string srcFile, string dstFile)

Parameters

host string

port string

scpArgs ReadOnlySpan<string>

srcFile string

dstFile string

Returns

Error

SshPushToRemote(string, string, string[], string, string)

Uploads specified file over SCP protocol to the remote host.

public Error SshPushToRemote(string host, string port, string[] scpArgs, string srcFile, string dstFile)

Parameters

host string

port string

scpArgs string[]

srcFile string

dstFile string

Returns

Error

SshRunOnRemote(string, string, ReadOnlySpan<string>, string, Array, int)

Executes specified command on the remote host via SSH protocol and returns command output in the output.

public Error SshRunOnRemote(string host, string port, ReadOnlySpan<string> sshArg, string cmdArgs, Array output, int portFwd)

Parameters

host string

port string

sshArg ReadOnlySpan<string>

cmdArgs string

output Array

portFwd int

Returns

Error

SshRunOnRemote(string, string, string[], string, Array, int)

Executes specified command on the remote host via SSH protocol and returns command output in the output.

public Error SshRunOnRemote(string host, string port, string[] sshArg, string cmdArgs, Array output = null, int portFwd = -1)

Parameters

host string

port string

sshArg string[]

cmdArgs string

output Array

portFwd int

Returns

Error

SshRunOnRemoteNoWait(string, string, ReadOnlySpan<string>, string, int)

Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.

public long SshRunOnRemoteNoWait(string host, string port, ReadOnlySpan<string> sshArgs, string cmdArgs, int portFwd)

Parameters

host string

port string

sshArgs ReadOnlySpan<string>

cmdArgs string

portFwd int

Returns

long

SshRunOnRemoteNoWait(string, string, string[], string, int)

Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.

public long SshRunOnRemoteNoWait(string host, string port, string[] sshArgs, string cmdArgs, int portFwd = -1)

Parameters

host string

port string

sshArgs string[]

cmdArgs string

portFwd int

Returns

long