Documentation
¶
Overview ¶
Package EditorExportPlatformExtension provides methods for working with EditorExportPlatformExtension object instances.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsEditorExportPlatform() EditorExportPlatform.Instance
- func (self Instance) AsEditorExportPlatformExtension() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) GetConfigError() string
- func (self Instance) GetConfigMissingTemplates() bool
- func (self Instance) ID() ID
- func (self Instance) SetConfigError(error_text string)
- func (self Instance) SetConfigMissingTemplates(missing_templates bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
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 Extension ¶
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]) AsEditorExportPlatform ¶
func (self *Extension[T]) AsEditorExportPlatform() EditorExportPlatform.Instance
func (*Extension[T]) AsEditorExportPlatformExtension ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type 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.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.EditorExportPlatformExtension
External [EditorExportPlatform] implementations should inherit from this class. To use [EditorExportPlatform], register it using the [method EditorPlugin.add_export_platform] method first.
See [Interface] for methods that can be overridden by a [Class] that extends it.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEditorExportPlatform ¶
func (self Instance) AsEditorExportPlatform() EditorExportPlatform.Instance
func (Instance) AsEditorExportPlatformExtension ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) GetConfigError ¶
Returns current configuration error message text. This method should be called only from the [method _can_export], [method _has_valid_export_configuration], or [method _has_valid_project_configuration] implementations.
func (Instance) GetConfigMissingTemplates ¶
Returns [code]true[/code] is export templates are missing from the current configuration. This method should be called only from the [method _can_export], [method _has_valid_export_configuration], or [method _has_valid_project_configuration] implementations.
func (Instance) SetConfigError ¶
Sets current configuration error message text. This method should be called only from the [method _can_export], [method _has_valid_export_configuration], or [method _has_valid_project_configuration] implementations.
func (Instance) SetConfigMissingTemplates ¶
Set to [code]true[/code] is export templates are missing from the current configuration. This method should be called only from the [method _can_export], [method _has_valid_export_configuration], or [method _has_valid_project_configuration] implementations.
type Interface ¶
type Interface interface { //[b]Required.[/b] //Returns array of platform specific features for the specified [param preset]. GetPresetFeatures(preset EditorExportPreset.Instance) []string //[b]Optional.[/b] //Returns [code]true[/code] if specified file is a valid executable (native executable or script) for the target platform. IsExecutable(path string) bool //[b]Optional.[/b] //Returns a property list, as an [Array] of dictionaries. Each [Dictionary] must at least contain the [code]name: StringName[/code] and [code]type: Variant.Type[/code] entries. //Additionally, the following keys are supported: //- [code]hint: PropertyHint[/code] //- [code]hint_string: String[/code] //- [code]usage: PropertyUsageFlags[/code] //- [code]class_name: StringName[/code] //- [code]default_value: Variant[/code], default value of the property. //- [code]update_visibility: bool[/code], if set to [code]true[/code], [method _get_export_option_visibility] is called for each property when this property is changed. //- [code]required: bool[/code], if set to [code]true[/code], this property warnings are critical, and should be resolved to make export possible. This value is a hint for the [method _has_valid_export_configuration] implementation, and not used by the engine directly. //See also [method Object._get_property_list]. GetExportOptions() []map[any]any //[b]Optional.[/b] //Returns [code]true[/code] if export options list is changed and presets should be updated. ShouldUpdateExportOptions() bool //[b]Optional.[/b] //Validates [param option] and returns visibility for the specified [param preset]. Default implementation return [code]true[/code] for all options. GetExportOptionVisibility(preset EditorExportPreset.Instance, option string) bool //[b]Optional.[/b] //Validates [param option] and returns warning message for the specified [param preset]. Default implementation return empty string for all options. GetExportOptionWarning(preset EditorExportPreset.Instance, option string) string //[b]Required.[/b] //Returns target OS name. GetOsName() string //[b]Required.[/b] //Returns export platform name. GetName() string //[b]Required.[/b] //Returns platform logo displayed in the export dialog, logo should be 32x32 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. GetLogo() Texture2D.Instance //[b]Optional.[/b] //Returns [code]true[/code] if one-click deploy options are changed and editor interface should be updated. PollExport() bool //[b]Optional.[/b] //Returns number one-click deploy devices (or other one-click option displayed in the menu). GetOptionsCount() int //[b]Optional.[/b] //Returns tooltip of the one-click deploy menu button. GetOptionsTooltip() string //[b]Optional.[/b] //Returns one-click deploy menu item icon for the specified [param device], icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. GetOptionIcon(device int) ImageTexture.Instance //[b]Optional.[/b] //Returns one-click deploy menu item label for the specified [param device]. GetOptionLabel(device int) string //[b]Optional.[/b] //Returns one-click deploy menu item tooltip for the specified [param device]. GetOptionTooltip(device int) string //[b]Optional.[/b] //Returns device architecture for one-click deploy. GetDeviceArchitecture(device int) string //[b]Optional.[/b] //Called by the editor before platform is unregistered. Cleanup() //[b]Optional.[/b] //This method is called when [param device] one-click deploy menu option is selected. //Implementation should export project to a temporary location, upload and run it on the specific [param device], or perform another action associated with the menu item. Run(preset EditorExportPreset.Instance, device int, debug_flags EditorExportPlatform.DebugFlags) error //[b]Optional.[/b] //Returns icon of the one-click deploy menu button, icon should be 16x16 adjusted to the current editor scale, see [method EditorInterface.get_editor_scale]. GetRunIcon() Texture2D.Instance //[b]Optional.[/b] //Returns [code]true[/code], if specified [param preset] is valid and can be exported. Use [method set_config_error] and [method set_config_missing_templates] to set error details. //Usual implementation can call [method _has_valid_export_configuration] and [method _has_valid_project_configuration] to determine if export is possible. CanExport(preset EditorExportPreset.Instance, debug bool) bool //[b]Required.[/b] //Returns [code]true[/code] if export configuration is valid. HasValidExportConfiguration(preset EditorExportPreset.Instance, debug bool) bool //[b]Required.[/b] //Returns [code]true[/code] if project configuration is valid. HasValidProjectConfiguration(preset EditorExportPreset.Instance) bool //[b]Required.[/b] //Returns array of supported binary extensions for the full project export. GetBinaryExtensions(preset EditorExportPreset.Instance) []string //[b]Required.[/b] //Creates a full project at [param path] for the specified [param preset]. //This method is called when "Export" button is pressed in the export dialog. //This method implementation can call [method EditorExportPlatform.save_pack] or [method EditorExportPlatform.save_zip] to use default PCK/ZIP export process, or calls [method EditorExportPlatform.export_project_files] and implement custom callback for processing each exported file. ExportProject(preset EditorExportPreset.Instance, debug bool, path string, flags EditorExportPlatform.DebugFlags) error //[b]Optional.[/b] //Creates a PCK archive at [param path] for the specified [param preset]. //This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type. ExportPack(preset EditorExportPreset.Instance, debug bool, path string, flags EditorExportPlatform.DebugFlags) error //[b]Optional.[/b] //Create a ZIP archive at [param path] for the specified [param preset]. //This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type. ExportZip(preset EditorExportPreset.Instance, debug bool, path string, flags EditorExportPlatform.DebugFlags) error //[b]Optional.[/b] //Creates a patch PCK archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. //This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type. //[b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. ExportPackPatch(preset EditorExportPreset.Instance, debug bool, path string, patches []string, flags EditorExportPlatform.DebugFlags) error //[b]Optional.[/b] //Create a ZIP archive at [param path] for the specified [param preset], containing only the files that have changed since the last patch. //This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type. //[b]Note:[/b] The patches provided in [param patches] have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. ExportZipPatch(preset EditorExportPreset.Instance, debug bool, path string, patches []string, flags EditorExportPlatform.DebugFlags) error //[b]Required.[/b] //Returns array of platform specific features. GetPlatformFeatures() []string //[b]Optional.[/b] //Returns protocol used for remote debugging. Default implementation return [code]tcp://[/code]. GetDebugProtocol() string }