EditorExportPlatformIOS

Inherits: EditorExportPlatform < RefCounted < Object

Exporter for iOS.

Tutorials

• Exporting for iOS

• iOS plugins documentation index

Properties

Property Descriptions

String application/app_store_team_id

Apple Team ID, unique 10-character string. To locate your Team ID check “Membership details” section in your Apple developer account dashboard, or “Organizational Unit” of your code signing certificate. See Locate your Team ID.

String application/bundle_identifier

Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.).

String application/code_sign_identity_debug

The “Full Name”, “Common Name” or SHA-1 hash of the signing identity used for debug export.

String application/code_sign_identity_release

The “Full Name”, “Common Name” or SHA-1 hash of the signing identity used for release export.

int application/export_method_debug

Application distribution target (debug export).

int application/export_method_release

Application distribution target (release export).

bool application/export_project_only

If true, exports iOS project files without building an XCArchive or .ipa file. If false, exports iOS project files and builds an XCArchive and .ipa file at the same time. When combining Godot with Fastlane or other build pipelines, you may want to set this to true.

int application/icon_interpolation

Interpolation method used to resize application icon.

int application/launch_screens_interpolation

Interpolation method used to resize launch screen images.

String application/provisioning_profile_uuid_debug

UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See Edit, download, or delete provisioning profiles.

Can be overridden with the environment variable GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG.

String application/provisioning_profile_uuid_release

UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See Edit, download, or delete provisioning profiles.

Can be overridden with the environment variable GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE.

String application/short_version

Application version visible to the user, can only contain numeric characters (0-9) and periods (.). Falls back to ProjectSettings.application/config/version if left empty.

String application/signature

A four-character creator code that is specific to the bundle. Optional.

int application/targeted_device_family

Supported device family.

String application/version

Machine-readable application version, in the major.minor.patch format, can only contain numeric characters (0-9) and periods (.). This must be incremented on every new release pushed to the App Store.

bool architectures/arm64

If true, arm64 binaries are included into exported project.

bool capabilities/access_wifi

If true, networking features related to Wi-Fi access are enabled. See Required Device Capabilities.

bool capabilities/push_notifications

If true, push notifications are enabled. See Required Device Capabilities.

String custom_template/debug

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

String custom_template/release

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

String icons/app_store_1024x1024

App Store application icon file. If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/ipad_76x76

Home screen application icon file on iPad (1x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/ipad_152x152

Home screen application icon file on iPad (2x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/ipad_167x167

Home screen application icon file on iPad (3x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/iphone_120x120

Home screen application icon file on iPhone (2x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/iphone_180x180

Home screen application icon file on iPhone (3x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/notification_40x40

Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/notification_60x60

Notification icon file on iPhone (3x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/settings_58x58

Application settings icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/settings_87x87

Application settings icon file on iPhone (3x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/spotlight_40x40

Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String icons/spotlight_80x80

Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to ProjectSettings.application/config/icon. See App icons.

String landscape_launch_screens/ipad_1024x768

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String landscape_launch_screens/ipad_2048x1536

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String landscape_launch_screens/iphone_2208x1242

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String landscape_launch_screens/iphone_2436x1125

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/ipad_768x1024

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/ipad_1536x2048

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/iphone_640x960

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/iphone_640x1136

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/iphone_750x1334

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/iphone_1125x2436

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String portrait_launch_screens/iphone_1242x2208

Application launch screen image file. If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String privacy/camera_usage_description

A message displayed when requesting access to the device’s camera (in English).

Dictionary privacy/camera_usage_description_localized

A message displayed when requesting access to the device’s camera (localized).

String privacy/microphone_usage_description

A message displayed when requesting access to the device’s microphone (in English).

Dictionary privacy/microphone_usage_description_localized

A message displayed when requesting access to the device’s microphone (localized).

String privacy/photolibrary_usage_description

A message displayed when requesting access to the user’s photo library (in English).

Dictionary privacy/photolibrary_usage_description_localized

A message displayed when requesting access to the user’s photo library (localized).

Color storyboard/custom_bg_color

A custom background color of the storyboard launch screen.

String storyboard/custom_image@2x

Application launch screen image file (2x DPI). If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

String storyboard/custom_image@3x

Application launch screen image file (3x DPI). If left empty, it will fallback to ProjectSettings.application/boot_splash/image.

int storyboard/image_scale_mode

Launch screen image scaling mode.

bool storyboard/use_custom_bg_color

If true, storyboard/custom_bg_color is used as a launch screen background color, otherwise application/boot_splash/bg_color project setting is used.

bool storyboard/use_launch_screen_storyboard

If true, storyboard launch screen is used instead of launch screen images.

bool user_data/accessible_from_files_app

If true, the app “Documents” folder can be accessed via “Files” app. See LSSupportsOpeningDocumentsInPlace.

bool user_data/accessible_from_itunes_sharing

If true, the app “Documents” folder can be accessed via iTunes file sharing. See UIFileSharingEnabled.

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.