Inheritance #

EditorExportPlatformWindows #

is_refcounted, is_instantiable, editor, not_builtin_classes

Exporter for Windows.

The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset.

Members #

var application/company_name: String#

Company that produced the application. Required. See StringFileInfo.

var application/console_wrapper_icon: String#

Console wrapper icon file. If left empty, it will fallback to application/icon, then to ProjectSettings.application/config/windows_native_icon, and lastly, ProjectSettings.application/config/icon.

var application/copyright: String#

Copyright notice for the bundle visible to the user. Optional. See StringFileInfo.

var application/d3d12_agility_sdk_multiarch: bool#

If true, and application/export_d3d12 is set, the Agility SDK DLLs will be stored in arch-specific subdirectories.

var application/export_angle: int#

If set to 1, ANGLE libraries are exported with the exported application. If set to 0, ANGLE libraries are exported only if ProjectSettings.rendering/gl_compatibility/driver is set to "opengl3_angle".

var application/export_d3d12: int#

If set to 1, the Direct3D 12 runtime libraries (Agility SDK, PIX) are exported with the exported application. If set to 0, Direct3D 12 libraries are exported only if ProjectSettings.rendering/rendering_device/driver is set to "d3d12".

var application/file_description: String#

File description to be presented to users. Required. See StringFileInfo.

var application/file_version: String#

Version number of the file. Falls back to ProjectSettings.application/config/version if left empty. See StringFileInfo.

var application/icon: String#

Application icon file. If left empty, it will fallback to ProjectSettings.application/config/windows_native_icon, and then to ProjectSettings.application/config/icon.

var application/icon_interpolation: int#

Interpolation method used to resize application icon.

var application/modify_resources: bool#

If enabled, icon and metadata of the exported executable is set according to the other application/* values.

var application/product_name: String#

Name of the application. Required. See StringFileInfo.

var application/product_version: String#

Application version visible to the user. Falls back to ProjectSettings.application/config/version if left empty. See StringFileInfo.

var application/trademarks: String#

Trademarks and registered trademarks that apply to the file. Optional. See StringFileInfo.

var binary_format/architecture: String#

Application executable architecture.

Supported architectures: x86_32, x86_64, and arm64.

var binary_format/embed_pck: bool#

If true, project resources are embedded into the executable.

var codesign/custom_options: PackedStringArray#

Array of the additional command line arguments passed to the code signing tool. See Sign Tool.

var codesign/description: String#

Description of the signed content. See Sign Tool.

var codesign/digest_algorithm: int#

Digest algorithm to use for creating signature. See Sign Tool.

var codesign/enable: bool#

If true, executable signing is enabled.

var codesign/identity: String#

PKCS #12 certificate file used to sign executable or certificate SHA-1 hash (if codesign/identity_type is set to "Use certificate store"). See Sign Tool.

Can be overridden with the environment variable GODOT_WINDOWS_CODESIGN_IDENTITY.

var codesign/identity_type: int#

Type of identity to use. See Sign Tool.

Can be overridden with the environment variable GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE.

var codesign/password: String#

Password for the certificate file used to sign executable. See Sign Tool.

Can be overridden with the environment variable GODOT_WINDOWS_CODESIGN_PASSWORD.

var codesign/timestamp: bool#

If true, time-stamp is added to the signature. See Sign Tool.

var codesign/timestamp_server_url: String#

URL of the time stamp server. If left empty, the default server is used. See Sign Tool.

var custom_template/debug: String#

Path to the custom export template. If left empty, default template is used.

var custom_template/release: String#

Path to the custom export template. If left empty, default template is used.

var debug/export_console_wrapper: int#

If true, a console wrapper executable is exported alongside the main executable, which allows running the project with enabled console output.

var ssh_remote_deploy/cleanup_script: String#

Script code to execute on the remote host when app is finished.

The following variables can be used in the script:

- {temp_dir} - Path of temporary folder on the remote, used to upload app and scripts to.

- {archive_name} - Name of the ZIP containing uploaded application.

- {exe_name} - Name of application executable.

- {cmd_args} - Array of the command line argument for the application.

var ssh_remote_deploy/enabled: bool#

Enables remote deploy using SSH/SCP.

var ssh_remote_deploy/extra_args_scp: String#

Array of the additional command line arguments passed to the SCP.

var ssh_remote_deploy/extra_args_ssh: String#

Array of the additional command line arguments passed to the SSH.

var ssh_remote_deploy/host: String#

Remote host SSH user name and address, in user@address format.

var ssh_remote_deploy/port: String#

Remote host SSH port number.

var ssh_remote_deploy/run_script: String#

Script code to execute on the remote host when running the app.

The following variables can be used in the script:

- {temp_dir} - Path of temporary folder on the remote, used to upload app and scripts to.

- {archive_name} - Name of the ZIP containing uploaded application.

- {exe_name} - Name of application executable.

- {cmd_args} - Array of the command line argument for the application.

var texture_format/etc2_astc: bool#

If true, project textures are exported in the ETC2/ASTC format.

var texture_format/s3tc_bptc: bool#

If true, project textures are exported in the S3TC/BPTC format.

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #