Inheritance #

EditorExportPlatformAndroid #

is_refcounted, is_instantiable, editor, not_builtin_classes

Exporter for Android.

Members #

var apk_expansion/SALT: String#

Array of random bytes that the licensing Policy uses to create an Obfuscator.

var apk_expansion/enable: bool#

If true, project resources are stored in the separate APK expansion file, instead of the APK.

Note: APK expansion should be enabled to use PCK encryption. See APK Expansion Files

var apk_expansion/public_key: String#

Base64 encoded RSA public key for your publisher account, available from the profile page on the "Google Play Console".

var architectures/arm64-v8a: bool#

If true, arm64 binaries are included into exported project.

var architectures/armeabi-v7a: bool#

If true, arm32 binaries are included into exported project.

var architectures/x86: bool#

If true, x86_32 binaries are included into exported project.

var architectures/x86_64: bool#

If true, x86_64 binaries are included into exported project.

var command_line/extra_args: String#

A list of additional command line arguments, separated by space, which the exported project will receive when started.

var custom_template/debug: String#

Path to an APK file to use as a custom export template for debug exports. If left empty, default template is used.

Note: This is only used if EditorExportPlatformAndroid.gradle_build/use_gradle_build is disabled.

var custom_template/release: String#

Path to an APK file to use as a custom export template for release exports. If left empty, default template is used.

Note: This is only used if EditorExportPlatformAndroid.gradle_build/use_gradle_build is disabled.

var gesture/swipe_to_dismiss: bool#

If true, Swipe to dismiss will be enabled.

This functionality is intended for smartwatches and is generally ignored on standard Android devices. However, some devices may not ignore it. Therefore, it is recommended to keep this feature disabled for standard Android apps to avoid unexpected behavior.

Note: This is false by default. To enable this behavior, EditorExportPlatformAndroid.gradle_build/use_gradle_build is required.

var gradle_build/android_source_template: String#

Path to a ZIP file holding the source for the export template used in a Gradle build. If left empty, the default template is used.

var gradle_build/compress_native_libraries: bool#

If true, native libraries are compressed when performing a Gradle build.

Note: Although your binary may be smaller, your application may load slower because the native libraries are not loaded directly from the binary at runtime.

var gradle_build/export_format: int#

Application export format (*.apk or *.aab).

var gradle_build/gradle_build_directory: String#

Path to the Gradle build directory. If left empty, then res://android will be used.

var gradle_build/min_sdk: String#

Minimum Android API level required for the application to run (used during Gradle build). See android:minSdkVersion.

var gradle_build/target_sdk: String#

The Android API level on which the application is designed to run (used during Gradle build). See android:targetSdkVersion.

var gradle_build/use_gradle_build: bool#

If true, Gradle build is used instead of pre-built APK.

var graphics/opengl_debug: bool#

If true, OpenGL ES debug context will be created (additional runtime checking, validation, and logging).

var keystore/debug: String#

Path of the debug keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_DEBUG_PATH.

Fallbacks to EditorSettings.export/android/debug_keystore if empty.

var keystore/debug_password: String#

Password for the debug keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_DEBUG_PASSWORD.

Fallbacks to EditorSettings.export/android/debug_keystore_pass if both it and keystore/debug are empty.

var keystore/debug_user: String#

User name for the debug keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_DEBUG_USER.

Fallbacks to EditorSettings.export/android/debug_keystore_user if both it and keystore/debug are empty.

var keystore/release: String#

Path of the release keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_RELEASE_PATH.

var keystore/release_password: String#

Password for the release keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_RELEASE_PASSWORD.

var keystore/release_user: String#

User name for the release keystore file.

Can be overridden with the environment variable GODOT_ANDROID_KEYSTORE_RELEASE_USER.

var launcher_icons/adaptive_background_432x432: String#

Background layer of the application adaptive icon file. See Design adaptive icons.

var launcher_icons/adaptive_foreground_432x432: String#

Foreground layer of the application adaptive icon file. See Design adaptive icons.

var launcher_icons/adaptive_monochrome_432x432: String#

Monochrome layer of the application adaptive icon file. See Design adaptive icons.

var launcher_icons/main_192x192: String#

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

var package/app_category: int#

Application category for the Google Play Store. Only define this if your application fits one of the categories well. See android:appCategory.

var package/exclude_from_recents: bool#

If true, task initiated by main activity will be excluded from the list of recently used applications. See android:excludeFromRecents.

var package/name: String#

Name of the application.

var package/retain_data_on_uninstall: bool#

If true, when the user uninstalls an app, a prompt to keep the app's data will be shown. See android:hasFragileUserData.

var package/show_as_launcher_app: bool#

If true, the user will be able to set this app as the system launcher in Android preferences.

var package/show_in_android_tv: bool#

If true, this app will show in Android TV launcher UI.

var package/show_in_app_library: bool#

If true, this app will show in the device's app library.

Note: This is true by default.

var package/signed: bool#

If true, package signing is enabled.

var package/unique_name: String#

Unique application identifier in a reverse-DNS format. The reverse DNS format should preferably match a domain name you control, but this is not strictly required. For instance, if you own example.com, your package unique name should preferably be of the form com.example.mygame. This identifier can only contain lowercase alphanumeric characters (a-z, and 0-9), underscores (_), and periods (.). Each component of the reverse DNS format must start with a letter: for instance, com.example.8game is not valid.

If $genname is present in the value, it will be replaced by the project name converted to lowercase. If there are invalid characters in the project name, they will be stripped. If all characters in the project name are stripped, $genname is replaced by noname.

Note: Changing the package name will cause the package to be considered as a new package, with its own installation and data paths. The new package won't be usable to update existing installations.

Note: When publishing to Google Play, the package name must be globally unique. This means no other apps published on Google Play must be using the same package name as yours. Otherwise, you'll be prevented from publishing your app on Google Play.

var permissions/access_checkin_properties: bool#

Allows read/write access to the "properties" table in the checkin database. See ACCESS_CHECKIN_PROPERTIES.

var permissions/access_coarse_location: bool#

Allows access to the approximate location information. See ACCESS_COARSE_LOCATION.

var permissions/access_fine_location: bool#

Allows access to the precise location information. See ACCESS_FINE_LOCATION.

var permissions/access_location_extra_commands: bool#

Allows access to the extra location provider commands. See ACCESS_LOCATION_EXTRA_COMMANDS.

var permissions/access_media_location: bool#

Allows an application to access any geographic locations persisted in the user's shared collection. See ACCESS_MEDIA_LOCATION.

var permissions/access_mock_location: bool#

Allows an application to create mock location providers for testing.

var permissions/access_network_state: bool#

Allows access to the information about networks. See ACCESS_NETWORK_STATE.

var permissions/access_surface_flinger: bool#

Allows an application to use SurfaceFlinger's low level features.

var permissions/access_wifi_state: bool#

Allows access to the information about Wi-Fi networks. See ACCESS_WIFI_STATE.

var permissions/account_manager: bool#

Allows applications to call into AccountAuthenticators. See ACCOUNT_MANAGER.

var permissions/add_voicemail: bool#

Allows an application to add voicemails into the system. See ADD_VOICEMAIL.

var permissions/authenticate_accounts: bool#

Allows an application to act as an AccountAuthenticator for the AccountManager.

var permissions/battery_stats: bool#

Allows an application to collect battery statistics. See BATTERY_STATS.

var permissions/bind_accessibility_service: bool#

Must be required by an AccessibilityService, to ensure that only the system can bind to it. See BIND_ACCESSIBILITY_SERVICE.

var permissions/bind_appwidget: bool#

Allows an application to tell the AppWidget service which application can access AppWidget's data. See BIND_APPWIDGET.

var permissions/bind_device_admin: bool#

Must be required by device administration receiver, to ensure that only the system can interact with it. See BIND_DEVICE_ADMIN.

var permissions/bind_input_method: bool#

Must be required by an InputMethodService, to ensure that only the system can bind to it. See BIND_INPUT_METHOD.

var permissions/bind_nfc_service: bool#

Must be required by a HostApduService or OffHostApduService to ensure that only the system can bind to it. See BIND_NFC_SERVICE.

var permissions/bind_notification_listener_service: bool#

Must be required by a NotificationListenerService, to ensure that only the system can bind to it. See BIND_NOTIFICATION_LISTENER_SERVICE.

var permissions/bind_print_service: bool#

Must be required by a PrintService, to ensure that only the system can bind to it. See BIND_PRINT_SERVICE.

var permissions/bind_remoteviews: bool#

Must be required by a RemoteViewsService, to ensure that only the system can bind to it. See BIND_REMOTEVIEWS.

var permissions/bind_text_service: bool#

Must be required by a TextService (e.g. SpellCheckerService) to ensure that only the system can bind to it. See BIND_TEXT_SERVICE.

var permissions/bind_vpn_service: bool#

Must be required by a VpnService, to ensure that only the system can bind to it. See BIND_VPN_SERVICE.

var permissions/bind_wallpaper: bool#

Must be required by a WallpaperService, to ensure that only the system can bind to it. See BIND_WALLPAPER.

var permissions/bluetooth: bool#

Allows applications to connect to paired bluetooth devices. See BLUETOOTH.

var permissions/bluetooth_admin: bool#

Allows applications to discover and pair bluetooth devices. See BLUETOOTH_ADMIN.

var permissions/bluetooth_privileged: bool#

Allows applications to pair bluetooth devices without user interaction, and to allow or disallow phonebook access or message access. See BLUETOOTH_PRIVILEGED.

var permissions/brick: bool#

Required to be able to disable the device (very dangerous!).

var permissions/broadcast_package_removed: bool#

Allows an application to broadcast a notification that an application package has been removed. See BROADCAST_PACKAGE_REMOVED.

var permissions/broadcast_sms: bool#

Allows an application to broadcast an SMS receipt notification. See BROADCAST_SMS.

var permissions/broadcast_sticky: bool#

Allows an application to broadcast sticky intents. See BROADCAST_STICKY.

var permissions/broadcast_wap_push: bool#

Allows an application to broadcast a WAP PUSH receipt notification. See BROADCAST_WAP_PUSH.

var permissions/call_phone: bool#

Allows an application to initiate a phone call without going through the Dialer user interface. See CALL_PHONE.

var permissions/call_privileged: bool#

Allows an application to call any phone number, including emergency numbers, without going through the Dialer user interface. See CALL_PRIVILEGED.

var permissions/camera: bool#

Required to be able to access the camera device. See CAMERA.

var permissions/capture_audio_output: bool#

Allows an application to capture audio output. See CAPTURE_AUDIO_OUTPUT.

var permissions/capture_secure_video_output: bool#

Allows an application to capture secure video output.

var permissions/capture_video_output: bool#

Allows an application to capture video output.

var permissions/change_component_enabled_state: bool#

Allows an application to change whether an application component (other than its own) is enabled or not. See CHANGE_COMPONENT_ENABLED_STATE.

var permissions/change_configuration: bool#

Allows an application to modify the current configuration, such as locale. See CHANGE_CONFIGURATION.

var permissions/change_network_state: bool#

Allows applications to change network connectivity state. See CHANGE_NETWORK_STATE.

var permissions/change_wifi_multicast_state: bool#

Allows applications to enter Wi-Fi Multicast mode. See CHANGE_WIFI_MULTICAST_STATE.

var permissions/change_wifi_state: bool#

Allows applications to change Wi-Fi connectivity state. See CHANGE_WIFI_STATE.

var permissions/clear_app_cache: bool#

Allows an application to clear the caches of all installed applications on the device. See CLEAR_APP_CACHE.

var permissions/clear_app_user_data: bool#

Allows an application to clear user data.

var permissions/control_location_updates: bool#

Allows enabling/disabling location update notifications from the radio. See CONTROL_LOCATION_UPDATES.

var permissions/custom_permissions: PackedStringArray#

Array of custom permission strings.

var permissions/delete_cache_files: bool#

var permissions/delete_packages: bool#

Allows an application to delete packages. See DELETE_PACKAGES.

var permissions/device_power: bool#

Allows low-level access to power management.

var permissions/diagnostic: bool#

Allows applications to RW to diagnostic resources. See DIAGNOSTIC.

var permissions/disable_keyguard: bool#

Allows applications to disable the keyguard if it is not secure. See DISABLE_KEYGUARD.

var permissions/dump: bool#

Allows an application to retrieve state dump information from system services. See DUMP.

var permissions/expand_status_bar: bool#

Allows an application to expand or collapse the status bar. See EXPAND_STATUS_BAR.

var permissions/factory_test: bool#

Run as a manufacturer test application, running as the root user. See FACTORY_TEST.

var permissions/flashlight: bool#

Allows access to the flashlight.

var permissions/force_back: bool#

Allows an application to force a BACK operation on whatever is the top activity.

var permissions/get_accounts: bool#

Allows access to the list of accounts in the Accounts Service. See GET_ACCOUNTS.

var permissions/get_package_size: bool#

Allows an application to find out the space used by any package. See GET_PACKAGE_SIZE.

var permissions/get_tasks: bool#

var permissions/get_top_activity_info: bool#

Allows an application to retrieve private information about the current top activity.

var permissions/global_search: bool#

Used on content providers to allow the global search system to access their data. See GLOBAL_SEARCH.

var permissions/hardware_test: bool#

Allows access to hardware peripherals.

var permissions/inject_events: bool#

Allows an application to inject user events (keys, touch, trackball) into the event stream and deliver them to ANY window.

var permissions/install_location_provider: bool#

Allows an application to install a location provider into the Location Manager. See INSTALL_LOCATION_PROVIDER.

var permissions/install_packages: bool#

Allows an application to install packages. See INSTALL_PACKAGES.

var permissions/install_shortcut: bool#

Allows an application to install a shortcut in Launcher. See INSTALL_SHORTCUT.

var permissions/internal_system_window: bool#

Allows an application to open windows that are for use by parts of the system user interface.

var permissions/internet: bool#

Allows applications to open network sockets. See INTERNET.

var permissions/kill_background_processes: bool#

Allows an application to call ActivityManager.killBackgroundProcesses(String). See KILL_BACKGROUND_PROCESSES.

var permissions/location_hardware: bool#

Allows an application to use location features in hardware, such as the geofencing api. See LOCATION_HARDWARE.

var permissions/manage_accounts: bool#

Allows an application to manage the list of accounts in the AccountManager.

var permissions/manage_app_tokens: bool#

Allows an application to manage (create, destroy, Z-order) application tokens in the window manager.

var permissions/manage_documents: bool#

Allows an application to manage access to documents, usually as part of a document picker. See MANAGE_DOCUMENTS.

var permissions/manage_external_storage: bool#

Allows an application a broad access to external storage in scoped storage. See MANAGE_EXTERNAL_STORAGE.

var permissions/master_clear: bool#

See MASTER_CLEAR.

var permissions/media_content_control: bool#

Allows an application to know what content is playing and control its playback. See MEDIA_CONTENT_CONTROL.

var permissions/modify_audio_settings: bool#

Allows an application to modify global audio settings. See MODIFY_AUDIO_SETTINGS.

var permissions/modify_phone_state: bool#

Allows modification of the telephony state - power on, mmi, etc. Does not include placing calls. See MODIFY_PHONE_STATE.

var permissions/mount_format_filesystems: bool#

Allows formatting file systems for removable storage. See MOUNT_FORMAT_FILESYSTEMS.

var permissions/mount_unmount_filesystems: bool#

Allows mounting and unmounting file systems for removable storage. See MOUNT_UNMOUNT_FILESYSTEMS.

var permissions/nfc: bool#

Allows applications to perform I/O operations over NFC. See NFC.

var permissions/persistent_activity: bool#

Allows an application to make its activities persistent.

var permissions/post_notifications: bool#

Allows an application to post notifications. Added in API level 33. See Notification runtime permission.

var permissions/process_outgoing_calls: bool#

Allows an application to see the number being dialed during an outgoing call with the option to redirect the call to a different number or abort the call altogether. See PROCESS_OUTGOING_CALLS.

var permissions/read_calendar: bool#

Allows an application to read the user's calendar data. See READ_CALENDAR.

var permissions/read_call_log: bool#

Allows an application to read the user's call log. See READ_CALL_LOG.

var permissions/read_contacts: bool#

Allows an application to read the user's contacts data. See READ_CONTACTS.

var permissions/read_external_storage: bool#

Allows an application to read from external storage. See READ_EXTERNAL_STORAGE.

var permissions/read_frame_buffer: bool#

Allows an application to take screen shots and more generally get access to the frame buffer data.

var permissions/read_history_bookmarks: bool#

Allows an application to read (but not write) the user's browsing history and bookmarks.

var permissions/read_input_state: bool#

var permissions/read_logs: bool#

Allows an application to read the low-level system log files. See READ_LOGS.

var permissions/read_media_audio: bool#

Allows an application to read audio files from external storage. See READ_MEDIA_AUDIO.

var permissions/read_media_images: bool#

Allows an application to read image files from external storage. See READ_MEDIA_IMAGES.

var permissions/read_media_video: bool#

Allows an application to read video files from external storage. See READ_MEDIA_VIDEO.

var permissions/read_media_visual_user_selected: bool#

Allows an application to read image or video files from external storage that a user has selected via the permission prompt photo picker. See READ_MEDIA_VISUAL_USER_SELECTED.

var permissions/read_phone_state: bool#

Allows read only access to phone state. See READ_PHONE_STATE.

var permissions/read_profile: bool#

Allows an application to read the user's personal profile data.

var permissions/read_sms: bool#

Allows an application to read SMS messages. See READ_SMS.

var permissions/read_social_stream: bool#

Allows an application to read from the user's social stream.

var permissions/read_sync_settings: bool#

Allows applications to read the sync settings. See READ_SYNC_SETTINGS.

var permissions/read_sync_stats: bool#

Allows applications to read the sync stats. See READ_SYNC_STATS.

var permissions/read_user_dictionary: bool#

Allows an application to read the user dictionary.

var permissions/reboot: bool#

Required to be able to reboot the device. See REBOOT.

var permissions/receive_boot_completed: bool#

Allows an application to receive the Intent.ACTION_BOOT_COMPLETED that is broadcast after the system finishes booting. See RECEIVE_BOOT_COMPLETED.

var permissions/receive_mms: bool#

Allows an application to monitor incoming MMS messages. See RECEIVE_MMS.

var permissions/receive_sms: bool#

Allows an application to receive SMS messages. See RECEIVE_SMS.

var permissions/receive_wap_push: bool#

Allows an application to receive WAP push messages. See RECEIVE_WAP_PUSH.

var permissions/record_audio: bool#

Allows an application to record audio. See RECORD_AUDIO.

var permissions/reorder_tasks: bool#

Allows an application to change the Z-order of tasks. See REORDER_TASKS.

var permissions/restart_packages: bool#

var permissions/send_respond_via_message: bool#

Allows an application (Phone) to send a request to other applications to handle the respond-via-message action during incoming calls. See SEND_RESPOND_VIA_MESSAGE.

var permissions/send_sms: bool#

Allows an application to send SMS messages. See SEND_SMS.

var permissions/set_activity_watcher: bool#

Allows an application to watch and control how activities are started globally in the system.

var permissions/set_alarm: bool#

Allows an application to broadcast an Intent to set an alarm for the user. See SET_ALARM.

var permissions/set_always_finish: bool#

Allows an application to control whether activities are immediately finished when put in the background. See SET_ALWAYS_FINISH.

var permissions/set_animation_scale: bool#

Allows to modify the global animation scaling factor. See SET_ANIMATION_SCALE.

var permissions/set_debug_app: bool#

Configure an application for debugging. See SET_DEBUG_APP.

var permissions/set_orientation: bool#

Allows low-level access to setting the orientation (actually rotation) of the screen.

var permissions/set_pointer_speed: bool#

Allows low-level access to setting the pointer speed.

var permissions/set_preferred_applications: bool#

var permissions/set_process_limit: bool#

Allows an application to set the maximum number of (not needed) application processes that can be running. See SET_PROCESS_LIMIT.

var permissions/set_time: bool#

Allows applications to set the system time directly. See SET_TIME.

var permissions/set_time_zone: bool#

Allows applications to set the system time zone directly. See SET_TIME_ZONE.

var permissions/set_wallpaper: bool#

Allows applications to set the wallpaper. See SET_WALLPAPER.

var permissions/set_wallpaper_hints: bool#

Allows applications to set the wallpaper hints. See SET_WALLPAPER_HINTS.

var permissions/signal_persistent_processes: bool#

Allow an application to request that a signal be sent to all persistent processes. See SIGNAL_PERSISTENT_PROCESSES.

var permissions/status_bar: bool#

Allows an application to open, close, or disable the status bar and its icons. See STATUS_BAR.

var permissions/subscribed_feeds_read: bool#

Allows an application to allow access the subscribed feeds ContentProvider.

var permissions/subscribed_feeds_write: bool#

var permissions/system_alert_window: bool#

Allows an app to create windows using the type WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY, shown on top of all other apps. See SYSTEM_ALERT_WINDOW.

var permissions/transmit_ir: bool#

Allows using the device's IR transmitter, if available. See TRANSMIT_IR.

var permissions/uninstall_shortcut: bool#

var permissions/update_device_stats: bool#

Allows an application to update device statistics. See UPDATE_DEVICE_STATS.

var permissions/use_credentials: bool#

Allows an application to request authtokens from the AccountManager.

var permissions/use_sip: bool#

Allows an application to use SIP service. See USE_SIP.

var permissions/vibrate: bool#

Allows access to the vibrator. See VIBRATE.

var permissions/wake_lock: bool#

Allows using PowerManager WakeLocks to keep processor from sleeping or screen from dimming. See WAKE_LOCK.

var permissions/write_apn_settings: bool#

Allows applications to write the apn settings and read sensitive fields of an existing apn settings like user and password. See WRITE_APN_SETTINGS.

var permissions/write_calendar: bool#

Allows an application to write the user's calendar data. See WRITE_CALENDAR.

var permissions/write_call_log: bool#

Allows an application to write (but not read) the user's call log data. See WRITE_CALL_LOG.

var permissions/write_contacts: bool#

Allows an application to write the user's contacts data. See WRITE_CONTACTS.

var permissions/write_external_storage: bool#

Allows an application to write to external storage. See WRITE_EXTERNAL_STORAGE.

var permissions/write_gservices: bool#

Allows an application to modify the Google service map. See WRITE_GSERVICES.

var permissions/write_history_bookmarks: bool#

Allows an application to write (but not read) the user's browsing history and bookmarks.

var permissions/write_profile: bool#

Allows an application to write (but not read) the user's personal profile data.

var permissions/write_secure_settings: bool#

Allows an application to read or write the secure system settings. See WRITE_SECURE_SETTINGS.

var permissions/write_settings: bool#

Allows an application to read or write the system settings. See WRITE_SETTINGS.

var permissions/write_sms: bool#

Allows an application to write SMS messages.

var permissions/write_social_stream: bool#

Allows an application to write (but not read) the user's social stream data.

var permissions/write_sync_settings: bool#

Allows applications to write the sync settings. See WRITE_SYNC_SETTINGS.

var permissions/write_user_dictionary: bool#

Allows an application to write to the user dictionary.

var screen/immersive_mode: bool#

If true, hides navigation and status bar. See DisplayServer.window_set_mode to toggle it at runtime.

var screen/support_large: bool#

Indicates whether the application supports larger screen form-factors.

var screen/support_normal: bool#

Indicates whether an application supports the "normal" screen form-factors.

var screen/support_small: bool#

Indicates whether the application supports smaller screen form-factors.

var screen/support_xlarge: bool#

Indicates whether the application supports extra large screen form-factors.

var user_data_backup/allow: bool#

If true, allows the application to participate in the backup and restore infrastructure.

var version/code: int#

Machine-readable application version. This must be incremented for every new release pushed to the Play Store.

var version/name: String#

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

var xr_features/xr_mode: int#

The extended reality (XR) mode for this application.

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #