Inheritance #

Object
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
RefCounted
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
EditorExportPreset

Table of contents

EditorExportPreset #

is_refcounted, editor, not_builtin_classes

Export preset configuration.

Export preset configuration. Instances of EditorExportPreset by editor UI and intended to be used a read-only configuration passed to the EditorExportPlatform methods when exporting the project.

Members #

Methods #

const func are_advanced_options_enabled() -> bool#

Returns true if "Advanced" toggle is enabled in the export dialog.

const func get_custom_features() -> String#

Returns string with a comma separated list of custom features.

const func get_customized_files() -> Dictionary#

Returns Dictionary of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - "strip", "keep", or "remove". See also get_file_export_mode.

const func get_customized_files_count() -> int#

Returns number of files selected in the "Resources" tab of the export dialog.

const func get_encrypt_directory() -> bool#

Returns true, PCK directory encryption is enabled in the export dialog.

const func get_encrypt_pck() -> bool#

Returns true, PCK encryption is enabled in the export dialog.

const func get_encryption_ex_filter() -> String#

Returns file filters to exclude during PCK encryption.

const func get_encryption_in_filter() -> String#

Returns file filters to include during PCK encryption.

const func get_encryption_key() -> String#

Returns PCK encryption key.

const func get_exclude_filter() -> String#

Returns file filters to exclude during export.

const func get_export_filter() -> intEditorExportPreset.ExportFilter#

Returns export file filter mode selected in the "Resources" tab of the export dialog.

const func get_export_path() -> String#

Returns export target path.

const func get_file_export_mode(default: int = 0 enumEditorExportPreset.FileExportMode) -> intEditorExportPreset.FileExportMode#

Returns file export mode for the specified file.

const func get_files_to_export() -> PackedStringArray#

Returns array of files to export.

const func get_include_filter() -> String#

Returns file filters to include during export.

const func get_or_env(env_var: String) -> Variant#

Returns export option value or value of environment variable if it is set.

const func get_patches() -> PackedStringArray#

Returns the list of packs on which to base a patch export on.

const func get_preset_name() -> String#

Returns export preset name.

const func get_script_export_mode() -> int#

Returns script export mode.

const func get_version(windows_version: bool) -> String#

Returns the preset's version number, or fall back to the ProjectSettings.application/config/version project setting if set to an empty string.

If windows_version is true, formats the returned version number to be compatible with Windows executable metadata.

const func has(property: StringName) -> bool#

Returns true if preset has specified property.

func has_export_file(path: String) -> bool#

Returns true if specified file is exported.

const func is_dedicated_server() -> bool#

Returns true if dedicated server export mode is selected in the export dialog.

const func is_runnable() -> bool#

Returns true if "Runnable" toggle is enabled in the export dialog.

Annotations #

Constants #

const EXPORT_ALL_RESOURCES = 0 enum ExportFilter#

const EXPORT_SELECTED_SCENES = 1 enum ExportFilter#

const EXPORT_SELECTED_RESOURCES = 2 enum ExportFilter#

const EXCLUDE_SELECTED_RESOURCES = 3 enum ExportFilter#

const EXPORT_CUSTOMIZED = 4 enum ExportFilter#

const MODE_FILE_NOT_CUSTOMIZED = 0 enum FileExportMode#

const MODE_FILE_STRIP = 1 enum FileExportMode#

const MODE_FILE_KEEP = 2 enum FileExportMode#

const MODE_FILE_REMOVE = 3 enum FileExportMode#

const MODE_SCRIPT_TEXT = 0 enum ScriptExportMode#

const MODE_SCRIPT_BINARY_TOKENS = 1 enum ScriptExportMode#

const MODE_SCRIPT_BINARY_TOKENS_COMPRESSED = 2 enum ScriptExportMode#

Constructors #

Enums #

ExportFilter#

enum ExportFilter { EXPORT_ALL_RESOURCES = 0, EXPORT_SELECTED_SCENES = 1, EXPORT_SELECTED_RESOURCES = 2, EXCLUDE_SELECTED_RESOURCES = 3, EXPORT_CUSTOMIZED = 4, }

FileExportMode#

enum FileExportMode { MODE_FILE_NOT_CUSTOMIZED = 0, MODE_FILE_STRIP = 1, MODE_FILE_KEEP = 2, MODE_FILE_REMOVE = 3, }

ScriptExportMode#

enum ScriptExportMode { MODE_SCRIPT_TEXT = 0, MODE_SCRIPT_BINARY_TOKENS = 1, MODE_SCRIPT_BINARY_TOKENS_COMPRESSED = 2, }

Operators #

Signals #

Theme Items #

Tutorials #