EditorExportPreset

package
v0.0.0-...-5dcec5f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2025 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

Package EditorExportPreset provides methods for working with EditorExportPreset object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEditorExportPreset() Instance
}

type Expanded

type Expanded [1]gdclass.EditorExportPreset

func (Expanded) GetFileExportMode

func (self Expanded) GetFileExportMode(path string, def FileExportMode) FileExportMode

Returns file export mode for the specified file.

type ExportFilter

type ExportFilter int //gd:EditorExportPreset.ExportFilter
const (
	ExportAllResources       ExportFilter = 0
	ExportSelectedScenes     ExportFilter = 1
	ExportSelectedResources  ExportFilter = 2
	ExcludeSelectedResources ExportFilter = 3
	ExportCustomized         ExportFilter = 4
)

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsEditorExportPreset

func (self *Extension[T]) AsEditorExportPreset() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type FileExportMode

type FileExportMode int //gd:EditorExportPreset.FileExportMode
const (
	ModeFileNotCustomized FileExportMode = 0
	ModeFileStrip         FileExportMode = 1
	ModeFileKeep          FileExportMode = 2
	ModeFileRemove        FileExportMode = 3
)

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.EditorExportPreset

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.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AreAdvancedOptionsEnabled

func (self Instance) AreAdvancedOptionsEnabled() bool

Returns [code]true[/code] if "Advanced" toggle is enabled in the export dialog.

func (Instance) AsEditorExportPreset

func (self Instance) AsEditorExportPreset() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) GetCustomFeatures

func (self Instance) GetCustomFeatures() string

Returns string with a comma separated list of custom features.

func (Instance) GetCustomizedFiles

func (self Instance) GetCustomizedFiles() map[string]string

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

func (Instance) GetCustomizedFilesCount

func (self Instance) GetCustomizedFilesCount() int

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

func (Instance) GetEncryptDirectory

func (self Instance) GetEncryptDirectory() bool

Returns [code]true[/code], PCK directory encryption is enabled in the export dialog.

func (Instance) GetEncryptPck

func (self Instance) GetEncryptPck() bool

Returns [code]true[/code], PCK encryption is enabled in the export dialog.

func (Instance) GetEncryptionExFilter

func (self Instance) GetEncryptionExFilter() string

Returns file filters to exclude during PCK encryption.

func (Instance) GetEncryptionInFilter

func (self Instance) GetEncryptionInFilter() string

Returns file filters to include during PCK encryption.

func (Instance) GetEncryptionKey

func (self Instance) GetEncryptionKey() string

Returns PCK encryption key.

func (Instance) GetExcludeFilter

func (self Instance) GetExcludeFilter() string

Returns file filters to exclude during export.

func (Instance) GetExportFilter

func (self Instance) GetExportFilter() ExportFilter

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

func (Instance) GetExportPath

func (self Instance) GetExportPath() string

Returns export target path.

func (Instance) GetFileExportMode

func (self Instance) GetFileExportMode(path string) FileExportMode

Returns file export mode for the specified file.

func (Instance) GetFilesToExport

func (self Instance) GetFilesToExport() []string

Returns array of files to export.

func (Instance) GetIncludeFilter

func (self Instance) GetIncludeFilter() string

Returns file filters to include during export.

func (Instance) GetOrEnv

func (self Instance) GetOrEnv(name string, env_var string) any

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

func (Instance) GetPatches

func (self Instance) GetPatches() []string

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

func (Instance) GetPresetName

func (self Instance) GetPresetName() string

Returns export preset name.

func (Instance) GetScriptExportMode

func (self Instance) GetScriptExportMode() int

Returns script export mode.

func (Instance) GetVersion

func (self Instance) GetVersion(name string, windows_version bool) string

Returns the preset's version number, or fall back to the [member ProjectSettings.application/config/version] project setting if set to an empty string. If [param windows_version] is [code]true[/code], formats the returned version number to be compatible with Windows executable metadata.

func (Instance) Has

func (self Instance) Has(property string) bool

Returns [code]true[/code] if preset has specified property.

func (Instance) HasExportFile

func (self Instance) HasExportFile(path string) bool

Returns [code]true[/code] if specified file is exported.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) IsDedicatedServer

func (self Instance) IsDedicatedServer() bool

Returns [code]true[/code] if dedicated server export mode is selected in the export dialog.

func (Instance) IsRunnable

func (self Instance) IsRunnable() bool

Returns [code]true[/code] if "Runnable" toggle is enabled in the export dialog.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type ScriptExportMode

type ScriptExportMode int //gd:EditorExportPreset.ScriptExportMode
const (
	ModeScriptText                   ScriptExportMode = 0
	ModeScriptBinaryTokens           ScriptExportMode = 1
	ModeScriptBinaryTokensCompressed ScriptExportMode = 2
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL