godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/platform/ios/doc_classes/EditorExportPlatformIOS.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

160 lines
13 KiB
XML
Raw Normal View History

[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="EditorExportPlatformIOS" inherits="EditorExportPlatform" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<brief_description>
Exporter for iOS.
</brief_description>
<description>
</description>
<tutorials>
<link title="Exporting for iOS">$DOCS_URL/tutorials/export/exporting_for_ios.html</link>
Add missing tutorials to documentation classes
2023-08-15 10:14:01 +00:00
<link title="iOS plugins documentation index">$DOCS_URL/tutorials/platform/ios/index.html</link>
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</tutorials>
<members>
<member name="application/app_store_team_id" type="String" setter="" getter="">
Fix various typos with codespell Also includes the grammar fix from #76206. Co-authored-by: Peter Anderson <BWPanda@users.noreply.github.com>
2023-04-26 11:57:02 +00:00
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 [url=https://developer.apple.com/help/account/manage-your-team/locate-your-team-id]Locate your Team ID[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="application/bundle_identifier" type="String" setter="" getter="">
Unique application identifier in a reverse-DNS format, can only contain alphanumeric characters ([code]A-Z[/code], [code]a-z[/code], and [code]0-9[/code]), hyphens ([code]-[/code]), and periods ([code].[/code]).
</member>
<member name="application/code_sign_identity_debug" type="String" setter="" getter="">
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for debug export.
</member>
<member name="application/code_sign_identity_release" type="String" setter="" getter="">
The "Full Name", "Common Name" or SHA-1 hash of the signing identity used for release export.
</member>
<member name="application/export_method_debug" type="int" setter="" getter="">
Application distribution target (debug export).
</member>
<member name="application/export_method_release" type="int" setter="" getter="">
Application distribution target (release export).
</member>
iOS: Add `export_project_only` flag
2023-06-24 08:38:08 +00:00
<member name="application/export_project_only" type="bool" setter="" getter="">
If [code]true[/code], exports iOS project files without building an XCArchive or [code].ipa[/code] file. If [code]false[/code], exports iOS project files and builds an XCArchive and [code].ipa[/code] file at the same time. When combining Godot with Fastlane or other build pipelines, you may want to set this to [code]true[/code].
</member>
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<member name="application/icon_interpolation" type="int" setter="" getter="">
Interpolation method used to resize application icon.
</member>
[iOS export] Add export options for performance capabilities and min. iOS version.
2023-10-29 18:17:58 +00:00
<member name="application/min_ios_version" type="String" setter="" getter="">
Minimum version of iOS required for this application to run in the [code]major.minor.patch[/code] or [code]major.minor[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]).
</member>
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<member name="application/provisioning_profile_uuid_debug" type="String" setter="" getter="">
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See [url=https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles]Edit, download, or delete provisioning profiles[/url].
Store sensitive export options in dedicated credentials file
2023-05-10 09:40:17 +00:00
Can be overridden with the environment variable [code]GODOT_IOS_PROVISIONING_PROFILE_UUID_DEBUG[/code].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="application/provisioning_profile_uuid_release" type="String" setter="" getter="">
UUID of the provisioning profile. If left empty, Xcode will download or create a provisioning profile automatically. See [url=https://developer.apple.com/help/account/manage-profiles/edit-download-or-delete-profiles]Edit, download, or delete provisioning profiles[/url].
Store sensitive export options in dedicated credentials file
2023-05-10 09:40:17 +00:00
Can be overridden with the environment variable [code]GODOT_IOS_PROVISIONING_PROFILE_UUID_RELEASE[/code].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="application/short_version" type="String" setter="" getter="">
Add a "version" project setting and use it in new export presets This makes it easy to retrieve the project version at runtime for display purposes, while simplifying the export preset configuration. You can now leave the version empty unless you need to override it on a per-preset basis. Since export presets save the values of default values to the `export_presets.cfg` file, this change only affects export presets created after this commit was merged.
2023-07-17 07:53:45 +00:00
Application version visible to the user, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). Falls back to [member ProjectSettings.application/config/version] if left empty.
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="application/signature" type="String" setter="" getter="">
A four-character creator code that is specific to the bundle. Optional.
</member>
<member name="application/targeted_device_family" type="int" setter="" getter="">
Supported device family.
</member>
<member name="application/version" type="String" setter="" getter="">
Add a "version" project setting and use it in new export presets This makes it easy to retrieve the project version at runtime for display purposes, while simplifying the export preset configuration. You can now leave the version empty unless you need to override it on a per-preset basis. Since export presets save the values of default values to the `export_presets.cfg` file, this change only affects export presets created after this commit was merged.
2023-07-17 07:53:45 +00:00
Machine-readable application version, in the [code]major.minor.patch[/code] format, can only contain numeric characters ([code]0-9[/code]) and periods ([code].[/code]). This must be incremented on every new release pushed to the App Store.
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="architectures/arm64" type="bool" setter="" getter="">
If [code]true[/code], [code]arm64[/code] binaries are included into exported project.
</member>
<member name="capabilities/access_wifi" type="bool" setter="" getter="">
If [code]true[/code], networking features related to Wi-Fi access are enabled. See [url=https://developer.apple.com/support/required-device-capabilities/]Required Device Capabilities[/url].
</member>
[iOS export] Add export options for performance capabilities and min. iOS version.
2023-10-29 18:17:58 +00:00
<member name="capabilities/performance_a12" type="bool" setter="" getter="">
Requires the graphics performance and features of the A12 Bionic and later chips (devices supporting all Vulkan renderer features).
Enabling this option limits supported devices to: iPhone XS, iPhone XR, iPad Mini (5th gen.), iPad Air (3rd gen.), iPad (8th gen) and newer.
</member>
<member name="capabilities/performance_gaming_tier" type="bool" setter="" getter="">
Requires the graphics performance and features of the A17 Pro and later chips.
Enabling this option limits supported devices to: iPhone 15 Pro and newer.
</member>
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<member name="capabilities/push_notifications" type="bool" setter="" getter="">
If [code]true[/code], push notifications are enabled. See [url=https://developer.apple.com/support/required-device-capabilities/]Required Device Capabilities[/url].
</member>
<member name="custom_template/debug" type="String" setter="" getter="">
Path to the custom export template. If left empty, default template is used.
</member>
<member name="custom_template/release" type="String" setter="" getter="">
Path to the custom export template. If left empty, default template is used.
</member>
<member name="icons/app_store_1024x1024" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
App Store application icon file. If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
Make documentation sorting use natural order
2023-05-04 13:18:56 +00:00
<member name="icons/ipad_76x76" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Home screen application icon file on iPad (1x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
Make documentation sorting use natural order
2023-05-04 13:18:56 +00:00
</member>
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
<member name="icons/ipad_152x152" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Home screen application icon file on iPad (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/ipad_167x167" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Home screen application icon file on iPad (3x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/iphone_120x120" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Home screen application icon file on iPhone (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/iphone_180x180" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Home screen application icon file on iPhone (3x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/notification_40x40" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Notification icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/notification_60x60" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Notification icon file on iPhone (3x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/settings_58x58" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Application settings icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/settings_87x87" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Application settings icon file on iPhone (3x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/spotlight_40x40" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Spotlight icon file on iPad (1x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="icons/spotlight_80x80" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Spotlight icon file on iPad and iPhone (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/config/icon]. See [url=https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons]App icons[/url].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="privacy/camera_usage_description" type="String" setter="" getter="">
A message displayed when requesting access to the device's camera (in English).
</member>
<member name="privacy/camera_usage_description_localized" type="Dictionary" setter="" getter="">
A message displayed when requesting access to the device's camera (localized).
</member>
<member name="privacy/microphone_usage_description" type="String" setter="" getter="">
A message displayed when requesting access to the device's microphone (in English).
</member>
<member name="privacy/microphone_usage_description_localized" type="Dictionary" setter="" getter="">
A message displayed when requesting access to the device's microphone (localized).
</member>
<member name="privacy/photolibrary_usage_description" type="String" setter="" getter="">
A message displayed when requesting access to the user's photo library (in English).
</member>
<member name="privacy/photolibrary_usage_description_localized" type="Dictionary" setter="" getter="">
A message displayed when requesting access to the user's photo library (localized).
</member>
<member name="storyboard/custom_bg_color" type="Color" setter="" getter="">
A custom background color of the storyboard launch screen.
</member>
<member name="storyboard/custom_image@2x" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Application launch screen image file (2x DPI). If left empty, it will fallback to [member ProjectSettings.application/boot_splash/image].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="storyboard/custom_image@3x" type="String" setter="" getter="">
Enhance icon fallback and their docs for exporters
2023-06-03 22:28:50 +00:00
Application launch screen image file (3x DPI). If left empty, it will fallback to [member ProjectSettings.application/boot_splash/image].
[Export] Add readable descriptions and validation warnings to the export options.
2023-03-09 08:41:52 +00:00
</member>
<member name="storyboard/image_scale_mode" type="int" setter="" getter="">
Launch screen image scaling mode.
</member>
<member name="storyboard/use_custom_bg_color" type="bool" setter="" getter="">
If [code]true[/code], [member storyboard/custom_bg_color] is used as a launch screen background color, otherwise [code]application/boot_splash/bg_color[/code] project setting is used.
</member>
<member name="user_data/accessible_from_files_app" type="bool" setter="" getter="">
If [code]true[/code], the app "Documents" folder can be accessed via "Files" app. See [url=https://developer.apple.com/documentation/bundleresources/information_property_list/lssupportsopeningdocumentsinplace]LSSupportsOpeningDocumentsInPlace[/url].
</member>
<member name="user_data/accessible_from_itunes_sharing" type="bool" setter="" getter="">
If [code]true[/code], the app "Documents" folder can be accessed via iTunes file sharing. See [url=https://developer.apple.com/documentation/bundleresources/information_property_list/uifilesharingenabled]UIFileSharingEnabled[/url].
</member>
</members>
</class>