// AUTO-GENERATED /// declare module "godot" { class EditorFileServer extends Object { constructor(identifier?: any) } /** Resource filesystem, as the editor sees it. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorfilesystem.html */ class EditorFileSystem = Record> extends Node { constructor(identifier?: any) /** Gets the root directory object. */ get_filesystem(): EditorFileSystemDirectory /** Returns `true` if the filesystem is being scanned. */ is_scanning(): boolean /** Returns the scan progress for 0 to 1 if the FS is being scanned. */ get_scanning_progress(): float64 /** Scan the filesystem for changes. */ scan(): void /** Check if the source of any imported resource changed. */ scan_sources(): void /** Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program. * This will not import the file. To reimport, call [method reimport_files] or [method scan] methods. */ update_file(path: string): void /** Returns a view into the filesystem at [param path]. */ get_filesystem_path(path: string): EditorFileSystemDirectory /** Returns the resource type of the file, given the full path. This returns a string such as `"Resource"` or `"GDScript"`, *not* a file extension such as `".gd"`. */ get_file_type(path: string): string /** Reimports a set of files. Call this if these files or their `.import` files were directly edited by script or an external program. * If the file type changed or the file was newly created, use [method update_file] or [method scan]. * * **Note:** This function blocks until the import is finished. However, the main loop iteration, including timers and [method Node._process], will occur during the import process due to progress bar updates. Avoid calls to [method reimport_files] or [method scan] while an import is in progress. */ reimport_files(files: PackedStringArray | string[]): void /** Emitted if the filesystem changed. */ readonly filesystem_changed: Signal0 /** Emitted when the list of global script classes gets updated. */ readonly script_classes_updated: Signal0 /** Emitted if the source of any imported file changed. */ readonly sources_changed: Signal1 /** Emitted before a resource is reimported. */ readonly resources_reimporting: Signal1 /** Emitted if a resource is reimported. */ readonly resources_reimported: Signal1 /** Emitted if at least one resource is reloaded when the filesystem is scanned. */ readonly resources_reload: Signal1 } /** A directory for the resource filesystem. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorfilesystemdirectory.html */ class EditorFileSystemDirectory extends Object { constructor(identifier?: any) /** Returns the number of subdirectories in this directory. */ get_subdir_count(): int64 /** Returns the subdirectory at index [param idx]. */ get_subdir(idx: int64): EditorFileSystemDirectory /** Returns the number of files in this directory. */ get_file_count(): int64 /** Returns the name of the file at index [param idx]. */ get_file(idx: int64): string /** Returns the path to the file at index [param idx]. */ get_file_path(idx: int64): string /** Returns the resource type of the file at index [param idx]. This returns a string such as `"Resource"` or `"GDScript"`, *not* a file extension such as `".gd"`. */ get_file_type(idx: int64): StringName /** Returns the name of the script class defined in the file at index [param idx]. If the file doesn't define a script class using the `class_name` syntax, this will return an empty string. */ get_file_script_class_name(idx: int64): string /** Returns the base class of the script class defined in the file at index [param idx]. If the file doesn't define a script class using the `class_name` syntax, this will return an empty string. */ get_file_script_class_extends(idx: int64): string /** Returns `true` if the file at index [param idx] imported properly. */ get_file_import_is_valid(idx: int64): boolean /** Returns the name of this directory. */ get_name(): string /** Returns the path to this directory. */ get_path(): string /** Returns the parent directory for this directory or `null` if called on a directory at `res://` or `user://`. */ get_parent(): EditorFileSystemDirectory /** Returns the index of the file with name [param name] or `-1` if not found. */ find_file_index(name: string): int64 /** Returns the index of the directory with name [param name] or `-1` if not found. */ find_dir_index(name: string): int64 } /** Used to query and configure import format support. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorfilesystemimportformatsupportquery.html */ class EditorFileSystemImportFormatSupportQuery extends RefCounted { constructor(identifier?: any) /** Return whether this importer is active. */ /* gdvirtual */ _is_active(): boolean /** Return the file extensions supported. */ /* gdvirtual */ _get_file_extensions(): PackedStringArray /** Query support. Return `false` if import must not continue. */ /* gdvirtual */ _query(): boolean } class EditorFileSystemImportFormatSupportQueryBlend extends EditorFileSystemImportFormatSupportQuery { constructor(identifier?: any) } class EditorFontPreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorGradientPreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorHelpBit = Record> extends VBoxContainer { constructor(identifier?: any) readonly request_hide: Signal0 } class EditorHelpSearch = Record> extends ConfirmationDialog { constructor(identifier?: any) readonly go_to_help: Signal0 } class EditorImagePreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorImportBlendRunner = Record> extends Node { constructor(identifier?: any) } /** Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorimportplugin.html */ class EditorImportPlugin extends ResourceImporter { constructor(identifier?: any) /** Gets the unique name of the importer. */ /* gdvirtual */ _get_importer_name(): string /** Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". */ /* gdvirtual */ _get_visible_name(): string /** Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset. */ /* gdvirtual */ _get_preset_count(): int64 /** Gets the name of the options preset at this index. */ /* gdvirtual */ _get_preset_name(preset_index: int64): string /** Gets the list of file extensions to associate with this loader (case-insensitive). e.g. `["obj"]`. */ /* gdvirtual */ _get_recognized_extensions(): PackedStringArray /** Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: `name`, `default_value`, `property_hint` (optional), `hint_string` (optional), `usage` (optional). */ /* gdvirtual */ _get_import_options(path: string, preset_index: int64): GArray /** Gets the extension used to save this resource in the `.godot/imported` directory (see [member ProjectSettings.application/config/use_hidden_project_data_directory]). */ /* gdvirtual */ _get_save_extension(): string /** Gets the Godot resource type associated with this loader. e.g. `"Mesh"` or `"Animation"`. */ /* gdvirtual */ _get_resource_type(): string /** Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is `1.0`. */ /* gdvirtual */ _get_priority(): float64 /** Gets the order of this importer to be run when importing resources. Importers with *lower* import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is `0` unless overridden by a specific importer. See [enum ResourceImporter.ImportOrder] for some predefined values. */ /* gdvirtual */ _get_import_order(): int64 /** Gets the format version of this importer. Increment this version when making incompatible changes to the format of the imported resources. */ /* gdvirtual */ _get_format_version(): int64 /** This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. * * Returns `true` to make all options always visible. */ /* gdvirtual */ _get_option_visibility(path: string, option_name: StringName, options: GDictionary): boolean /** Imports [param source_file] into [param save_path] with the import [param options] specified. The [param platform_variants] and [param gen_files] arrays will be modified by this function. * This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. */ /* gdvirtual */ _import(source_file: string, save_path: string, options: GDictionary, platform_variants: GArray, gen_files: GArray): GError /** Tells whether this importer can be run in parallel on threads, or, on the contrary, it's only safe for the editor to call it from the main thread, for one file at a time. * If this method is not overridden, it will return `false` by default. * If this importer's implementation is thread-safe and can be run in parallel, override this with `true` to optimize for concurrency. */ /* gdvirtual */ _can_import_threaded(): boolean /** This function can only be called during the [method _import] callback and it allows manually importing resources from it. This is useful when the imported file generates external resources that require importing (as example, images). Custom parameters for the ".import" file can be passed via the [param custom_options]. Additionally, in cases where multiple importers can handle a file, the [param custom_importer] can be specified to force a specific one. This function performs a resource import and returns immediately with a success or error code. [param generator_parameters] defines optional extra metadata which will be stored as [code skip-lint]generator_parameters` in the `remap` section of the `.import` file, for example to store a md5 hash of the source data. */ append_import_external_resource(path: string, custom_options: GDictionary = new GDictionary(), custom_importer: string = '', generator_parameters: any = {}): GError } /** A control used to edit properties of an object. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorinspector.html */ class EditorInspector = Record> extends ScrollContainer { constructor(identifier?: any) /** Shows the properties of the given [param object] in this inspector for editing. To clear the inspector, call this method with `null`. * * **Note:** If you want to edit an object in the editor's main inspector, use the `edit_*` methods in [EditorInterface] instead. */ edit(object: Object): void _edit_request_change(_unnamed_arg0: Object, _unnamed_arg1: string): void /** Gets the path of the currently selected property. */ get_selected_path(): string /** Returns the object currently selected in this inspector. */ get_edited_object(): Object /** Creates a property editor that can be used by plugin UI to edit the specified property of an [param object]. */ static instantiate_property_editor(object: Object, type: Variant.Type, path: string, hint: PropertyHint, hint_text: string, usage: int64, wide: boolean = false): EditorProperty /** Emitted when a property is selected in the inspector. */ readonly property_selected: Signal1 /** Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. */ readonly property_keyed: Signal3 /** Emitted when a property is removed from the inspector. */ readonly property_deleted: Signal1 /** Emitted when a resource is selected in the inspector. */ readonly resource_selected: Signal2 /** Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree Inspector. */ readonly object_id_selected: Signal1 /** Emitted when a property is edited in the inspector. */ readonly property_edited: Signal1 /** Emitted when a boolean property is toggled in the inspector. * * **Note:** This signal is never emitted if the internal `autoclear` property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. */ readonly property_toggled: Signal2 /** Emitted when the object being edited by the inspector has changed. */ readonly edited_object_changed: Signal0 /** Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings. */ readonly restart_requested: Signal0 } class EditorInspectorCategory = Record> extends Control { constructor(identifier?: any) } class EditorInspectorDefaultPlugin extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorParticleProcessMaterialPlugin extends EditorInspectorPlugin { constructor(identifier?: any) } /** Plugin for adding custom property editors on the inspector. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorinspectorplugin.html */ class EditorInspectorPlugin extends RefCounted { constructor(identifier?: any) /** Returns `true` if this object can be handled by this plugin. */ /* gdvirtual */ _can_handle(object: Object): boolean /** Called to allow adding controls at the beginning of the property list for [param object]. */ /* gdvirtual */ _parse_begin(object: Object): void /** Called to allow adding controls at the beginning of a category in the property list for [param object]. */ /* gdvirtual */ _parse_category(object: Object, category: string): void /** Called to allow adding controls at the beginning of a group or a sub-group in the property list for [param object]. */ /* gdvirtual */ _parse_group(object: Object, group: string): void /** Called to allow adding property-specific editors to the property list for [param object]. The added editor control must extend [EditorProperty]. Returning `true` removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. */ /* gdvirtual */ _parse_property(object: Object, type: Variant.Type, name: string, hint_type: PropertyHint, hint_string: string, usage_flags: PropertyUsageFlags, wide: boolean): boolean /** Called to allow adding controls at the end of the property list for [param object]. */ /* gdvirtual */ _parse_end(object: Object): void /** Adds a custom control, which is not necessarily a property editor. */ add_custom_control(control: Control): void /** Adds a property editor for an individual property. The [param editor] control must extend [EditorProperty]. * There can be multiple property editors for a property. If [param add_to_end] is `true`, this newly added editor will be displayed after all the other editors of the property whose [param add_to_end] is `false`. For example, the editor uses this parameter to add an "Edit Region" button for [member Sprite2D.region_rect] below the regular [Rect2] editor. * [param label] can be used to choose a custom label for the property editor in the inspector. If left empty, the label is computed from the name of the property instead. */ add_property_editor(property: string, editor: Control, add_to_end: boolean = false, label: string = ''): void /** Adds an editor that allows modifying multiple properties. The [param editor] control must extend [EditorProperty]. */ add_property_editor_for_multiple_properties(label: string, properties: PackedStringArray | string[], editor: Control): void } class EditorInspectorPlugin3DTexture extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginAnimationMarkerKeyEdit extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginAnimationNodeAnimation extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginAnimationTrackKeyEdit extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginAudioStream extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginAudioStreamInteractive extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginBitMap extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginBoneMap extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginCamera3DPreview extends EditorInspectorPluginTexture { constructor(identifier?: any) } class EditorInspectorPluginControl extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginCurve extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginFontPreview extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginFontVariation extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginGradient extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginGradientTexture2D extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginInputEvent extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginLayeredTexture extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginMaterial extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginMesh extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginPackedScene extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginSkeleton extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginStyleBox extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginSubViewportPreview extends EditorInspectorPluginTexture { constructor(identifier?: any) } class EditorInspectorPluginSystemFont extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginTexture extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginTextureRegion extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorPluginTileData extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorRootMotionPlugin extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorSection = Record> extends Container { constructor(identifier?: any) setup(section: string, label: string, object: Object, bg_color: Color, foldable: boolean, indent_depth: int64 = 0, level: int64 = 1): void get_vbox(): VBoxContainer unfold(): void fold(): void } class EditorInspectorToolButtonPlugin extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorInspectorVisualShaderModePlugin extends EditorInspectorPlugin { constructor(identifier?: any) } class EditorJSONSyntaxHighlighter extends EditorSyntaxHighlighter { constructor(identifier?: any) } class EditorLayoutsDialog = Record> extends ConfirmationDialog { constructor(identifier?: any) readonly name_confirmed: Signal1 } class EditorLocaleDialog = Record> extends ConfirmationDialog { constructor(identifier?: any) readonly locale_selected: Signal1 } class EditorLog = Record> extends HBoxContainer { constructor(identifier?: any) } class EditorMainScreen = Record> extends PanelContainer { constructor(identifier?: any) } class EditorMarkdownSyntaxHighlighter extends EditorSyntaxHighlighter { constructor(identifier?: any) } class EditorMaterialPreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorMeshPreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorNativeShaderSourceVisualizer = Record> extends AcceptDialog { constructor(identifier?: any) _inspect_shader(_unnamed_arg0: RID): void } class EditorNetworkProfiler = Record> extends VBoxContainer { constructor(identifier?: any) readonly enable_profiling: Signal1 readonly open_request: Signal1 } class EditorNode = Record> extends Node { constructor(identifier?: any) push_item(object: Object, property: string = '', inspector_only: boolean = false): void set_edited_scene(_unnamed_arg0: Node): void stop_child_process(_unnamed_arg0: int64): void readonly request_help_search: Signal0 readonly script_add_function_request: Signal3 readonly resource_saved: Signal1 readonly scene_saved: Signal1 readonly scene_changed: Signal0 readonly scene_closed: Signal1 } /** Gizmo for editing [Node3D] objects. * * @link https://docs.godotengine.org/en/4.4/classes/class_editornode3dgizmo.html */ class EditorNode3DGizmo extends Node3DGizmo { constructor(identifier?: any) /** Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method clear] at the beginning of this method and then add visual elements depending on the node's properties. */ /* gdvirtual */ _redraw(): void /** Override this method to return the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. * The [param secondary] argument is `true` when the requested handle is secondary (see [method add_handles] for more information). */ /* gdvirtual */ _get_handle_name(id: int64, secondary: boolean): string /** Override this method to return `true` whenever the given handle should be highlighted in the editor. * The [param secondary] argument is `true` when the requested handle is secondary (see [method add_handles] for more information). */ /* gdvirtual */ _is_handle_highlighted(id: int64, secondary: boolean): boolean /** Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the `restore` argument in [method _commit_handle]. * The [param secondary] argument is `true` when the requested handle is secondary (see [method add_handles] for more information). */ /* gdvirtual */ _get_handle_value(id: int64, secondary: boolean): any /* gdvirtual */ _begin_handle_action(id: int64, secondary: boolean): void /** Override this method to update the node properties when the user drags a gizmo handle (previously added with [method add_handles]). The provided [param point] is the mouse position in screen coordinates and the [param camera] can be used to convert it to raycasts. * The [param secondary] argument is `true` when the edited handle is secondary (see [method add_handles] for more information). */ /* gdvirtual */ _set_handle(id: int64, secondary: boolean, camera: Camera3D, point: Vector2): void /** Override this method to commit a handle being edited (handles must have been previously added by [method add_handles]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [param restore] argument as "undo". * If the [param cancel] argument is `true`, the [param restore] value should be directly set, without any [UndoRedo] action. * The [param secondary] argument is `true` when the committed handle is secondary (see [method add_handles] for more information). */ /* gdvirtual */ _commit_handle(id: int64, secondary: boolean, restore: any, cancel: boolean): void /** Override this method to allow selecting subgizmos using mouse clicks. Given a [param camera] and a [param point] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. */ /* gdvirtual */ _subgizmos_intersect_ray(camera: Camera3D, point: Vector2): int64 /** Override this method to allow selecting subgizmos using mouse drag box selection. Given a [param camera] and a [param frustum], this method should return which subgizmos are contained within the frustum. The [param frustum] argument consists of an array with all the [Plane]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. */ /* gdvirtual */ _subgizmos_intersect_frustum(camera: Camera3D, frustum: GArray): PackedInt32Array /** Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [param transform] is given in the [Node3D]'s local coordinate system. */ /* gdvirtual */ _set_subgizmo_transform(id: int64, transform: Transform3D): void /** Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the `restore` argument in [method _commit_subgizmos]. */ /* gdvirtual */ _get_subgizmo_transform(id: int64): Transform3D /** Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [param restores] transforms as "undo". * If the [param cancel] argument is `true`, the [param restores] transforms should be directly set, without any [UndoRedo] action. */ /* gdvirtual */ _commit_subgizmos(ids: PackedInt32Array | int32[], restores: GArray, cancel: boolean): void /** Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during [method _redraw]. */ add_lines(lines: PackedVector3Array | Vector3[], material: Material, billboard: boolean = false, modulate: Color = new Color(1, 1, 1, 1)): void /** Adds a mesh to the gizmo with the specified [param material], local [param transform] and [param skeleton]. Call this method during [method _redraw]. */ add_mesh(mesh: Mesh, material: Material = undefined, transform: Transform3D = new Transform3D(), skeleton: SkinReference = undefined): void /** Adds the specified [param segments] to the gizmo's collision shape for picking. Call this method during [method _redraw]. */ add_collision_segments(segments: PackedVector3Array | Vector3[]): void /** Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this method during [method _redraw]. */ add_collision_triangles(triangles: TriangleMesh): void /** Adds an unscaled billboard for visualization and selection. Call this method during [method _redraw]. */ add_unscaled_billboard(material: Material, default_scale: float64 = 1, modulate: Color = new Color(1, 1, 1, 1)): void /** Adds a list of handles (points) which can be used to edit the properties of the gizmo's [Node3D]. The [param ids] argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the [param handles] argument order. * The [param secondary] argument marks the added handles as secondary, meaning they will normally have lower selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection. * There are virtual methods which will be called upon editing of these handles. Call this method during [method _redraw]. */ add_handles(handles: PackedVector3Array | Vector3[], material: Material, ids: PackedInt32Array | int32[], billboard: boolean = false, secondary: boolean = false): void /** Sets the reference [Node3D] node for the gizmo. [param node] must inherit from [Node3D]. */ set_node_3d(node: Node): void /** Returns the [Node3D] node associated with this gizmo. */ get_node_3d(): Node3D /** Returns the [EditorNode3DGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorNode3DGizmoPlugin.get_material]. */ get_plugin(): EditorNode3DGizmoPlugin /** Removes everything in the gizmo including meshes, collisions and handles. */ clear(): void /** Sets the gizmo's hidden state. If `true`, the gizmo will be hidden. If `false`, it will be shown. */ set_hidden(hidden: boolean): void /** Returns `true` if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. */ is_subgizmo_selected(id: int64): boolean /** Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during [method _redraw]. */ get_subgizmo_selection(): PackedInt32Array } /** A class used by the editor to define Node3D gizmo types. * * @link https://docs.godotengine.org/en/4.4/classes/class_editornode3dgizmoplugin.html */ class EditorNode3DGizmoPlugin extends Resource { constructor(identifier?: any) /** Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns `true` the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos. */ /* gdvirtual */ _has_gizmo(for_node_3d: Node3D): boolean /** Override this method to return a custom [EditorNode3DGizmo] for the 3D nodes of your choice, return `null` for the rest of nodes. See also [method _has_gizmo]. */ /* gdvirtual */ _create_gizmo(for_node_3d: Node3D): EditorNode3DGizmo /** Override this method to provide the name that will appear in the gizmo visibility menu. */ /* gdvirtual */ _get_gizmo_name(): string /** Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection. * All built-in editor gizmos return a priority of `-1`. If not overridden, this method will return `0`, which means custom gizmos will automatically get higher priority than built-in gizmos. */ /* gdvirtual */ _get_priority(): int64 /** Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns `true` if not overridden. */ /* gdvirtual */ _can_be_hidden(): boolean /** Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden. */ /* gdvirtual */ _is_selectable_when_hidden(): boolean /** Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method EditorNode3DGizmo.clear] at the beginning of this method and then add visual elements depending on the node's properties. */ /* gdvirtual */ _redraw(gizmo: EditorNode3DGizmo): void /** Override this method to provide gizmo's handle names. The [param secondary] argument is `true` when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. */ /* gdvirtual */ _get_handle_name(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean): string /** Override this method to return `true` whenever to given handle should be highlighted in the editor. The [param secondary] argument is `true` when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). Called for this plugin's active gizmos. */ /* gdvirtual */ _is_handle_highlighted(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean): boolean /** Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the `restore` argument in [method _commit_handle]. * The [param secondary] argument is `true` when the requested handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). * Called for this plugin's active gizmos. */ /* gdvirtual */ _get_handle_value(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean): any /* gdvirtual */ _begin_handle_action(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean): void /** Override this method to update the node's properties when the user drags a gizmo handle (previously added with [method EditorNode3DGizmo.add_handles]). The provided [param screen_pos] is the mouse position in screen coordinates and the [param camera] can be used to convert it to raycasts. * The [param secondary] argument is `true` when the edited handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). * Called for this plugin's active gizmos. */ /* gdvirtual */ _set_handle(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean, camera: Camera3D, screen_pos: Vector2): void /** Override this method to commit a handle being edited (handles must have been previously added by [method EditorNode3DGizmo.add_handles] during [method _redraw]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [param restore] argument as "undo". * If the [param cancel] argument is `true`, the [param restore] value should be directly set, without any [UndoRedo] action. * The [param secondary] argument is `true` when the committed handle is secondary (see [method EditorNode3DGizmo.add_handles] for more information). * Called for this plugin's active gizmos. */ /* gdvirtual */ _commit_handle(gizmo: EditorNode3DGizmo, handle_id: int64, secondary: boolean, restore: any, cancel: boolean): void /** Override this method to allow selecting subgizmos using mouse clicks. Given a [param camera] and a [param screen_pos] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. */ /* gdvirtual */ _subgizmos_intersect_ray(gizmo: EditorNode3DGizmo, camera: Camera3D, screen_pos: Vector2): int64 /** Override this method to allow selecting subgizmos using mouse drag box selection. Given a [param camera] and [param frustum_planes], this method should return which subgizmos are contained within the frustums. The [param frustum_planes] argument consists of an array with all the [Plane]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. */ /* gdvirtual */ _subgizmos_intersect_frustum(gizmo: EditorNode3DGizmo, camera: Camera3D, frustum_planes: GArray): PackedInt32Array /** Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the `restore` argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. */ /* gdvirtual */ _get_subgizmo_transform(gizmo: EditorNode3DGizmo, subgizmo_id: int64): Transform3D /** Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [param transform] is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. */ /* gdvirtual */ _set_subgizmo_transform(gizmo: EditorNode3DGizmo, subgizmo_id: int64, transform: Transform3D): void /** Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [param restores] transforms as "undo". * If the [param cancel] argument is `true`, the [param restores] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos. */ /* gdvirtual */ _commit_subgizmos(gizmo: EditorNode3DGizmo, ids: PackedInt32Array | int32[], restores: GArray, cancel: boolean): void /** Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. */ create_material(name: string, color: Color, billboard: boolean = false, on_top: boolean = false, use_vertex_color: boolean = false): void /** Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. */ create_icon_material(name: string, texture: Texture2D, on_top: boolean = false, color: Color = new Color(1, 1, 1, 1)): void /** Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. * You can optionally provide a texture to use instead of the default icon. */ create_handle_material(name: string, billboard: boolean = false, texture: Texture2D = undefined): void /** Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. */ add_material(name: string, material: StandardMaterial3D): void /** Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). */ get_material(name: string, gizmo: EditorNode3DGizmo = undefined): StandardMaterial3D } class EditorOBJImporter extends EditorSceneFormatImporter { constructor(identifier?: any) } class EditorObjectSelector = Record> extends Button { constructor(identifier?: any) } class EditorPackedScenePreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } /** Editor-only singleton that returns paths to various OS-specific data folders and files. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorpaths.html */ class EditorPaths extends Object { constructor(identifier?: any) /** Returns the absolute path to the user's data folder. This folder should be used for *persistent* user data files such as installed export templates. * **Default paths per platform:** * [codeblock lang=text] * - Windows: %APPDATA%\Godot\ (same as `get_config_dir()`) * - macOS: ~/Library/Application Support/Godot/ (same as `get_config_dir()`) * - Linux: ~/.local/share/godot/ * [/codeblock] */ get_data_dir(): string /** Returns the absolute path to the user's configuration folder. This folder should be used for *persistent* user configuration files. * **Default paths per platform:** * [codeblock lang=text] * - Windows: %APPDATA%\Godot\ (same as `get_data_dir()`) * - macOS: ~/Library/Application Support/Godot/ (same as `get_data_dir()`) * - Linux: ~/.config/godot/ * [/codeblock] */ get_config_dir(): string /** Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails). * **Default paths per platform:** * [codeblock lang=text] * - Windows: %LOCALAPPDATA%\Godot\ * - macOS: ~/Library/Caches/Godot/ * - Linux: ~/.cache/godot/ * [/codeblock] */ get_cache_dir(): string /** Returns `true` if the editor is marked as self-contained, `false` otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an `editor_data/` folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects. * Self-contained mode can be enabled by creating a file named `._sc_` or `_sc_` in the same folder as the editor binary or macOS .app bundle while the editor is not running. See also [method get_self_contained_file]. * * **Note:** On macOS, quarantine flag should be manually removed before using self-contained mode, see [url=https://docs.godotengine.org/en/stable/tutorials/export/running_on_macos.html]Running on macOS[/url]. * * **Note:** On macOS, placing `_sc_` or any other file inside .app bundle will break digital signature and make it non-portable, consider placing it in the same folder as the .app bundle instead. * * **Note:** The Steam release of Godot uses self-contained mode by default. */ is_self_contained(): boolean /** Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also [method is_self_contained]. */ get_self_contained_file(): string /** Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved. */ get_project_settings_dir(): string } class EditorPerformanceProfiler = Record> extends HSplitContainer { constructor(identifier?: any) } namespace EditorPlugin { enum CustomControlContainer { /** Main editor toolbar, next to play buttons. */ CONTAINER_TOOLBAR = 0, /** The toolbar that appears when 3D editor is active. */ CONTAINER_SPATIAL_EDITOR_MENU = 1, /** Left sidebar of the 3D editor. */ CONTAINER_SPATIAL_EDITOR_SIDE_LEFT = 2, /** Right sidebar of the 3D editor. */ CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT = 3, /** Bottom panel of the 3D editor. */ CONTAINER_SPATIAL_EDITOR_BOTTOM = 4, /** The toolbar that appears when 2D editor is active. */ CONTAINER_CANVAS_EDITOR_MENU = 5, /** Left sidebar of the 2D editor. */ CONTAINER_CANVAS_EDITOR_SIDE_LEFT = 6, /** Right sidebar of the 2D editor. */ CONTAINER_CANVAS_EDITOR_SIDE_RIGHT = 7, /** Bottom panel of the 2D editor. */ CONTAINER_CANVAS_EDITOR_BOTTOM = 8, /** Bottom section of the inspector. */ CONTAINER_INSPECTOR_BOTTOM = 9, /** Tab of Project Settings dialog, to the left of other tabs. */ CONTAINER_PROJECT_SETTING_TAB_LEFT = 10, /** Tab of Project Settings dialog, to the right of other tabs. */ CONTAINER_PROJECT_SETTING_TAB_RIGHT = 11, } enum DockSlot { /** Dock slot, left side, upper-left (empty in default layout). */ DOCK_SLOT_LEFT_UL = 0, /** Dock slot, left side, bottom-left (empty in default layout). */ DOCK_SLOT_LEFT_BL = 1, /** Dock slot, left side, upper-right (in default layout includes Scene and Import docks). */ DOCK_SLOT_LEFT_UR = 2, /** Dock slot, left side, bottom-right (in default layout includes FileSystem dock). */ DOCK_SLOT_LEFT_BR = 3, /** Dock slot, right side, upper-left (in default layout includes Inspector, Node, and History docks). */ DOCK_SLOT_RIGHT_UL = 4, /** Dock slot, right side, bottom-left (empty in default layout). */ DOCK_SLOT_RIGHT_BL = 5, /** Dock slot, right side, upper-right (empty in default layout). */ DOCK_SLOT_RIGHT_UR = 6, /** Dock slot, right side, bottom-right (empty in default layout). */ DOCK_SLOT_RIGHT_BR = 7, /** Represents the size of the [enum DockSlot] enum. */ DOCK_SLOT_MAX = 8, } enum AfterGUIInput { /** Forwards the [InputEvent] to other EditorPlugins. */ AFTER_GUI_INPUT_PASS = 0, /** Prevents the [InputEvent] from reaching other Editor classes. */ AFTER_GUI_INPUT_STOP = 1, /** Pass the [InputEvent] to other editor plugins except the main [Node3D] one. This can be used to prevent node selection changes and work with sub-gizmos instead. */ AFTER_GUI_INPUT_CUSTOM = 2, } } /** Used by the editor to extend its functionality. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorplugin.html */ class EditorPlugin = Record> extends Node { constructor(identifier?: any) /** Called when there is a root node in the current edited scene, [method _handles] is implemented, and an [InputEvent] happens in the 2D viewport. If this method returns `true`, [param event] is intercepted by this [EditorPlugin], otherwise [param event] is forwarded to other Editor classes. * * This method must return `false` in order to forward the [InputEvent] to other Editor classes. * */ /* gdvirtual */ _forward_canvas_gui_input(event: InputEvent): boolean /** Called by the engine when the 2D editor's viewport is updated. Use the `overlay` [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. * */ /* gdvirtual */ _forward_canvas_draw_over_viewport(viewport_control: Control): void /** This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. * You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. */ /* gdvirtual */ _forward_canvas_force_draw_over_viewport(viewport_control: Control): void /** Called when there is a root node in the current edited scene, [method _handles] is implemented, and an [InputEvent] happens in the 3D viewport. The return value decides whether the [InputEvent] is consumed or forwarded to other [EditorPlugin]s. See [enum AfterGUIInput] for options. * * This method must return [constant AFTER_GUI_INPUT_PASS] in order to forward the [InputEvent] to other Editor classes. * */ /* gdvirtual */ _forward_3d_gui_input(viewport_camera: Camera3D, event: InputEvent): int64 /** Called by the engine when the 3D editor's viewport is updated. Use the `overlay` [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. * */ /* gdvirtual */ _forward_3d_draw_over_viewport(viewport_control: Control): void /** This method is the same as [method _forward_3d_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. * You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. */ /* gdvirtual */ _forward_3d_force_draw_over_viewport(viewport_control: Control): void /** Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. * For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. */ /* gdvirtual */ _get_plugin_name(): string /** Override this method in your plugin to return a [Texture2D] in order to give it an icon. * For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. * Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size. * */ /* gdvirtual */ _get_plugin_icon(): Texture2D /** Returns `true` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script** and **AssetLib**). * When the plugin's workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of [method EditorInterface.get_editor_main_screen] and made visible inside [method _make_visible]. * Use [method _get_plugin_name] and [method _get_plugin_icon] to customize the plugin button's appearance. * */ /* gdvirtual */ _has_main_screen(): boolean /** This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. * Remember that you have to manage the visibility of all your editor controls manually. */ /* gdvirtual */ _make_visible(visible: boolean): void /** This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. * [param object] can be `null` if the plugin was editing an object, but there is no longer any selected object handled by this plugin. It can be used to cleanup editing state. */ /* gdvirtual */ _edit(object: Object): void /** Implement this function if your plugin edits a specific type of object (Resource or Node). If you return `true`, then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_3d_gui_input] these will be called too. * * **Note:** Each plugin should handle only one type of objects at a time. If a plugin handles more types of objects and they are edited at the same time, it will result in errors. */ /* gdvirtual */ _handles(object: Object): boolean /** Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). This data is automatically saved for each scene in an `editstate` file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use [method _get_window_layout] instead. * Use [method _set_state] to restore your saved state. * * **Note:** This method should not be used to save important settings that should persist with the project. * * **Note:** You must implement [method _get_plugin_name] for the state to be stored and restored correctly. * */ /* gdvirtual */ _get_state(): GDictionary /** Restore the state saved by [method _get_state]. This method is called when the current scene tab is changed in the editor. * * **Note:** Your plugin must implement [method _get_plugin_name], otherwise it will not be recognized and this method will not be called. * */ /* gdvirtual */ _set_state(state: GDictionary): void /** Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. */ /* gdvirtual */ _clear(): void /** Override this method to provide a custom message that lists unsaved changes. The editor will call this method when exiting or when closing a scene, and display the returned string in a confirmation dialog. Return empty string if the plugin has no unsaved changes. * When closing a scene, [param for_scene] is the path to the scene being closed. You can use it to handle built-in resources in that scene. * If the user confirms saving, [method _save_external_data] will be called, before closing the editor. * * If the plugin has no scene-specific changes, you can ignore the calls when closing scenes: * */ /* gdvirtual */ _get_unsaved_status(for_scene: string): string /** This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. */ /* gdvirtual */ _save_external_data(): void /** This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. * This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. */ /* gdvirtual */ _apply_changes(): void /** This is for editors that edit script-based objects. You can return a list of breakpoints in the format (`script:line`), for example: `res://path_to_script.gd:25`. */ /* gdvirtual */ _get_breakpoints(): PackedStringArray /** Restore the plugin GUI layout and data saved by [method _get_window_layout]. This method is called for every plugin on editor startup. Use the provided [param configuration] file to read your saved data. * */ /* gdvirtual */ _set_window_layout(configuration: ConfigFile): void /** Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the `editor_layout.cfg` file in the editor metadata directory. * Use [method _set_window_layout] to restore your saved layout. * */ /* gdvirtual */ _get_window_layout(configuration: ConfigFile): void /** This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. * This method must return a boolean. If this method returns `false`, the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method _build] methods from running. */ /* gdvirtual */ _build(): boolean /** Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window. */ /* gdvirtual */ _enable_plugin(): void /** Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window. */ /* gdvirtual */ _disable_plugin(): void /** Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. * Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). * When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [method Node.queue_free]. */ add_control_to_container(container: EditorPlugin.CustomControlContainer, control: Control): void /** Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. * Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use [kbd]Alt[/kbd] modifier. */ add_control_to_bottom_panel(control: Control, title: string, shortcut: Shortcut = undefined): Button /** Adds the control to a specific dock slot (see [enum DockSlot] for options). * If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. * When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free]. * Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the dock's visibility once it's moved to the bottom panel (this shortcut does not affect the dock otherwise). See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use [kbd]Alt[/kbd] modifier. */ add_control_to_dock(slot: EditorPlugin.DockSlot, control: Control, shortcut: Shortcut = undefined): void /** Removes the control from the dock. You have to manually [method Node.queue_free] the control. */ remove_control_from_docks(control: Control): void /** Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control. */ remove_control_from_bottom_panel(control: Control): void /** Removes the control from the specified container. You have to manually [method Node.queue_free] the control. */ remove_control_from_container(container: EditorPlugin.CustomControlContainer, control: Control): void /** Sets the tab icon for the given control in a dock slot. Setting to `null` removes the icon. */ set_dock_tab_icon(control: Control, icon: Texture2D): void /** Adds a custom menu item to **Project > Tools** named [param name]. When clicked, the provided [param callable] will be called. */ add_tool_menu_item(name: string, callable: Callable): void /** Adds a custom [PopupMenu] submenu under **Project > Tools >** [param name]. Use [method remove_tool_menu_item] on plugin clean up to remove the menu. */ add_tool_submenu_item(name: string, submenu: PopupMenu): void /** Removes a menu [param name] from **Project > Tools**. */ remove_tool_menu_item(name: string): void /** Returns the [PopupMenu] under **Scene > Export As...**. */ get_export_as_menu(): PopupMenu /** Adds a custom type, which will appear in the list of nodes or resources. * When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. * * **Note:** The base type is the base engine class which this type's class hierarchy inherits, not any custom type parent classes. * You can use the virtual method [method _handles] to check if your custom object is being edited by checking the script or using the `is` keyword. * During run-time, this will be a simple object with a script so this function does not need to be called then. * * **Note:** Custom types added this way are not true classes. They are just a helper to create a node with specific script. */ add_custom_type(type: string, base: string, script: Script, icon: Texture2D): void /** Removes a custom type added by [method add_custom_type]. */ remove_custom_type(type: string): void /** Adds a script at [param path] to the Autoload list as [param name]. */ add_autoload_singleton(name: string, path: string): void /** Removes an Autoload [param name] from the list. */ remove_autoload_singleton(name: string): void /** Updates the overlays of the 2D and 3D editor viewport. Causes methods [method _forward_canvas_draw_over_viewport], [method _forward_canvas_force_draw_over_viewport], [method _forward_3d_draw_over_viewport] and [method _forward_3d_force_draw_over_viewport] to be called. */ update_overlays(): int64 /** Makes a specific item in the bottom panel visible. */ make_bottom_panel_item_visible(item: Control): void /** Minimizes the bottom panel. */ hide_bottom_panel(): void /** Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. */ get_undo_redo(): EditorUndoRedoManager /** Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. * The callback should have 4 arguments: [Object] `undo_redo`, [Object] `modified_object`, [String] `property` and [Variant] `new_value`. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. */ add_undo_redo_inspector_hook_callback(callable: Callable): void /** Removes a callback previously added by [method add_undo_redo_inspector_hook_callback]. */ remove_undo_redo_inspector_hook_callback(callable: Callable): void /** Queue save the project's editor layout. */ queue_save_layout(): void /** Registers a custom translation parser plugin for extracting translatable strings from custom files. */ add_translation_parser_plugin(parser: EditorTranslationParserPlugin): void /** Removes a custom translation parser plugin registered by [method add_translation_parser_plugin]. */ remove_translation_parser_plugin(parser: EditorTranslationParserPlugin): void /** Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. * If [param first_priority] is `true`, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. * * **Note:** If you want to import custom 3D asset formats use [method add_scene_format_importer_plugin] instead. * See [method add_inspector_plugin] for an example of how to register a plugin. */ add_import_plugin(importer: EditorImportPlugin, first_priority: boolean = false): void /** Removes an import plugin registered by [method add_import_plugin]. */ remove_import_plugin(importer: EditorImportPlugin): void /** Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. * If [param first_priority] is `true`, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. */ add_scene_format_importer_plugin(scene_format_importer: EditorSceneFormatImporter, first_priority: boolean = false): void /** Removes a scene format importer registered by [method add_scene_format_importer_plugin]. */ remove_scene_format_importer_plugin(scene_format_importer: EditorSceneFormatImporter): void /** Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. * If [param first_priority] is `true`, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins. */ add_scene_post_import_plugin(scene_import_plugin: EditorScenePostImportPlugin, first_priority: boolean = false): void /** Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. */ remove_scene_post_import_plugin(scene_import_plugin: EditorScenePostImportPlugin): void /** Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. * See [method add_inspector_plugin] for an example of how to register a plugin. */ add_export_plugin(plugin: EditorExportPlugin): void /** Removes an export plugin registered by [method add_export_plugin]. */ remove_export_plugin(plugin: EditorExportPlugin): void /** Registers a new [EditorExportPlatform]. Export platforms provides functionality of exporting to the specific platform. */ add_export_platform(platform: EditorExportPlatform): void /** Removes an export platform registered by [method add_export_platform]. */ remove_export_platform(platform: EditorExportPlatform): void /** Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. * See [method add_inspector_plugin] for an example of how to register a plugin. */ add_node_3d_gizmo_plugin(plugin: EditorNode3DGizmoPlugin): void /** Removes a gizmo plugin registered by [method add_node_3d_gizmo_plugin]. */ remove_node_3d_gizmo_plugin(plugin: EditorNode3DGizmoPlugin): void /** Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. * * **Note:** Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. * */ add_inspector_plugin(plugin: EditorInspectorPlugin): void /** Removes an inspector plugin registered by [method add_inspector_plugin]. */ remove_inspector_plugin(plugin: EditorInspectorPlugin): void /** Registers a new [EditorResourceConversionPlugin]. Resource conversion plugins are used to add custom resource converters to the editor inspector. * See [EditorResourceConversionPlugin] for an example of how to create a resource conversion plugin. */ add_resource_conversion_plugin(plugin: EditorResourceConversionPlugin): void /** Removes a resource conversion plugin registered by [method add_resource_conversion_plugin]. */ remove_resource_conversion_plugin(plugin: EditorResourceConversionPlugin): void /** Use this method if you always want to receive inputs from 3D view screen inside [method _forward_3d_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. */ set_input_event_forwarding_always_enabled(): void /** Enables calling of [method _forward_canvas_force_draw_over_viewport] for the 2D editor and [method _forward_3d_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. */ set_force_draw_over_forwarding_enabled(): void /** Adds a plugin to the context menu. [param slot] is the context menu where the plugin will be added. * See [enum EditorContextMenuPlugin.ContextMenuSlot] for available context menus. A plugin instance can belong only to a single context menu slot. */ add_context_menu_plugin(slot: EditorContextMenuPlugin.ContextMenuSlot, plugin: EditorContextMenuPlugin): void /** Removes the specified context menu plugin. */ remove_context_menu_plugin(plugin: EditorContextMenuPlugin): void /** Returns the [EditorInterface] singleton instance. */ get_editor_interface(): EditorInterface /** Gets the Editor's dialog used for making scripts. * * **Note:** Users can configure it before use. * **Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. */ get_script_create_dialog(): ScriptCreateDialog /** Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. */ add_debugger_plugin(script: EditorDebuggerPlugin): void /** Removes the debugger plugin with given script from the Debugger. */ remove_debugger_plugin(script: EditorDebuggerPlugin): void /** Provide the version of the plugin declared in the `plugin.cfg` config file. */ get_plugin_version(): string /** Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be `null`. */ readonly scene_changed: Signal1 /** Emitted when user closes a scene. The argument is a file path to the closed scene. */ readonly scene_closed: Signal1 /** Emitted when user changes the workspace (**2D**, **3D**, **Script**, **AssetLib**). Also works with custom screens defined by plugins. */ readonly main_screen_changed: Signal1 /** Emitted when the given [param resource] was saved on disc. See also [signal scene_saved]. */ readonly resource_saved: Signal1 /** Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also [signal resource_saved]. */ readonly scene_saved: Signal1 /** Emitted when any project setting has changed. */ readonly project_settings_changed: Signal0 } class EditorPluginCSG = Record> extends EditorPlugin { constructor(identifier?: any) } class EditorPluginSettings = Record> extends VBoxContainer { constructor(identifier?: any) } class EditorProfiler = Record> extends VBoxContainer { constructor(identifier?: any) readonly enable_profiling: Signal1 readonly break_request: Signal0 } /** Custom control for editing properties that can be added to the [EditorInspector]. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorproperty.html */ class EditorProperty = Record> extends Container { constructor(identifier?: any) /** When this virtual function is called, you must update your editor. */ /* gdvirtual */ _update_property(): void /** Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state. */ /* gdvirtual */ _set_read_only(read_only: boolean): void /** Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin._parse_property]), then this will return the property. */ get_edited_property(): StringName /** Gets the edited object. */ get_edited_object(): Object /** Forces refresh of the property display. */ update_property(): void /** If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. */ add_focusable(control: Control): void /** Puts the [param editor] control below the property label. The control must be previously added using [method Node.add_child]. */ set_bottom_editor(editor: Control): void /** Draw property as not selected. Used by the inspector. */ deselect(): void /** Returns `true` if property is drawn as selected. Used by the inspector. */ is_selected(): boolean /** Draw property as selected. Used by the inspector. */ select(focusable: int64 = -1): void /** Assigns object and property to edit. */ set_object_and_property(object: Object, property: StringName): void /** Used by the inspector, set to a control that will be used as a reference to calculate the size of the label. */ set_label_reference(control: Control): void /** If one or several properties have changed, this must be called. [param field] is used in case your editor can modify fields separately (as an example, Vector3.x). The [param changing] argument avoids the editor requesting this property to be refreshed (leave as `false` if unsure). */ emit_changed(property: StringName, value: any, field: StringName = '', changing: boolean = false): void _update_editor_property_status(): void /** Set this property to change the label (if you want to show one). */ get label(): string set label(value: string) /** Used by the inspector, set to `true` when the property is read-only. */ get read_only(): boolean set read_only(value: boolean) /** Used by the inspector, set to `true` when the property background is drawn. */ get draw_label(): boolean set draw_label(value: boolean) /** Used by the inspector, set to `true` when the property label is drawn. */ get draw_background(): boolean set draw_background(value: boolean) /** Used by the inspector, set to `true` when the property is checkable. */ get checkable(): boolean set checkable(value: boolean) /** Used by the inspector, set to `true` when the property is checked. */ get checked(): boolean set checked(value: boolean) /** Used by the inspector, set to `true` when the property is drawn with the editor theme's warning color. This is used for editable children's properties. */ get draw_warning(): boolean set draw_warning(value: boolean) /** Used by the inspector, set to `true` when the property can add keys for animation. */ get keying(): boolean set keying(value: boolean) /** Used by the inspector, set to `true` when the property can be deleted by the user. */ get deletable(): boolean set deletable(value: boolean) /** Used by the inspector, set to `true` when the property is selectable. */ get selectable(): boolean set selectable(value: boolean) /** Used by the inspector, set to `true` when the property is using folding. */ get use_folding(): boolean set use_folding(value: boolean) /** Space distribution ratio between the label and the editing field. */ get name_split_ratio(): float64 set name_split_ratio(value: float64) /** Do not emit this manually, use the [method emit_changed] method instead. */ readonly property_changed: Signal4 /** Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property]. */ readonly multiple_properties_changed: Signal2 /** Emit it if you want to add this value as an animation key (check for keying being enabled first). */ readonly property_keyed: Signal1 /** Emitted when a property was deleted. Used internally. */ readonly property_deleted: Signal1 /** Emit it if you want to key a property with a single value. */ readonly property_keyed_with_value: Signal2 /** Emitted when a property was checked. Used internally. */ readonly property_checked: Signal2 /** Emit it if you want to mark a property as favorited, making it appear at the top of the inspector. */ readonly property_favorited: Signal2 /** Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. * The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instantiation chain, a script or a builtin class. */ readonly property_pinned: Signal2 /** Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed. */ readonly property_can_revert_changed: Signal2 /** If you want a sub-resource to be edited, emit this signal with the resource. */ readonly resource_selected: Signal2 /** Used by sub-inspectors. Emit it if what was selected was an Object ID. */ readonly object_id_selected: Signal2 /** Emitted when selected. Used internally. */ readonly selected: Signal2 } class EditorPropertyCheck = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyDictionaryObject extends RefCounted { constructor(identifier?: any) } class EditorPropertyEnum = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyFloat = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyInteger = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyLayers = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyLayersGrid = Record> extends Control { constructor(identifier?: any) readonly flag_changed: Signal1 readonly rename_confirmed: Signal2 } class EditorPropertyLocalizableString = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyMultilineText = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyNameProcessor = Record> extends Node { constructor(identifier?: any) } class EditorPropertyNodePath = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyPath = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyResource = Record> extends EditorProperty { constructor(identifier?: any) _should_stop_editing(): boolean } class EditorPropertyText = Record> extends EditorProperty { constructor(identifier?: any) } class EditorPropertyVector2i = Record> extends EditorPropertyVectorN { constructor(identifier?: any) } class EditorPropertyVector3 = Record> extends EditorPropertyVectorN { constructor(identifier?: any) } class EditorPropertyVectorN = Record> extends EditorProperty { constructor(identifier?: any) } class EditorQuickOpenDialog = Record> extends AcceptDialog { constructor(identifier?: any) } /** Plugin for adding custom converters from one resource format to another in the editor resource picker context menu; for example, converting a [StandardMaterial3D] to a [ShaderMaterial]. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorresourceconversionplugin.html */ class EditorResourceConversionPlugin extends RefCounted { constructor(identifier?: any) /** Returns the class name of the target type of [Resource] that this plugin converts source resources to. */ /* gdvirtual */ _converts_to(): string /** Called to determine whether a particular [Resource] can be converted to the target resource type by this plugin. */ /* gdvirtual */ _handles(resource: Resource): boolean /** Takes an input [Resource] and converts it to the type given in [method _converts_to]. The returned [Resource] is the result of the conversion, and the input [Resource] remains unchanged. */ /* gdvirtual */ _convert(resource: Resource): Resource } /** Godot editor's control for selecting [Resource] type properties. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorresourcepicker.html */ class EditorResourcePicker = Record> extends HBoxContainer { constructor(identifier?: any) /** This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [param menu_node] is a reference to the [PopupMenu] node. * * **Note:** Implement [method _handle_menu_selected] to handle these custom items. */ /* gdvirtual */ _set_create_options(menu_node: Object): void /** This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options]. */ /* gdvirtual */ _handle_menu_selected(id: int64): boolean _update_resource_preview(_unnamed_arg0: string, _unnamed_arg1: Texture2D, _unnamed_arg2: Texture2D, _unnamed_arg3: int64): void /** Returns a list of all allowed types and subtypes corresponding to the [member base_type]. If the [member base_type] is empty, an empty list is returned. */ get_allowed_types(): PackedStringArray /** Sets the toggle mode state for the main button. Works only if [member toggle_mode] is set to `true`. */ set_toggle_pressed(pressed: boolean): void /** The base type of allowed resource types. Can be a comma-separated list of several options. */ get base_type(): string set base_type(value: string) /** The edited resource value. */ get edited_resource(): Resource set edited_resource(value: Resource) /** If `true`, the value can be selected and edited. */ get editable(): boolean set editable(value: boolean) /** If `true`, the main button with the resource preview works in the toggle mode. Use [method set_toggle_pressed] to manually set the state. */ get toggle_mode(): boolean set toggle_mode(value: boolean) /** Emitted when the resource value was set and user clicked to edit it. When [param inspect] is `true`, the signal was caused by the context menu "Edit" or "Inspect" option. */ readonly resource_selected: Signal2 /** Emitted when the value of the edited resource was changed. */ readonly resource_changed: Signal1 } /** A node used to generate previews of resources or files. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorresourcepreview.html */ class EditorResourcePreview = Record> extends Node { constructor(identifier?: any) /** Queue a resource file located at [param path] for preview. Once the preview is ready, the [param receiver]'s [param receiver_func] will be called. The [param receiver_func] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [param userdata] can be anything, and will be returned when [param receiver_func] is called. * * **Note:** If it was not possible to create the preview the [param receiver_func] will still be called, but the preview will be `null`. */ queue_resource_preview(path: string, receiver: Object, receiver_func: StringName, userdata: any): void /** Queue the [param resource] being edited for preview. Once the preview is ready, the [param receiver]'s [param receiver_func] will be called. The [param receiver_func] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [param userdata] can be anything, and will be returned when [param receiver_func] is called. * * **Note:** If it was not possible to create the preview the [param receiver_func] will still be called, but the preview will be `null`. */ queue_edited_resource_preview(resource: Resource, receiver: Object, receiver_func: StringName, userdata: any): void /** Create an own, custom preview generator. */ add_preview_generator(generator: EditorResourcePreviewGenerator): void /** Removes a custom preview generator. */ remove_preview_generator(generator: EditorResourcePreviewGenerator): void /** Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. */ check_for_invalidation(path: string): void /** Emitted if a preview was invalidated (changed). [param path] corresponds to the path of the preview. */ readonly preview_invalidated: Signal1 } /** Custom generator of previews. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorresourcepreviewgenerator.html */ class EditorResourcePreviewGenerator extends RefCounted { constructor(identifier?: any) /** Returns `true` if your generator supports the resource of type [param type]. */ /* gdvirtual */ _handles(type: string): boolean /** Generate a preview from a given resource with the specified size. This must always be implemented. * Returning `null` is an OK way to fail and let another generator take care. * Care must be taken because this function is always called from a thread (not the main thread). * [param metadata] dictionary can be modified to store file-specific metadata that can be used in [method EditorResourceTooltipPlugin._make_tooltip_for_path] (like image size, sample length etc.). */ /* gdvirtual */ _generate(resource: Resource, size: Vector2i, metadata: GDictionary): Texture2D /** Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate]. * Returning `null` is an OK way to fail and let another generator take care. * Care must be taken because this function is always called from a thread (not the main thread). * [param metadata] dictionary can be modified to store file-specific metadata that can be used in [method EditorResourceTooltipPlugin._make_tooltip_for_path] (like image size, sample length etc.). */ /* gdvirtual */ _generate_from_path(path: string, size: Vector2i, metadata: GDictionary): Texture2D /** If this function returns `true`, the generator will automatically generate the small previews from the normal preview texture generated by the methods [method _generate] or [method _generate_from_path]. * By default, it returns `false`. */ /* gdvirtual */ _generate_small_preview_automatically(): boolean /** If this function returns `true`, the generator will call [method _generate] or [method _generate_from_path] for small previews as well. * By default, it returns `false`. */ /* gdvirtual */ _can_generate_small_preview(): boolean } /** A plugin that advanced tooltip for its handled resource type. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorresourcetooltipplugin.html */ class EditorResourceTooltipPlugin extends RefCounted { constructor(identifier?: any) /** Return `true` if the plugin is going to handle the given [Resource] [param type]. */ /* gdvirtual */ _handles(type: string): boolean /** Create and return a tooltip that will be displayed when the user hovers a resource under the given [param path] in filesystem dock. * The [param metadata] dictionary is provided by preview generator (see [method EditorResourcePreviewGenerator._generate]). * [param base] is the base default tooltip, which is a [VBoxContainer] with a file name, type and size labels. If another plugin handled the same file type, [param base] will be output from the previous plugin. For best result, make sure the base tooltip is part of the returned [Control]. * * **Note:** It's unadvised to use [method ResourceLoader.load], especially with heavy resources like models or textures, because it will make the editor unresponsive when creating the tooltip. You can use [method request_thumbnail] if you want to display a preview in your tooltip. * * **Note:** If you decide to discard the [param base], make sure to call [method Node.queue_free], because it's not freed automatically. * */ /* gdvirtual */ _make_tooltip_for_path(path: string, metadata: GDictionary, base: Control): Control _thumbnail_ready(_unnamed_arg0: string, _unnamed_arg1: Texture2D, _unnamed_arg2: Texture2D, _unnamed_arg3: any): void /** Requests a thumbnail for the given [TextureRect]. The thumbnail is created asynchronously by [EditorResourcePreview] and automatically set when available. */ request_thumbnail(path: string, control: TextureRect): void } class EditorRunBar = Record> extends MarginContainer { constructor(identifier?: any) readonly play_pressed: Signal0 readonly stop_pressed: Signal0 } class EditorRunNative = Record> extends HBoxContainer { constructor(identifier?: any) readonly native_run: Signal1 } class EditorSceneExporterGLTFSettings extends RefCounted { constructor(identifier?: any) get copyright(): string set copyright(value: string) get bake_fps(): float64 set bake_fps(value: float64) } /** Imports scenes from third-parties' 3D files. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsceneformatimporter.html */ class EditorSceneFormatImporter extends RefCounted { static readonly IMPORT_SCENE = 1 static readonly IMPORT_ANIMATION = 2 static readonly IMPORT_FAIL_ON_MISSING_DEPENDENCIES = 4 static readonly IMPORT_GENERATE_TANGENT_ARRAYS = 8 static readonly IMPORT_USE_NAMED_SKIN_BINDS = 16 static readonly IMPORT_DISCARD_MESHES_AND_MATERIALS = 32 static readonly IMPORT_FORCE_DISABLE_MESH_COMPRESSION = 64 constructor(identifier?: any) /** Return supported file extensions for this scene importer. */ /* gdvirtual */ _get_extensions(): PackedStringArray /** Perform the bulk of the scene import logic here, for example using [GLTFDocument] or [FBXDocument]. */ /* gdvirtual */ _import_scene(path: string, flags: int64, options: GDictionary): Object /** Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. * * **Note:** All [EditorSceneFormatImporter] and [EditorScenePostImportPlugin] instances will add options for all files. It is good practice to check the file extension when [param path] is non-empty. * When the user is editing project settings, [param path] will be empty. It is recommended to add all options when [param path] is empty to allow the user to customize Import Defaults. */ /* gdvirtual */ _get_import_options(path: string): void /** Should return `true` to show the given option, `false` to hide the given option, or `null` to ignore. */ /* gdvirtual */ _get_option_visibility(path: string, for_animation: boolean, option: string): any /** Add a specific import option (name and default value only). This function can only be called from [method _get_import_options]. */ add_import_option(name: string, value: any): void /** Add a specific import option. This function can only be called from [method _get_import_options]. */ add_import_option_advanced(type: Variant.Type, name: string, default_value: any, hint: PropertyHint = 0, hint_string: string = '', usage_flags: int64 = 6): void } /** Importer for Blender's `.blend` scene file format. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsceneformatimporterblend.html */ class EditorSceneFormatImporterBlend extends EditorSceneFormatImporter { constructor(identifier?: any) } class EditorSceneFormatImporterCollada extends EditorSceneFormatImporter { constructor(identifier?: any) } class EditorSceneFormatImporterESCN extends EditorSceneFormatImporter { constructor(identifier?: any) } /** Importer for the `.fbx` scene file format. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsceneformatimporterfbx2gltf.html */ class EditorSceneFormatImporterFBX2GLTF extends EditorSceneFormatImporter { constructor(identifier?: any) } /** @link https://docs.godotengine.org/en/4.4/classes/class_editorsceneformatimportergltf.html */ class EditorSceneFormatImporterGLTF extends EditorSceneFormatImporter { constructor(identifier?: any) } /** Import FBX files using the ufbx library. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsceneformatimporterufbx.html */ class EditorSceneFormatImporterUFBX extends EditorSceneFormatImporter { constructor(identifier?: any) } /** Post-processes scenes after import. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorscenepostimport.html */ class EditorScenePostImport extends RefCounted { constructor(identifier?: any) /** Called after the scene was imported. This method must return the modified version of the scene. */ /* gdvirtual */ _post_import(scene: Node): Object /** Returns the source file path which got imported (e.g. `res://scene.dae`). */ get_source_file(): string } namespace EditorScenePostImportPlugin { enum InternalImportCategory { INTERNAL_IMPORT_CATEGORY_NODE = 0, INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE = 1, INTERNAL_IMPORT_CATEGORY_MESH = 2, INTERNAL_IMPORT_CATEGORY_MATERIAL = 3, INTERNAL_IMPORT_CATEGORY_ANIMATION = 4, INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE = 5, INTERNAL_IMPORT_CATEGORY_SKELETON_3D_NODE = 6, INTERNAL_IMPORT_CATEGORY_MAX = 7, } } /** Plugin to control and modifying the process of importing a scene. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorscenepostimportplugin.html */ class EditorScenePostImportPlugin extends RefCounted { constructor(identifier?: any) /** Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced]. */ /* gdvirtual */ _get_internal_import_options(category: int64): void /** Should return `true` to show the given option, `false` to hide the given option, or `null` to ignore. */ /* gdvirtual */ _get_internal_option_visibility(category: int64, for_animation: boolean, option: string): any /** Should return `true` if the 3D view of the import dialog needs to update when changing the given option. */ /* gdvirtual */ _get_internal_option_update_view_required(category: int64, option: string): any /** Process a specific node or resource for a given category. */ /* gdvirtual */ _internal_process(category: int64, base_node: Node, node: Node, resource: Resource): void /** Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. */ /* gdvirtual */ _get_import_options(path: string): void /** Should return `true` to show the given option, `false` to hide the given option, or `null` to ignore. */ /* gdvirtual */ _get_option_visibility(path: string, for_animation: boolean, option: string): any /** Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. * Pre process may be used to adjust internal import options in the `"nodes"`, `"meshes"`, `"animations"` or `"materials"` keys inside `get_option_value("_subresources")`. */ /* gdvirtual */ _pre_process(scene: Node): void /** Post process the scene. This function is called after the final scene has been configured. */ /* gdvirtual */ _post_process(scene: Node): void /** Query the value of an option. This function can only be called from those querying visibility, or processing. */ get_option_value(name: StringName): any /** Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. */ add_import_option(name: string, value: any): void /** Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. */ add_import_option_advanced(type: Variant.Type, name: string, default_value: any, hint: PropertyHint = 0, hint_string: string = '', usage_flags: int64 = 6): void } class EditorSceneTabs = Record> extends MarginContainer { constructor(identifier?: any) _tab_preview_done(_unnamed_arg0: string, _unnamed_arg1: Texture2D, _unnamed_arg2: Texture2D, _unnamed_arg3: any): void readonly tab_changed: Signal1 readonly tab_closed: Signal1 } /** Base script that can be used to add extension functions to the editor. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorscript.html */ class EditorScript extends RefCounted { constructor(identifier?: any) /** This method is executed by the Editor when **File > Run** is used. */ /* gdvirtual */ _run(): void /** Makes [param node] root of the currently opened scene. Only works if the scene is empty. If the [param node] is a scene instance, an inheriting scene will be created. */ add_root_node(node: Node): void /** Returns the edited (current) scene's root [Node]. Equivalent of [method EditorInterface.get_edited_scene_root]. */ get_scene(): Node /** Returns the [EditorInterface] singleton instance. */ get_editor_interface(): EditorInterface } /** Godot editor's control for selecting the `script` property of a [Node]. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorscriptpicker.html */ class EditorScriptPicker = Record> extends EditorResourcePicker { constructor(identifier?: any) /** The owner [Node] of the script property that holds the edited resource. */ get script_owner(): Node set script_owner(value: Node) } class EditorScriptPreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } /** Manages the SceneTree selection in the editor. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorselection.html */ class EditorSelection extends Object { constructor(identifier?: any) /** Clear the selection. */ clear(): void /** Adds a node to the selection. * * **Note:** The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use [method EditorInterface.edit_node]. */ add_node(node: Node): void /** Removes a node from the selection. */ remove_node(node: Node): void /** Returns the list of selected nodes. */ get_selected_nodes(): GArray /** Returns the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc.). This list can be used to avoid situations where a node is selected and is also a child/grandchild. */ get_transformable_selected_nodes(): GArray /** Emitted when the selection changes. */ readonly selection_changed: Signal0 } /** Object that holds the project-independent editor settings. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsettings.html */ class EditorSettings extends Resource { /** Emitted after any editor setting has changed. It's used by various editor plugins to update their visuals on theme changes or logic on configuration changes. */ static readonly NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000 constructor(identifier?: any) /** Returns `true` if the setting specified by [param name] exists, `false` otherwise. */ has_setting(name: string): boolean /** Sets the [param value] of the setting specified by [param name]. This is equivalent to using [method Object.set] on the EditorSettings instance. */ set_setting(name: string, value: any): void /** Returns the value of the setting specified by [param name]. This is equivalent to using [method Object.get] on the EditorSettings instance. */ get_setting(name: string): any /** Erases the setting whose name is specified by [param property]. */ erase(property: string): void /** Sets the initial value of the setting specified by [param name] to [param value]. This is used to provide a value for the Revert button in the Editor Settings. If [param update_current] is `true`, the setting is reset to [param value] as well. */ set_initial_value(name: StringName, value: any, update_current: boolean): void /** Adds a custom property info to a property. The dictionary must contain: * - `name`: [String] (the name of the property) * - `type`: [int] (see [enum Variant.Type]) * - optionally `hint`: [int] (see [enum PropertyHint]) and `hint_string`: [String] * */ add_property_info(info: GDictionary): void /** Sets project-specific metadata with the [param section], [param key] and [param data] specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also [method get_project_metadata]. */ set_project_metadata(section: string, key: string, data: any): void /** Returns project-specific metadata for the [param section] and [param key] specified. If the metadata doesn't exist, [param default] will be returned instead. See also [method set_project_metadata]. */ get_project_metadata(section: string, key: string, default_: any = {}): any /** Sets the list of favorite files and directories for this project. */ set_favorites(dirs: PackedStringArray | string[]): void /** Returns the list of favorite files and directories for this project. */ get_favorites(): PackedStringArray /** Sets the list of recently visited folders in the file dialog for this project. */ set_recent_dirs(dirs: PackedStringArray | string[]): void /** Returns the list of recently visited folders in the file dialog for this project. */ get_recent_dirs(): PackedStringArray /** Overrides the built-in editor action [param name] with the input actions defined in [param actions_list]. */ set_builtin_action_override(name: string, actions_list: GArray): void /** Checks if any settings with the prefix [param setting_prefix] exist in the set of changed settings. See also [method get_changed_settings]. */ check_changed_settings_in_group(setting_prefix: string): boolean /** Gets an array of the settings which have been changed since the last save. Note that internally `changed_settings` is cleared after a successful save, so generally the most appropriate place to use this method is when processing [constant NOTIFICATION_EDITOR_SETTINGS_CHANGED]. */ get_changed_settings(): PackedStringArray /** Marks the passed editor setting as being changed, see [method get_changed_settings]. Only settings which exist (see [method has_setting]) will be accepted. */ mark_setting_changed(setting: string): void /** Emitted after any editor setting has changed. */ readonly settings_changed: Signal0 } class EditorSettingsDialog = Record> extends AcceptDialog { constructor(identifier?: any) _update_shortcuts(): void _settings_changed(): void } /** Godot editor's control for editing numeric values. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorspinslider.html */ class EditorSpinSlider = Record> extends Range { constructor(identifier?: any) /** The text that displays to the left of the value. */ get label(): string set label(value: string) /** The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed. */ get suffix(): string set suffix(value: string) /** If `true`, the slider can't be interacted with. */ get read_only(): boolean set read_only(value: boolean) /** If `true`, the slider will not draw background. */ get flat(): boolean set flat(value: boolean) /** If `true`, the slider and up/down arrows are hidden. */ get hide_slider(): boolean set hide_slider(value: boolean) /** If `true`, the [EditorSpinSlider] is considered to be editing an integer value. If `false`, the [EditorSpinSlider] is considered to be editing a floating-point value. This is used to determine whether a slider should be drawn. The slider is only drawn for floats; integers use up-down arrows similar to [SpinBox] instead. */ get editing_integer(): boolean set editing_integer(value: boolean) /** Emitted when the spinner/slider is grabbed. */ readonly grabbed: Signal0 /** Emitted when the spinner/slider is ungrabbed. */ readonly ungrabbed: Signal0 /** Emitted when the updown button is pressed. */ readonly updown_pressed: Signal0 /** Emitted when the value form gains focus. */ readonly value_focus_entered: Signal0 /** Emitted when the value form loses focus. */ readonly value_focus_exited: Signal0 } /** Base class for [SyntaxHighlighter] used by the [ScriptEditor]. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorsyntaxhighlighter.html */ class EditorSyntaxHighlighter extends SyntaxHighlighter { constructor(identifier?: any) /** Virtual method which can be overridden to return the syntax highlighter name. */ /* gdvirtual */ _get_name(): string /** Virtual method which can be overridden to return the supported language names. */ /* gdvirtual */ _get_supported_languages(): PackedStringArray _get_edited_resource(): RefCounted } class EditorTexturePreviewPlugin extends EditorResourcePreviewGenerator { constructor(identifier?: any) } class EditorTextureTooltipPlugin extends EditorResourceTooltipPlugin { constructor(identifier?: any) } class EditorTheme extends Theme { constructor(identifier?: any) } class EditorTitleBar = Record> extends HBoxContainer { constructor(identifier?: any) } namespace EditorToaster { enum Severity { /** Toast will display with an INFO severity. */ SEVERITY_INFO = 0, /** Toast will display with a WARNING severity and have a corresponding color. */ SEVERITY_WARNING = 1, /** Toast will display with an ERROR severity and have a corresponding color. */ SEVERITY_ERROR = 2, } } /** Manages toast notifications within the editor. * * @link https://docs.godotengine.org/en/4.4/classes/class_editortoaster.html */ class EditorToaster = Record> extends HBoxContainer { constructor(identifier?: any) /** Pushes a toast notification to the editor for display. */ push_toast(message: string, severity: EditorToaster.Severity = 0, tooltip: string = ''): void } /** Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.). * * @link https://docs.godotengine.org/en/4.4/classes/class_editortranslationparserplugin.html */ class EditorTranslationParserPlugin extends RefCounted { constructor(identifier?: any) /** Override this method to define a custom parsing logic to extract the translatable strings. */ /* gdvirtual */ _parse_file(path: string): GArray /** Gets the list of file extensions to associate with this parser, e.g. `["csv"]`. */ /* gdvirtual */ _get_recognized_extensions(): PackedStringArray } namespace EditorUndoRedoManager { enum SpecialHistory { /** Global history not associated with any scene, but with external resources etc. */ GLOBAL_HISTORY = 0, /** History associated with remote inspector. Used when live editing a running project. */ REMOTE_HISTORY = -9, /** Invalid "null" history. It's a special value, not associated with any object. */ INVALID_HISTORY = -99, } } /** Manages undo history of scenes opened in the editor. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorundoredomanager.html */ class EditorUndoRedoManager extends Object { constructor(identifier?: any) /** Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. * The way actions are merged is dictated by the [param merge_mode] argument. See [enum UndoRedo.MergeMode] for details. * If [param custom_context] object is provided, it will be used for deducing target history (instead of using the first operation). * The way undo operation are ordered in actions is dictated by [param backward_undo_ops]. When [param backward_undo_ops] is `false` undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. */ create_action(name: string, merge_mode: UndoRedo.MergeMode = 0, custom_context: Object = undefined, backward_undo_ops: boolean = false): void /** Commits the action. If [param execute] is `true` (default), all "do" methods/properties are called/set when this function is called. */ commit_action(execute: boolean = true): void /** Returns `true` if the [EditorUndoRedoManager] is currently committing the action, i.e. running its "do" method or property change (see [method commit_action]). */ is_committing_action(): boolean /** Forces the next operation (e.g. [method add_do_method]) to use the action's history rather than guessing it from the object. This is sometimes needed when a history can't be correctly determined, like for a nested resource that doesn't have a path yet. * This method should only be used when absolutely necessary, otherwise it might cause invalid history state. For most of complex cases, the `custom_context` parameter of [method create_action] is sufficient. */ force_fixed_history(): void /** Register a method that will be called when the action is committed (i.e. the "do" action). * If this is the first operation, the [param object] will be used to deduce target undo history. */ add_do_method(object: Object, method: StringName, ...vargargs: any[]): void /** Register a method that will be called when the action is undone (i.e. the "undo" action). * If this is the first operation, the [param object] will be used to deduce target undo history. */ add_undo_method(object: Object, method: StringName, ...vargargs: any[]): void /** Register a property value change for "do". * If this is the first operation, the [param object] will be used to deduce target undo history. */ add_do_property(object: Object, property: StringName, value: any): void /** Register a property value change for "undo". * If this is the first operation, the [param object] will be used to deduce target undo history. */ add_undo_property(object: Object, property: StringName, value: any): void /** Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. */ add_do_reference(object: Object): void /** Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). */ add_undo_reference(object: Object): void /** Returns the history ID deduced from the given [param object]. It can be used with [method get_history_undo_redo]. */ get_object_history_id(object: Object): int64 /** Returns the [UndoRedo] object associated with the given history [param id]. * [param id] above `0` are mapped to the opened scene tabs (but it doesn't match their order). [param id] of `0` or lower have special meaning (see [enum SpecialHistory]). * Best used with [method get_object_history_id]. This method is only provided in case you need some more advanced methods of [UndoRedo] (but keep in mind that directly operating on the [UndoRedo] object might affect editor's stability). */ get_history_undo_redo(id: int64): UndoRedo /** Clears the given undo history. You can clear history for a specific scene, global history, or for all scenes at once if [param id] is [constant INVALID_HISTORY]. * If [param increase_version] is `true`, the undo history version will be increased, marking it as unsaved. Useful for operations that modify the scene, but don't support undo. * * * **Note:** If you want to mark an edited scene as unsaved without clearing its history, use [method EditorInterface.mark_scene_as_unsaved] instead. */ clear_history(id: int64 = -99, increase_version: boolean = true): void /** Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared. */ readonly history_changed: Signal0 /** Emitted when the version of any history has changed as a result of undo or redo call. */ readonly version_changed: Signal0 } namespace EditorVCSInterface { enum ChangeType { /** A new file has been added. */ CHANGE_TYPE_NEW = 0, /** An earlier added file has been modified. */ CHANGE_TYPE_MODIFIED = 1, /** An earlier added file has been renamed. */ CHANGE_TYPE_RENAMED = 2, /** An earlier added file has been deleted. */ CHANGE_TYPE_DELETED = 3, /** An earlier added file has been typechanged. */ CHANGE_TYPE_TYPECHANGE = 4, /** A file is left unmerged. */ CHANGE_TYPE_UNMERGED = 5, } enum TreeArea { /** A commit is encountered from the commit area. */ TREE_AREA_COMMIT = 0, /** A file is encountered from the staged area. */ TREE_AREA_STAGED = 1, /** A file is encountered from the unstaged area. */ TREE_AREA_UNSTAGED = 2, } } /** Version Control System (VCS) interface, which reads and writes to the local VCS in use. * * @link https://docs.godotengine.org/en/4.4/classes/class_editorvcsinterface.html */ class EditorVCSInterface extends Object { constructor(identifier?: any) /** Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at [param project_path]. */ /* gdvirtual */ _initialize(project_path: string): boolean /** Set user credentials in the underlying VCS. [param username] and [param password] are used only during HTTPS authentication unless not already mentioned in the remote URL. [param ssh_public_key_path], [param ssh_private_key_path], and [param ssh_passphrase] are only used during SSH authentication. */ /* gdvirtual */ _set_credentials(username: string, password: string, ssh_public_key_path: string, ssh_private_key_path: string, ssh_passphrase: string): void /** Returns an [Array] of [Dictionary] items (see [method create_status_file]), each containing the status data of every modified file in the project folder. */ /* gdvirtual */ _get_modified_files_data(): GArray /** Stages the file present at [param file_path] to the staged area. */ /* gdvirtual */ _stage_file(file_path: string): void /** Unstages the file present at [param file_path] from the staged area to the unstaged area. */ /* gdvirtual */ _unstage_file(file_path: string): void /** Discards the changes made in a file present at [param file_path]. */ /* gdvirtual */ _discard_file(file_path: string): void /** Commits the currently staged changes and applies the commit [param msg] to the resulting commit. */ /* gdvirtual */ _commit(msg: string): void /** Returns an array of [Dictionary] items (see [method create_diff_file], [method create_diff_hunk], [method create_diff_line], [method add_line_diffs_into_diff_hunk] and [method add_diff_hunks_into_diff_file]), each containing information about a diff. If [param identifier] is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff. */ /* gdvirtual */ _get_diff(identifier: string, area: int64): GArray /** Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI. */ /* gdvirtual */ _shut_down(): boolean /** Returns the name of the underlying VCS provider. */ /* gdvirtual */ _get_vcs_name(): string /** Returns an [Array] of [Dictionary] items (see [method create_commit]), each containing the data for a past commit. */ /* gdvirtual */ _get_previous_commits(max_commits: int64): GArray /** Gets an instance of an [Array] of [String]s containing available branch names in the VCS. */ /* gdvirtual */ _get_branch_list(): GArray /** Returns an [Array] of [String]s, each containing the name of a remote configured in the VCS. */ /* gdvirtual */ _get_remotes(): GArray /** Creates a new branch named [param branch_name] in the VCS. */ /* gdvirtual */ _create_branch(branch_name: string): void /** Remove a branch from the local VCS. */ /* gdvirtual */ _remove_branch(branch_name: string): void /** Creates a new remote destination with name [param remote_name] and points it to [param remote_url]. This can be an HTTPS remote or an SSH remote. */ /* gdvirtual */ _create_remote(remote_name: string, remote_url: string): void /** Remove a remote from the local VCS. */ /* gdvirtual */ _remove_remote(remote_name: string): void /** Gets the current branch name defined in the VCS. */ /* gdvirtual */ _get_current_branch_name(): string /** Checks out a [param branch_name] in the VCS. */ /* gdvirtual */ _checkout_branch(branch_name: string): boolean /** Pulls changes from the remote. This can give rise to merge conflicts. */ /* gdvirtual */ _pull(remote: string): void /** Pushes changes to the [param remote]. If [param force] is `true`, a force push will override the change history already present on the remote. */ /* gdvirtual */ _push(remote: string, force: boolean): void /** Fetches new changes from the [param remote], but doesn't write changes to the current working directory. Equivalent to `git fetch`. */ /* gdvirtual */ _fetch(remote: string): void /** Returns an [Array] of [Dictionary] items (see [method create_diff_hunk]), each containing a line diff between a file at [param file_path] and the [param text] which is passed in. */ /* gdvirtual */ _get_line_diff(file_path: string, text: string): GArray /** Helper function to create a [Dictionary] for storing a line diff. [param new_line_no] is the line number in the new file (can be `-1` if the line is deleted). [param old_line_no] is the line number in the old file (can be `-1` if the line is added). [param content] is the diff text. [param status] is a single character string which stores the line origin. */ create_diff_line(new_line_no: int64, old_line_no: int64, content: string, status: string): GDictionary /** Helper function to create a [Dictionary] for storing diff hunk data. [param old_start] is the starting line number in old file. [param new_start] is the starting line number in new file. [param old_lines] is the number of lines in the old file. [param new_lines] is the number of lines in the new file. */ create_diff_hunk(old_start: int64, new_start: int64, old_lines: int64, new_lines: int64): GDictionary /** Helper function to create a [Dictionary] for storing old and new diff file paths. */ create_diff_file(new_file: string, old_file: string): GDictionary /** Helper function to create a commit [Dictionary] item. [param msg] is the commit message of the commit. [param author] is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. [param id] is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. [param unix_timestamp] is the UTC Unix timestamp of when the commit was created. [param offset_minutes] is the timezone offset in minutes, recorded from the system timezone where the commit was created. */ create_commit(msg: string, author: string, id: string, unix_timestamp: int64, offset_minutes: int64): GDictionary /** Helper function to create a [Dictionary] used by editor to read the status of a file. */ create_status_file(file_path: string, change_type: EditorVCSInterface.ChangeType, area: EditorVCSInterface.TreeArea): GDictionary /** Helper function to add an array of [param diff_hunks] into a [param diff_file]. */ add_diff_hunks_into_diff_file(diff_file: GDictionary, diff_hunks: GArray): GDictionary /** Helper function to add an array of [param line_diffs] into a [param diff_hunk]. */ add_line_diffs_into_diff_hunk(diff_hunk: GDictionary, line_diffs: GArray): GDictionary /** Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages. */ popup_error(msg: string): void } class EditorValidationPanel = Record> extends PanelContainer { constructor(identifier?: any) } class EditorVersionButton = Record> extends LinkButton { constructor(identifier?: any) } class EditorVisualProfiler = Record> extends VBoxContainer { constructor(identifier?: any) readonly enable_profiling: Signal1 } class EditorZoomWidget = Record> extends HBoxContainer { constructor(identifier?: any) set_zoom_by_increments(increment: int64, integer_only: boolean): void get zoom(): float64 set zoom(value: float64) readonly zoom_changed: Signal1 } class EmbeddedProcess = Record> extends Control { constructor(identifier?: any) readonly embedding_completed: Signal0 readonly embedding_failed: Signal0 readonly embedded_process_updated: Signal0 readonly embedded_process_focused: Signal0 } /** Holds a reference to an [Object]'s instance ID. * * @link https://docs.godotengine.org/en/4.4/classes/class_encodedobjectasid.html */ class EncodedObjectAsID extends RefCounted { constructor(identifier?: any) /** The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GlobalScope.instance_from_id]. */ get object_id(): int64 set object_id(value: int64) } /** Base class for creating custom profilers. * * @link https://docs.godotengine.org/en/4.4/classes/class_engineprofiler.html */ class EngineProfiler extends RefCounted { constructor(identifier?: any) /** Called when the profiler is enabled/disabled, along with a set of [param options]. */ /* gdvirtual */ _toggle(enable: boolean, options: GArray): void /** Called when data is added to profiler using [method EngineDebugger.profiler_add_frame_data]. */ /* gdvirtual */ _add_frame(data: GArray): void /** Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better. */ /* gdvirtual */ _tick(frame_time: float64, process_time: float64, physics_time: float64, physics_frame_time: float64): void } namespace Environment { enum BGMode { /** Clears the background using the clear color defined in [member ProjectSettings.rendering/environment/defaults/default_clear_color]. */ BG_CLEAR_COLOR = 0, /** Clears the background using a custom clear color. */ BG_COLOR = 1, /** Displays a user-defined sky in the background. */ BG_SKY = 2, /** Displays a [CanvasLayer] in the background. */ BG_CANVAS = 3, /** Keeps on screen every pixel drawn in the background. This is the fastest background mode, but it can only be safely used in fully-interior scenes (no visible sky or sky reflections). If enabled in a scene where the background is visible, "ghost trail" artifacts will be visible when moving the camera. */ BG_KEEP = 4, /** Displays a camera feed in the background. */ BG_CAMERA_FEED = 5, /** Represents the size of the [enum BGMode] enum. */ BG_MAX = 6, } enum AmbientSource { /** Gather ambient light from whichever source is specified as the background. */ AMBIENT_SOURCE_BG = 0, /** Disable ambient light. This provides a slight performance boost over [constant AMBIENT_SOURCE_SKY]. */ AMBIENT_SOURCE_DISABLED = 1, /** Specify a specific [Color] for ambient light. This provides a slight performance boost over [constant AMBIENT_SOURCE_SKY]. */ AMBIENT_SOURCE_COLOR = 2, /** Gather ambient light from the [Sky] regardless of what the background is. */ AMBIENT_SOURCE_SKY = 3, } enum ReflectionSource { /** Use the background for reflections. */ REFLECTION_SOURCE_BG = 0, /** Disable reflections. This provides a slight performance boost over other options. */ REFLECTION_SOURCE_DISABLED = 1, /** Use the [Sky] for reflections regardless of what the background is. */ REFLECTION_SOURCE_SKY = 2, } enum ToneMapper { /** Does not modify color data, resulting in a linear tonemapping curve which unnaturally clips bright values, causing bright lighting to look blown out. The simplest and fastest tonemapper. */ TONE_MAPPER_LINEAR = 0, /** A simple tonemapping curve that rolls off bright values to prevent clipping. This results in an image that can appear dull and low contrast. Slower than [constant TONE_MAPPER_LINEAR]. * * **Note:** When [member tonemap_white] is left at the default value of `1.0`, [constant TONE_MAPPER_REINHARDT] produces an identical image to [constant TONE_MAPPER_LINEAR]. */ TONE_MAPPER_REINHARDT = 1, /** Uses a film-like tonemapping curve to prevent clipping of bright values and provide better contrast than [constant TONE_MAPPER_REINHARDT]. Slightly slower than [constant TONE_MAPPER_REINHARDT]. */ TONE_MAPPER_FILMIC = 2, /** Uses a high-contrast film-like tonemapping curve and desaturates bright values for a more realistic appearance. Slightly slower than [constant TONE_MAPPER_FILMIC]. * * **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x. */ TONE_MAPPER_ACES = 3, /** Uses a film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. * * **Note:** [member tonemap_white] is fixed at a value of `16.29`, which makes [constant TONE_MAPPER_AGX] unsuitable for use with the Mobile rendering method. */ TONE_MAPPER_AGX = 4, } enum GlowBlendMode { /** Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. */ GLOW_BLEND_MODE_ADDITIVE = 0, /** Screen glow blending mode. Increases brightness, used frequently with bloom. */ GLOW_BLEND_MODE_SCREEN = 1, /** Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom). */ GLOW_BLEND_MODE_SOFTLIGHT = 2, /** Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness. */ GLOW_BLEND_MODE_REPLACE = 3, /** Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect. */ GLOW_BLEND_MODE_MIX = 4, } enum FogMode { /** Use a physically-based fog model defined primarily by fog density. */ FOG_MODE_EXPONENTIAL = 0, /** Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control. */ FOG_MODE_DEPTH = 1, } enum SDFGIYScale { /** Use 50% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be twice as short as they are wide. This allows providing increased GI detail and reduced light leaking with thin floors and ceilings. This is usually the best choice for scenes that don't feature much verticality. */ SDFGI_Y_SCALE_50_PERCENT = 0, /** Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales. */ SDFGI_Y_SCALE_75_PERCENT = 1, /** Use 100% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be as tall as they are wide. This is usually the best choice for highly vertical scenes. The downside is that light leaking may become more noticeable with thin floors and ceilings. */ SDFGI_Y_SCALE_100_PERCENT = 2, } } /** Resource for environment nodes (like [WorldEnvironment]) that define multiple rendering options. * * @link https://docs.godotengine.org/en/4.4/classes/class_environment.html */ class Environment extends Resource { constructor(identifier?: any) /** Sets the intensity of the glow level [param idx]. A value above `0.0` enables the level. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. */ set_glow_level(idx: int64, intensity: float64): void /** Returns the intensity of the glow level [param idx]. */ get_glow_level(idx: int64): float64 /** The background mode. See [enum BGMode] for possible values. */ get background_mode(): int64 set background_mode(value: int64) /** The [Color] displayed for clear areas of the scene. Only effective when using the [constant BG_COLOR] background mode. */ get background_color(): Color set background_color(value: Color) /** Multiplier for background energy. Increase to make background brighter, decrease to make background dimmer. */ get background_energy_multiplier(): float64 set background_energy_multiplier(value: float64) /** Luminance of background measured in nits (candela per square meter). Only used when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is enabled. The default value is roughly equivalent to the sky at midday. */ get background_intensity(): float64 set background_intensity(value: float64) /** The maximum layer ID to display. Only effective when using the [constant BG_CANVAS] background mode. */ get background_canvas_max_layer(): int64 set background_canvas_max_layer(value: int64) /** The ID of the camera feed to show in the background. */ get background_camera_feed_id(): int64 set background_camera_feed_id(value: int64) /** The [Sky] resource used for this [Environment]. */ get sky(): Sky set sky(value: Sky) /** If set to a value greater than `0.0`, overrides the field of view to use for sky rendering. If set to `0.0`, the same FOV as the current [Camera3D] is used for sky rendering. */ get sky_custom_fov(): float64 set sky_custom_fov(value: float64) /** The rotation to use for sky rendering. */ get sky_rotation(): Vector3 set sky_rotation(value: Vector3) /** The ambient light source to use for rendering materials and global illumination. */ get ambient_light_source(): int64 set ambient_light_source(value: int64) /** The ambient light's [Color]. Only effective if [member ambient_light_sky_contribution] is lower than `1.0` (exclusive). */ get ambient_light_color(): Color set ambient_light_color(value: Color) /** Defines the amount of light that the sky brings on the scene. A value of `0.0` means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of `1.0` means that *all* the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. * * **Note:** [member ambient_light_sky_contribution] is internally clamped between `0.0` and `1.0` (inclusive). */ get ambient_light_sky_contribution(): float64 set ambient_light_sky_contribution(value: float64) /** The ambient light's energy. The higher the value, the stronger the light. Only effective if [member ambient_light_sky_contribution] is lower than `1.0` (exclusive). */ get ambient_light_energy(): float64 set ambient_light_energy(value: float64) /** The reflected (specular) light source. */ get reflected_light_source(): int64 set reflected_light_source(value: int64) /** The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on an LDR display. (Godot doesn't support rendering on HDR displays yet.) */ get tonemap_mode(): int64 set tonemap_mode(value: int64) /** Adjusts the brightness of values before they are provided to the tonemapper. Higher [member tonemap_exposure] values result in a brighter image. See also [member tonemap_white]. * * **Note:** Values provided to the tonemapper will also be multiplied by `2.0` and `1.8` for [constant TONE_MAPPER_FILMIC] and [constant TONE_MAPPER_ACES] respectively to produce a similar apparent brightness as [constant TONE_MAPPER_LINEAR]. */ get tonemap_exposure(): float64 set tonemap_exposure(value: float64) /** The white reference value for tonemapping, which indicates where bright white is located in the scale of values provided to the tonemapper. For photorealistic lighting, recommended values are between `6.0` and `8.0`. Higher values result in less blown out highlights, but may make the scene appear lower contrast. See also [member tonemap_exposure]. * * **Note:** [member tonemap_white] is ignored when using [constant TONE_MAPPER_LINEAR] or [constant TONE_MAPPER_AGX]. */ get tonemap_white(): float64 set tonemap_white(value: float64) /** If `true`, screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from [VoxelGI]s or [ReflectionProbe]s, but are slower and can't reflect surfaces occluded by others. * * **Note:** SSR is only supported in the Forward+ rendering method, not Mobile or Compatibility. */ get ssr_enabled(): boolean set ssr_enabled(value: boolean) /** The maximum number of steps for screen-space reflections. Higher values are slower. */ get ssr_max_steps(): int64 set ssr_max_steps(value: int64) /** The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection. Only positive values are valid (negative values will be clamped to `0.0`). */ get ssr_fade_in(): float64 set ssr_fade_in(value: float64) /** The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection. Only positive values are valid (negative values will be clamped to `0.0`). */ get ssr_fade_out(): float64 set ssr_fade_out(value: float64) /** The depth tolerance for screen-space reflections. */ get ssr_depth_tolerance(): float64 set ssr_depth_tolerance(value: float64) /** If `true`, the screen-space ambient occlusion effect is enabled. This darkens objects' corners and cavities to simulate ambient light not reaching the entire object as in real life. This works well for small, dynamic objects, but baked lighting or ambient occlusion textures will do a better job at displaying ambient occlusion on large static objects. Godot uses a form of SSAO called Adaptive Screen Space Ambient Occlusion which is itself a form of Horizon Based Ambient Occlusion. * * **Note:** SSAO is only supported in the Forward+ rendering method, not Mobile or Compatibility. */ get ssao_enabled(): boolean set ssao_enabled(value: boolean) /** The distance at which objects can occlude each other when calculating screen-space ambient occlusion. Higher values will result in occlusion over a greater distance at the cost of performance and quality. */ get ssao_radius(): float64 set ssao_radius(value: float64) /** The primary screen-space ambient occlusion intensity. Acts as a multiplier for the screen-space ambient occlusion effect. A higher value results in darker occlusion. */ get ssao_intensity(): float64 set ssao_intensity(value: float64) /** The distribution of occlusion. A higher value results in darker occlusion, similar to [member ssao_intensity], but with a sharper falloff. */ get ssao_power(): float64 set ssao_power(value: float64) /** Sets the strength of the additional level of detail for the screen-space ambient occlusion effect. A high value makes the detail pass more prominent, but it may contribute to aliasing in your final image. */ get ssao_detail(): float64 set ssao_detail(value: float64) /** The threshold for considering whether a given point on a surface is occluded or not represented as an angle from the horizon mapped into the `0.0-1.0` range. A value of `1.0` results in no occlusion. */ get ssao_horizon(): float64 set ssao_horizon(value: float64) /** The amount that the screen-space ambient occlusion effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry. */ get ssao_sharpness(): float64 set ssao_sharpness(value: float64) /** The screen-space ambient occlusion intensity in direct light. In real life, ambient occlusion only applies to indirect light, which means its effects can't be seen in direct light. Values higher than `0` will make the SSAO effect visible in direct light. */ get ssao_light_affect(): float64 set ssao_light_affect(value: float64) /** The screen-space ambient occlusion intensity on materials that have an AO texture defined. Values higher than `0` will make the SSAO effect visible in areas darkened by AO textures. */ get ssao_ao_channel_affect(): float64 set ssao_ao_channel_affect(value: float64) /** If `true`, the screen-space indirect lighting effect is enabled. Screen space indirect lighting is a form of indirect lighting that allows diffuse light to bounce between nearby objects. Screen-space indirect lighting works very similarly to screen-space ambient occlusion, in that it only affects a limited range. It is intended to be used along with a form of proper global illumination like SDFGI or [VoxelGI]. Screen-space indirect lighting is not affected by individual light's [member Light3D.light_indirect_energy]. * * **Note:** SSIL is only supported in the Forward+ rendering method, not Mobile or Compatibility. */ get ssil_enabled(): boolean set ssil_enabled(value: boolean) /** The distance that bounced lighting can travel when using the screen space indirect lighting effect. A larger value will result in light bouncing further in a scene, but may result in under-sampling artifacts which look like long spikes surrounding light sources. */ get ssil_radius(): float64 set ssil_radius(value: float64) /** The brightness multiplier for the screen-space indirect lighting effect. A higher value will result in brighter light. */ get ssil_intensity(): float64 set ssil_intensity(value: float64) /** The amount that the screen-space indirect lighting effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry. */ get ssil_sharpness(): float64 set ssil_sharpness(value: float64) /** Amount of normal rejection used when calculating screen-space indirect lighting. Normal rejection uses the normal of a given sample point to reject samples that are facing away from the current pixel. Normal rejection is necessary to avoid light leaking when only one side of an object is illuminated. However, normal rejection can be disabled if light leaking is desirable, such as when the scene mostly contains emissive objects that emit light from faces that cannot be seen from the camera. */ get ssil_normal_rejection(): float64 set ssil_normal_rejection(value: float64) /** If `true`, enables signed distance field global illumination for meshes that have their [member GeometryInstance3D.gi_mode] set to [constant GeometryInstance3D.GI_MODE_STATIC]. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not. * * **Note:** SDFGI is only supported in the Forward+ rendering method, not Mobile or Compatibility. * **Performance:** SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider [LightmapGI] instead). To improve SDFGI performance, enable [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution] in the Project Settings. * * **Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. */ get sdfgi_enabled(): boolean set sdfgi_enabled(value: boolean) /** If `true`, SDFGI uses an occlusion detection approach to reduce light leaking. Occlusion may however introduce dark blotches in certain spots, which may be undesired in mostly outdoor scenes. [member sdfgi_use_occlusion] has a performance impact and should only be enabled when needed. */ get sdfgi_use_occlusion(): boolean set sdfgi_use_occlusion(value: boolean) /** If `true`, SDFGI takes the environment lighting into account. This should be set to `false` for interior scenes. */ get sdfgi_read_sky_light(): boolean set sdfgi_read_sky_light(value: boolean) /** The energy multiplier applied to light every time it bounces from a surface when using SDFGI. Values greater than `0.0` will simulate multiple bounces, resulting in a more realistic appearance. Increasing [member sdfgi_bounce_feedback] generally has no performance impact. See also [member sdfgi_energy]. * * **Note:** Values greater than `0.5` can cause infinite feedback loops and should be avoided in scenes with bright materials. * * **Note:** If [member sdfgi_bounce_feedback] is `0.0`, indirect lighting will not be represented in reflections as light will only bounce one time. */ get sdfgi_bounce_feedback(): float64 set sdfgi_bounce_feedback(value: float64) /** The number of cascades to use for SDFGI (between 1 and 8). A higher number of cascades allows displaying SDFGI further away while preserving detail up close, at the cost of performance. When using SDFGI on small-scale levels, [member sdfgi_cascades] can often be decreased between `1` and `4` to improve performance. */ get sdfgi_cascades(): int64 set sdfgi_cascades(value: int64) /** The cell size to use for the closest SDFGI cascade (in 3D units). Lower values allow SDFGI to be more precise up close, at the cost of making SDFGI updates more demanding. This can cause stuttering when the camera moves fast. Higher values allow SDFGI to cover more ground, while also reducing the performance impact of SDFGI updates. * * **Note:** This property is linked to [member sdfgi_max_distance] and [member sdfgi_cascade0_distance]. Changing its value will automatically change those properties as well. */ get sdfgi_min_cell_size(): float64 set sdfgi_min_cell_size(value: float64) /** * **Note:** This property is linked to [member sdfgi_min_cell_size] and [member sdfgi_max_distance]. Changing its value will automatically change those properties as well. */ get sdfgi_cascade0_distance(): float64 set sdfgi_cascade0_distance(value: float64) /** The maximum distance at which SDFGI is visible. Beyond this distance, environment lighting or other sources of GI such as [ReflectionProbe] will be used as a fallback. * * **Note:** This property is linked to [member sdfgi_min_cell_size] and [member sdfgi_cascade0_distance]. Changing its value will automatically change those properties as well. */ get sdfgi_max_distance(): float64 set sdfgi_max_distance(value: float64) /** The Y scale to use for SDFGI cells. Lower values will result in SDFGI cells being packed together more closely on the Y axis. This is used to balance between quality and covering a lot of vertical ground. [member sdfgi_y_scale] should be set depending on how vertical your scene is (and how fast your camera may move on the Y axis). */ get sdfgi_y_scale(): int64 set sdfgi_y_scale(value: int64) /** The energy multiplier to use for SDFGI. Higher values will result in brighter indirect lighting and reflections. See also [member sdfgi_bounce_feedback]. */ get sdfgi_energy(): float64 set sdfgi_energy(value: float64) /** The normal bias to use for SDFGI probes. Increasing this value can reduce visible streaking artifacts on sloped surfaces, at the cost of increased light leaking. */ get sdfgi_normal_bias(): float64 set sdfgi_normal_bias(value: float64) /** The constant bias to use for SDFGI probes. Increasing this value can reduce visible streaking artifacts on sloped surfaces, at the cost of increased light leaking. */ get sdfgi_probe_bias(): float64 set sdfgi_probe_bias(value: float64) /** If `true`, the glow effect is enabled. This simulates real world eye/camera behavior where bright pixels bleed onto surrounding pixels. * * **Note:** When using the Mobile rendering method, glow looks different due to the lower dynamic range available in the Mobile rendering method. * * **Note:** When using the Compatibility rendering method, glow uses a different implementation with some properties being unavailable and hidden from the inspector: `glow_levels/*`, [member glow_normalized], [member glow_strength], [member glow_blend_mode], [member glow_mix], [member glow_map], and [member glow_map_strength]. This implementation is optimized to run on low-end devices and is less flexible as a result. */ get glow_enabled(): boolean set glow_enabled(value: boolean) /** The intensity of the 1st level of glow. This is the most "local" level (least blurry). * * **Note:** [member glow_levels/1] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/1"(): float64 set "glow_levels/1"(value: float64) /** The intensity of the 2nd level of glow. * * **Note:** [member glow_levels/2] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/2"(): float64 set "glow_levels/2"(value: float64) /** The intensity of the 3rd level of glow. * * **Note:** [member glow_levels/3] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/3"(): float64 set "glow_levels/3"(value: float64) /** The intensity of the 4th level of glow. * * **Note:** [member glow_levels/4] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/4"(): float64 set "glow_levels/4"(value: float64) /** The intensity of the 5th level of glow. * * **Note:** [member glow_levels/5] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/5"(): float64 set "glow_levels/5"(value: float64) /** The intensity of the 6th level of glow. * * **Note:** [member glow_levels/6] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/6"(): float64 set "glow_levels/6"(value: float64) /** The intensity of the 7th level of glow. This is the most "global" level (blurriest). * * **Note:** [member glow_levels/7] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get "glow_levels/7"(): float64 set "glow_levels/7"(value: float64) /** If `true`, glow levels will be normalized so that summed together their intensities equal `1.0`. * * **Note:** [member glow_normalized] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_normalized(): boolean set glow_normalized(value: boolean) /** The overall brightness multiplier of the glow effect. When using the Mobile rendering method (which only supports a lower dynamic range up to `2.0`), this should be increased to `1.5` to compensate. */ get glow_intensity(): float64 set glow_intensity(value: float64) /** The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the Mobile rendering method, this should be increased to compensate for the lower dynamic range. * * **Note:** [member glow_strength] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_strength(): float64 set glow_strength(value: float64) /** When using the [constant GLOW_BLEND_MODE_MIX] [member glow_blend_mode], this controls how much the source image is blended with the glow layer. A value of `0.0` makes the glow rendering invisible, while a value of `1.0` is equivalent to [constant GLOW_BLEND_MODE_REPLACE]. * * **Note:** [member glow_mix] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_mix(): float64 set glow_mix(value: float64) /** The bloom's intensity. If set to a value higher than `0`, this will make glow visible in areas darker than the [member glow_hdr_threshold]. */ get glow_bloom(): float64 set glow_bloom(value: float64) /** The glow blending mode. * * **Note:** [member glow_blend_mode] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_blend_mode(): int64 set glow_blend_mode(value: int64) /** The lower threshold of the HDR glow. When using the Mobile rendering method (which only supports a lower dynamic range up to `2.0`), this may need to be below `1.0` for glow to be visible. A value of `0.9` works well in this case. This value also needs to be decreased below `1.0` when using glow in 2D, as 2D rendering is performed in SDR. */ get glow_hdr_threshold(): float64 set glow_hdr_threshold(value: float64) /** The bleed scale of the HDR glow. */ get glow_hdr_scale(): float64 set glow_hdr_scale(value: float64) /** The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect. */ get glow_hdr_luminance_cap(): float64 set glow_hdr_luminance_cap(value: float64) /** How strong of an influence the [member glow_map] should have on the overall glow effect. A strength of `0.0` means the glow map has no influence, while a strength of `1.0` means the glow map has full influence. * * **Note:** If the glow map has black areas, a value of `1.0` can also turn off the glow effect entirely in specific areas of the screen. * * **Note:** [member glow_map_strength] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_map_strength(): float64 set glow_map_strength(value: float64) /** The texture that should be used as a glow map to *multiply* the resulting glow color according to [member glow_map_strength]. This can be used to create a "lens dirt" effect. The texture's RGB color channels are used for modulation, but the alpha channel is ignored. * * **Note:** The texture will be stretched to fit the screen. Therefore, it's recommended to use a texture with an aspect ratio that matches your project's base aspect ratio (typically 16:9). * * **Note:** [member glow_map] has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices. */ get glow_map(): Texture2D set glow_map(value: Texture2D) /** If `true`, fog effects are enabled. */ get fog_enabled(): boolean set fog_enabled(value: boolean) /** The fog mode. See [enum FogMode] for possible values. */ get fog_mode(): int64 set fog_mode(value: int64) /** The fog's color. */ get fog_light_color(): Color set fog_light_color(value: Color) /** The fog's brightness. Higher values result in brighter fog. */ get fog_light_energy(): float64 set fog_light_energy(value: float64) /** If set above `0.0`, renders the scene's directional light(s) in the fog color depending on the view angle. This can be used to give the impression that the sun is "piercing" through the fog. */ get fog_sun_scatter(): float64 set fog_sun_scatter(value: float64) /** The fog density to be used. This is demonstrated in different ways depending on the [member fog_mode] mode chosen: * **Exponential Fog Mode:** Higher values result in denser fog. The fog rendering is exponential like in real life. * **Depth Fog mode:** The maximum intensity of the deep fog, effect will appear in the distance (relative to the camera). At `1.0` the fog will fully obscure the scene, at `0.0` the fog will not be visible. */ get fog_density(): float64 set fog_density(value: float64) /** If set above `0.0` (exclusive), blends between the fog's color and the color of the background [Sky], as read from the radiance cubemap. This has a small performance cost when set above `0.0`. Must have [member background_mode] set to [constant BG_SKY]. * This is useful to simulate [url=https://en.wikipedia.org/wiki/Aerial_perspective]aerial perspective[/url] in large scenes with low density fog. However, it is not very useful for high-density fog, as the sky will shine through. When set to `1.0`, the fog color comes completely from the [Sky]. If set to `0.0`, aerial perspective is disabled. * Notice that this does not sample the [Sky] directly, but rather the radiance cubemap. The cubemap is sampled at a mipmap level depending on the depth of the rendered pixel; the farther away, the higher the resolution of the sampled mipmap. This results in the actual color being a blurred version of the sky, with more blur closer to the camera. The highest mipmap resolution is used at a depth of [member Camera3D.far]. */ get fog_aerial_perspective(): float64 set fog_aerial_perspective(value: float64) /** The factor to use when affecting the sky with non-volumetric fog. `1.0` means that fog can fully obscure the sky. Lower values reduce the impact of fog on sky rendering, with `0.0` not affecting sky rendering at all. * * **Note:** [member fog_sky_affect] has no visual effect if [member fog_aerial_perspective] is `1.0`. */ get fog_sky_affect(): float64 set fog_sky_affect(value: float64) /** The height at which the height fog effect begins. */ get fog_height(): float64 set fog_height(value: float64) /** The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value. */ get fog_height_density(): float64 set fog_height_density(value: float64) /** The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve. Only available when [member fog_mode] is set to [constant FOG_MODE_DEPTH]. */ get fog_depth_curve(): float64 set fog_depth_curve(value: float64) /** The fog's depth starting distance from the camera. Only available when [member fog_mode] is set to [constant FOG_MODE_DEPTH]. */ get fog_depth_begin(): float64 set fog_depth_begin(value: float64) /** The fog's depth end distance from the camera. If this value is set to `0`, it will be equal to the current camera's [member Camera3D.far] value. Only available when [member fog_mode] is set to [constant FOG_MODE_DEPTH]. */ get fog_depth_end(): float64 set fog_depth_end(value: float64) /** Enables the volumetric fog effect. Volumetric fog uses a screen-aligned froxel buffer to calculate accurate volumetric scattering in the short to medium range. Volumetric fog interacts with [FogVolume]s and lights to calculate localized and global fog. Volumetric fog uses a PBR single-scattering model based on extinction, scattering, and emission which it exposes to users as density, albedo, and emission. * * **Note:** Volumetric fog is only supported in the Forward+ rendering method, not Mobile or Compatibility. */ get volumetric_fog_enabled(): boolean set volumetric_fog_enabled(value: boolean) /** The base *exponential* density of the volumetric fog. Set this to the lowest density you want to have globally. [FogVolume]s can be used to add to or subtract from this density in specific areas. Fog rendering is exponential as in real life. * A value of `0.0` disables global volumetric fog while allowing [FogVolume]s to display volumetric fog in specific areas. * To make volumetric fog work as a volumetric *lighting* solution, set [member volumetric_fog_density] to the lowest non-zero value (`0.0001`) then increase lights' [member Light3D.light_volumetric_fog_energy] to values between `10000` and `100000` to compensate for the very low density. */ get volumetric_fog_density(): float64 set volumetric_fog_density(value: float64) /** The [Color] of the volumetric fog when interacting with lights. Mist and fog have an albedo close to `Color(1, 1, 1, 1)` while smoke has a darker albedo. */ get volumetric_fog_albedo(): Color set volumetric_fog_albedo(value: Color) /** The emitted light from the volumetric fog. Even with emission, volumetric fog will not cast light onto other surfaces. Emission is useful to establish an ambient color. As the volumetric fog effect uses single-scattering only, fog tends to need a little bit of emission to soften the harsh shadows. */ get volumetric_fog_emission(): Color set volumetric_fog_emission(value: Color) /** The brightness of the emitted light from the volumetric fog. */ get volumetric_fog_emission_energy(): float64 set volumetric_fog_emission_energy(value: float64) /** Scales the strength of Global Illumination used in the volumetric fog's albedo color. A value of `0.0` means that Global Illumination will not impact the volumetric fog. [member volumetric_fog_gi_inject] has a small performance cost when set above `0.0`. * * **Note:** This has no visible effect if [member volumetric_fog_density] is `0.0` or if [member volumetric_fog_albedo] is a fully black color. * * **Note:** Only [VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) are taken into account when using [member volumetric_fog_gi_inject]. Global illumination from [LightmapGI], [ReflectionProbe] and SSIL (see [member ssil_enabled]) will be ignored by volumetric fog. */ get volumetric_fog_gi_inject(): float64 set volumetric_fog_gi_inject(value: float64) /** The direction of scattered light as it goes through the volumetric fog. A value close to `1.0` means almost all light is scattered forward. A value close to `0.0` means light is scattered equally in all directions. A value close to `-1.0` means light is scattered mostly backward. Fog and mist scatter light slightly forward, while smoke scatters light equally in all directions. */ get volumetric_fog_anisotropy(): float64 set volumetric_fog_anisotropy(value: float64) /** The distance over which the volumetric fog is computed. Increase to compute fog over a greater range, decrease to add more detail when a long range is not needed. For best quality fog, keep this as low as possible. See also [member ProjectSettings.rendering/environment/volumetric_fog/volume_depth]. */ get volumetric_fog_length(): float64 set volumetric_fog_length(value: float64) /** The distribution of size down the length of the froxel buffer. A higher value compresses the froxels closer to the camera and places more detail closer to the camera. */ get volumetric_fog_detail_spread(): float64 set volumetric_fog_detail_spread(value: float64) /** Scales the strength of ambient light used in the volumetric fog. A value of `0.0` means that ambient light will not impact the volumetric fog. [member volumetric_fog_ambient_inject] has a small performance cost when set above `0.0`. * * **Note:** This has no visible effect if [member volumetric_fog_density] is `0.0` or if [member volumetric_fog_albedo] is a fully black color. */ get volumetric_fog_ambient_inject(): float64 set volumetric_fog_ambient_inject(value: float64) /** The factor to use when affecting the sky with volumetric fog. `1.0` means that volumetric fog can fully obscure the sky. Lower values reduce the impact of volumetric fog on sky rendering, with `0.0` not affecting sky rendering at all. * * **Note:** [member volumetric_fog_sky_affect] also affects [FogVolume]s, even if [member volumetric_fog_density] is `0.0`. If you notice [FogVolume]s are disappearing when looking towards the sky, set [member volumetric_fog_sky_affect] to `1.0`. */ get volumetric_fog_sky_affect(): float64 set volumetric_fog_sky_affect(value: float64) /** Enables temporal reprojection in the volumetric fog. Temporal reprojection blends the current frame's volumetric fog with the last frame's volumetric fog to smooth out jagged edges. The performance cost is minimal; however, it leads to moving [FogVolume]s and [Light3D]s "ghosting" and leaving a trail behind them. When temporal reprojection is enabled, try to avoid moving [FogVolume]s or [Light3D]s too fast. Short-lived dynamic lighting effects should have [member Light3D.light_volumetric_fog_energy] set to `0.0` to avoid ghosting. */ get volumetric_fog_temporal_reprojection_enabled(): boolean set volumetric_fog_temporal_reprojection_enabled(value: boolean) /** The amount by which to blend the last frame with the current frame. A higher number results in smoother volumetric fog, but makes "ghosting" much worse. A lower value reduces ghosting but can result in the per-frame temporal jitter becoming visible. */ get volumetric_fog_temporal_reprojection_amount(): float64 set volumetric_fog_temporal_reprojection_amount(value: float64) /** If `true`, enables the `adjustment_*` properties provided by this resource. If `false`, modifications to the `adjustment_*` properties will have no effect on the rendered scene. */ get adjustment_enabled(): boolean set adjustment_enabled(value: boolean) /** The global brightness value of the rendered scene. Effective only if [member adjustment_enabled] is `true`. */ get adjustment_brightness(): float64 set adjustment_brightness(value: float64) /** The global contrast value of the rendered scene (default value is 1). Effective only if [member adjustment_enabled] is `true`. */ get adjustment_contrast(): float64 set adjustment_contrast(value: float64) /** The global color saturation value of the rendered scene (default value is 1). Effective only if [member adjustment_enabled] is `true`. */ get adjustment_saturation(): float64 set adjustment_saturation(value: float64) /** The [Texture2D] or [Texture3D] lookup table (LUT) to use for the built-in post-process color grading. Can use a [GradientTexture1D] for a 1-dimensional LUT, or a [Texture3D] for a more complex LUT. Effective only if [member adjustment_enabled] is `true`. */ get adjustment_color_correction(): Texture2D | Texture3D set adjustment_color_correction(value: Texture2D | Texture3D) } class EventListenerLineEdit = Record> extends LineEdit { constructor(identifier?: any) readonly event_changed: Signal1 } class ExportTemplateManager = Record> extends AcceptDialog { constructor(identifier?: any) } /** A class that stores an expression you can execute. * * @link https://docs.godotengine.org/en/4.4/classes/class_expression.html */ class Expression extends RefCounted { constructor(identifier?: any) /** Parses the expression and returns an [enum Error] code. * You can optionally specify names of variables that may appear in the expression with [param input_names], so that you can bind them when it gets executed. */ parse(expression: string, input_names: PackedStringArray | string[] = []): GError /** Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed]. * If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order. */ execute(inputs: GArray = [], base_instance: Object = undefined, show_error: boolean = true, const_calls_only: boolean = false): any /** Returns `true` if [method execute] has failed. */ has_execute_failed(): boolean /** Returns the error text if [method parse] or [method execute] has failed. */ get_error_text(): string } /** Texture which displays the content of an external buffer. * * @link https://docs.godotengine.org/en/4.4/classes/class_externaltexture.html */ class ExternalTexture extends Texture2D { constructor(identifier?: any) /** Returns the external texture ID. * Depending on your use case, you may need to pass this to platform APIs, for example, when creating an `android.graphics.SurfaceTexture` on Android. */ get_external_texture_id(): int64 /** Sets the external buffer ID. * Depending on your use case, you may need to call this with data received from a platform API, for example, `SurfaceTexture.getHardwareBuffer()` on Android. */ set_external_buffer_id(external_buffer_id: int64): void /** External texture size. */ get size(): Vector2 set size(value: Vector2) } /** Handles FBX documents. * * @link https://docs.godotengine.org/en/4.4/classes/class_fbxdocument.html */ class FBXDocument extends GLTFDocument { constructor(identifier?: any) } class FBXImporterManager = Record> extends ConfirmationDialog { constructor(identifier?: any) } /** @link https://docs.godotengine.org/en/4.4/classes/class_fbxstate.html */ class FBXState extends GLTFState { constructor(identifier?: any) /** If `true`, the import process used auxiliary nodes called geometry helper nodes. These nodes help preserve the pivots and transformations of the original 3D model during import. */ get allow_geometry_helper_nodes(): boolean set allow_geometry_helper_nodes(value: boolean) } namespace FastNoiseLite { enum NoiseType { /** A lattice of points are assigned random values then interpolated based on neighboring values. */ TYPE_VALUE = 5, /** Similar to Value noise, but slower. Has more variance in peaks and valleys. * Cubic noise can be used to avoid certain artifacts when using value noise to create a bumpmap. In general, you should always use this mode if the value noise is being used for a heightmap or bumpmap. */ TYPE_VALUE_CUBIC = 4, /** A lattice of random gradients. Their dot products are interpolated to obtain values in between the lattices. */ TYPE_PERLIN = 3, /** Cellular includes both Worley noise and Voronoi diagrams which creates various regions of the same value. */ TYPE_CELLULAR = 2, /** As opposed to [constant TYPE_PERLIN], gradients exist in a simplex lattice rather than a grid lattice, avoiding directional artifacts. Internally uses FastNoiseLite's OpenSimplex2 noise type. */ TYPE_SIMPLEX = 0, /** Modified, higher quality version of [constant TYPE_SIMPLEX], but slower. Internally uses FastNoiseLite's OpenSimplex2S noise type. */ TYPE_SIMPLEX_SMOOTH = 1, } enum FractalType { /** No fractal noise. */ FRACTAL_NONE = 0, /** Method using Fractional Brownian Motion to combine octaves into a fractal. */ FRACTAL_FBM = 1, /** Method of combining octaves into a fractal resulting in a "ridged" look. */ FRACTAL_RIDGED = 2, /** Method of combining octaves into a fractal with a ping pong effect. */ FRACTAL_PING_PONG = 3, } enum CellularDistanceFunction { /** Euclidean distance to the nearest point. */ DISTANCE_EUCLIDEAN = 0, /** Squared Euclidean distance to the nearest point. */ DISTANCE_EUCLIDEAN_SQUARED = 1, /** Manhattan distance (taxicab metric) to the nearest point. */ DISTANCE_MANHATTAN = 2, /** Blend of [constant DISTANCE_EUCLIDEAN] and [constant DISTANCE_MANHATTAN] to give curved cell boundaries. */ DISTANCE_HYBRID = 3, } enum CellularReturnType { /** The cellular distance function will return the same value for all points within a cell. */ RETURN_CELL_VALUE = 0, /** The cellular distance function will return a value determined by the distance to the nearest point. */ RETURN_DISTANCE = 1, /** The cellular distance function returns the distance to the second-nearest point. */ RETURN_DISTANCE2 = 2, /** The distance to the nearest point is added to the distance to the second-nearest point. */ RETURN_DISTANCE2_ADD = 3, /** The distance to the nearest point is subtracted from the distance to the second-nearest point. */ RETURN_DISTANCE2_SUB = 4, /** The distance to the nearest point is multiplied with the distance to the second-nearest point. */ RETURN_DISTANCE2_MUL = 5, /** The distance to the nearest point is divided by the distance to the second-nearest point. */ RETURN_DISTANCE2_DIV = 6, } enum DomainWarpType { /** The domain is warped using the simplex noise algorithm. */ DOMAIN_WARP_SIMPLEX = 0, /** The domain is warped using a simplified version of the simplex noise algorithm. */ DOMAIN_WARP_SIMPLEX_REDUCED = 1, /** The domain is warped using a simple noise grid (not as smooth as the other methods, but more performant). */ DOMAIN_WARP_BASIC_GRID = 2, } enum DomainWarpFractalType { /** No fractal noise for warping the space. */ DOMAIN_WARP_FRACTAL_NONE = 0, /** Warping the space progressively, octave for octave, resulting in a more "liquified" distortion. */ DOMAIN_WARP_FRACTAL_PROGRESSIVE = 1, /** Warping the space independently for each octave, resulting in a more chaotic distortion. */ DOMAIN_WARP_FRACTAL_INDEPENDENT = 2, } } /** Generates noise using the FastNoiseLite library. * * @link https://docs.godotengine.org/en/4.4/classes/class_fastnoiselite.html */ class FastNoiseLite extends Noise { constructor(identifier?: any) _changed(): void /** The noise algorithm used. See [enum NoiseType]. */ get noise_type(): int64 set noise_type(value: int64) /** The random number seed for all noise types. */ get seed(): int64 set seed(value: int64) /** The frequency for all noise types. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. */ get frequency(): float64 set frequency(value: float64) /** Translate the noise input coordinates by the given [Vector3]. */ get offset(): Vector3 set offset(value: Vector3) /** The method for combining octaves into a fractal. See [enum FractalType]. */ get fractal_type(): int64 set fractal_type(value: int64) /** The number of noise layers that are sampled to get the final value for fractal noise types. */ get fractal_octaves(): int64 set fractal_octaves(value: int64) /** Frequency multiplier between subsequent octaves. Increasing this value results in higher octaves producing noise with finer details and a rougher appearance. */ get fractal_lacunarity(): float64 set fractal_lacunarity(value: float64) /** Determines the strength of each subsequent layer of noise in fractal noise. * A low value places more emphasis on the lower frequency base layers, while a high value puts more emphasis on the higher frequency layers. */ get fractal_gain(): float64 set fractal_gain(value: float64) /** Higher weighting means higher octaves have less impact if lower octaves have a large impact. */ get fractal_weighted_strength(): float64 set fractal_weighted_strength(value: float64) /** Sets the strength of the fractal ping pong type. */ get fractal_ping_pong_strength(): float64 set fractal_ping_pong_strength(value: float64) /** Determines how the distance to the nearest/second-nearest point is computed. See [enum CellularDistanceFunction] for options. */ get cellular_distance_function(): int64 set cellular_distance_function(value: int64) /** Maximum distance a point can move off of its grid position. Set to `0` for an even grid. */ get cellular_jitter(): float64 set cellular_jitter(value: float64) /** Return type from cellular noise calculations. See [enum CellularReturnType]. */ get cellular_return_type(): int64 set cellular_return_type(value: int64) /** If enabled, another FastNoiseLite instance is used to warp the space, resulting in a distortion of the noise. */ get domain_warp_enabled(): boolean set domain_warp_enabled(value: boolean) /** Sets the warp algorithm. See [enum DomainWarpType]. */ get domain_warp_type(): int64 set domain_warp_type(value: int64) /** Sets the maximum warp distance from the origin. */ get domain_warp_amplitude(): float64 set domain_warp_amplitude(value: float64) /** Frequency of the noise which warps the space. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. */ get domain_warp_frequency(): float64 set domain_warp_frequency(value: float64) /** The method for combining octaves into a fractal which is used to warp the space. See [enum DomainWarpFractalType]. */ get domain_warp_fractal_type(): int64 set domain_warp_fractal_type(value: int64) /** The number of noise layers that are sampled to get the final value for the fractal noise which warps the space. */ get domain_warp_fractal_octaves(): int64 set domain_warp_fractal_octaves(value: int64) /** Octave lacunarity of the fractal noise which warps the space. Increasing this value results in higher octaves producing noise with finer details and a rougher appearance. */ get domain_warp_fractal_lacunarity(): float64 set domain_warp_fractal_lacunarity(value: float64) /** Determines the strength of each subsequent layer of the noise which is used to warp the space. * A low value places more emphasis on the lower frequency base layers, while a high value puts more emphasis on the higher frequency layers. */ get domain_warp_fractal_gain(): float64 set domain_warp_fractal_gain(value: float64) } namespace FileAccess { enum ModeFlags { /** Opens the file for read operations. The cursor is positioned at the beginning of the file. */ READ = 1, /** Opens the file for write operations. The file is created if it does not exist, and truncated if it does. * * **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see [method DirAccess.make_dir_recursive]. */ WRITE = 2, /** Opens the file for read and write operations. Does not truncate the file. The cursor is positioned at the beginning of the file. */ READ_WRITE = 3, /** Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file. * * **Note:** When creating a file it must be in an already existing directory. To recursively create directories for a file path, see [method DirAccess.make_dir_recursive]. */ WRITE_READ = 7, } enum CompressionMode { /** Uses the [url=https://fastlz.org/]FastLZ[/url] compression method. */ COMPRESSION_FASTLZ = 0, /** Uses the [url=https://en.wikipedia.org/wiki/DEFLATE]DEFLATE[/url] compression method. */ COMPRESSION_DEFLATE = 1, /** Uses the [url=https://facebook.github.io/zstd/]Zstandard[/url] compression method. */ COMPRESSION_ZSTD = 2, /** Uses the [url=https://www.gzip.org/]gzip[/url] compression method. */ COMPRESSION_GZIP = 3, /** Uses the [url=https://github.com/google/brotli]brotli[/url] compression method (only decompression is supported). */ COMPRESSION_BROTLI = 4, } enum UnixPermissionFlags { /** Read for owner bit. */ UNIX_READ_OWNER = 256, /** Write for owner bit. */ UNIX_WRITE_OWNER = 128, /** Execute for owner bit. */ UNIX_EXECUTE_OWNER = 64, /** Read for group bit. */ UNIX_READ_GROUP = 32, /** Write for group bit. */ UNIX_WRITE_GROUP = 16, /** Execute for group bit. */ UNIX_EXECUTE_GROUP = 8, /** Read for other bit. */ UNIX_READ_OTHER = 4, /** Write for other bit. */ UNIX_WRITE_OTHER = 2, /** Execute for other bit. */ UNIX_EXECUTE_OTHER = 1, /** Set user id on execution bit. */ UNIX_SET_USER_ID = 2048, /** Set group id on execution bit. */ UNIX_SET_GROUP_ID = 1024, /** Restricted deletion (sticky) bit. */ UNIX_RESTRICTED_DELETE = 512, } } /** Provides methods for file reading and writing operations. * * @link https://docs.godotengine.org/en/4.4/classes/class_fileaccess.html */ class FileAccess extends RefCounted { constructor(identifier?: any) /** Creates a new [FileAccess] object and opens the file for writing or reading, depending on the flags. * Returns `null` if opening the file failed. You can use [method get_open_error] to check the error that occurred. */ static open(path: string, flags: FileAccess.ModeFlags): FileAccess /** Creates a new [FileAccess] object and opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. * * **Note:** The provided key must be 32 bytes long. * Returns `null` if opening the file failed. You can use [method get_open_error] to check the error that occurred. */ static open_encrypted(path: string, mode_flags: FileAccess.ModeFlags, key: PackedByteArray | byte[] | ArrayBuffer, iv: PackedByteArray | byte[] | ArrayBuffer = []): FileAccess /** Creates a new [FileAccess] object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. * Returns `null` if opening the file failed. You can use [method get_open_error] to check the error that occurred. */ static open_encrypted_with_pass(path: string, mode_flags: FileAccess.ModeFlags, pass: string): FileAccess /** Creates a new [FileAccess] object and opens a compressed file for reading or writing. * * **Note:** [method open_compressed] can only read files that were saved by Godot, not third-party compression formats. See [url=https://github.com/godotengine/godot/issues/28999]GitHub issue #28999[/url] for a workaround. * Returns `null` if opening the file failed. You can use [method get_open_error] to check the error that occurred. */ static open_compressed(path: string, mode_flags: FileAccess.ModeFlags, compression_mode: FileAccess.CompressionMode = 0): FileAccess /** Returns the result of the last [method open] call in the current thread. */ static get_open_error(): GError /** Creates a temporary file. This file will be freed when the returned [FileAccess] is freed. * If [param prefix] is not empty, it will be prefixed to the file name, separated by a `-`. * If [param extension] is not empty, it will be appended to the temporary file name. * If [param keep] is `true`, the file is not deleted when the returned [FileAccess] is freed. * Returns `null` if opening the file failed. You can use [method get_open_error] to check the error that occurred. */ static create_temp(mode_flags: int64, prefix: string = '', extension: string = '', keep: boolean = false): FileAccess /** Returns the whole [param path] file contents as a [PackedByteArray] without any decoding. * Returns an empty [PackedByteArray] if an error occurred while opening the file. You can use [method get_open_error] to check the error that occurred. */ static get_file_as_bytes(path: string): PackedByteArray /** Returns the whole [param path] file contents as a [String]. Text is interpreted as being UTF-8 encoded. * Returns an empty [String] if an error occurred while opening the file. You can use [method get_open_error] to check the error that occurred. */ static get_file_as_string(path: string): string /** Resizes the file to a specified length. The file must be open in a mode that permits writing. If the file is extended, NUL characters are appended. If the file is truncated, all data from the end file to the original length of the file is lost. */ resize(length: int64): GError /** Writes the file's buffer to disk. Flushing is automatically performed when the file is closed. This means you don't need to call [method flush] manually before closing a file. Still, calling [method flush] can be used to ensure the data is safe even if the project crashes instead of being closed gracefully. * * **Note:** Only call [method flush] when you actually need it. Otherwise, it will decrease performance due to constant disk writes. */ flush(): void /** Returns the path as a [String] for the current open file. */ get_path(): string /** Returns the absolute path as a [String] for the current open file. */ get_path_absolute(): string /** Returns `true` if the file is currently opened. */ is_open(): boolean /** Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). */ seek(position: int64): void /** Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). * * **Note:** This is an offset, so you should use negative numbers or the cursor will be at the end of the file. */ seek_end(position: int64 = 0): void /** Returns the file cursor's position. */ get_position(): int64 /** Returns the size of the file in bytes. For a pipe, returns the number of bytes available for reading from the pipe. */ get_length(): int64 /** Returns `true` if the file cursor has already read past the end of the file. * * **Note:** `eof_reached() == false` cannot be used to check whether there is more data available. To loop while there is more data available, use: * */ eof_reached(): boolean /** Returns the next 8 bits from the file as an integer. See [method store_8] for details on what values can be stored and retrieved this way. */ get_8(): int64 /** Returns the next 16 bits from the file as an integer. See [method store_16] for details on what values can be stored and retrieved this way. */ get_16(): int64 /** Returns the next 32 bits from the file as an integer. See [method store_32] for details on what values can be stored and retrieved this way. */ get_32(): int64 /** Returns the next 64 bits from the file as an integer. See [method store_64] for details on what values can be stored and retrieved this way. */ get_64(): int64 /** Returns the next 16 bits from the file as a half-precision floating-point number. */ get_half(): float64 /** Returns the next 32 bits from the file as a floating-point number. */ get_float(): float64 /** Returns the next 64 bits from the file as a floating-point number. */ get_double(): float64 /** Returns the next bits from the file as a floating-point number. */ get_real(): float64 /** Returns next [param length] bytes of the file as a [PackedByteArray]. */ get_buffer(length: int64): PackedByteArray /** Returns the next line of the file as a [String]. The returned string doesn't include newline (`\n`) or carriage return (`\r`) characters, but does include any other leading or trailing whitespace. * Text is interpreted as being UTF-8 encoded. */ get_line(): string /** Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default `","` (comma). This delimiter must be one-character long, and cannot be a double quotation mark. * Text is interpreted as being UTF-8 encoded. Text values must be enclosed in double quotes if they include the delimiter character. Double quotes within a text value can be escaped by doubling their occurrence. * For example, the following CSV lines are valid and will be properly parsed as two strings each: * [codeblock lang=text] * Alice,"Hello, Bob!" * Bob,Alice! What a surprise! * Alice,"I thought you'd reply with ""Hello, world""." * [/codeblock] * Note how the second line can omit the enclosing quotes as it does not include the delimiter. However it *could* very well use quotes, it was only written without for demonstration purposes. The third line must use `""` for each quotation mark that needs to be interpreted as such instead of the end of a text value. */ get_csv_line(delim: string = ','): PackedStringArray /** Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded. * If [param skip_cr] is `true`, carriage return characters (`\r`, CR) will be ignored when parsing the UTF-8, so that only line feed characters (`\n`, LF) represent a new line (Unix convention). */ get_as_text(skip_cr: boolean = false): string /** Returns an MD5 String representing the file at the given path or an empty [String] on failure. */ static get_md5(path: string): string /** Returns an SHA-256 [String] representing the file at the given path or an empty [String] on failure. */ static get_sha256(path: string): string /** Returns the last error that happened when trying to perform operations. Compare with the `ERR_FILE_*` constants from [enum Error]. */ get_error(): GError /** Returns the next [Variant] value from the file. If [param allow_objects] is `true`, decoding objects is allowed. * Internally, this uses the same decoding mechanism as the [method @GlobalScope.bytes_to_var] method. * **Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. */ get_var(allow_objects: boolean = false): any /** Stores an integer as 8 bits in the file. * * **Note:** The [param value] should lie in the interval `[0, 255]`. Any other value will overflow and wrap around. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. * To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example). */ store_8(value: int64): boolean /** Stores an integer as 16 bits in the file. * * **Note:** The [param value] should lie in the interval `[0, 2^16 - 1]`. Any other value will overflow and wrap around. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. * To store a signed integer, use [method store_64] or store a signed integer from the interval `[-2^15, 2^15 - 1]` (i.e. keeping one bit for the signedness) and compute its sign manually when reading. For example: * */ store_16(value: int64): boolean /** Stores an integer as 32 bits in the file. * * **Note:** The [param value] should lie in the interval `[0, 2^32 - 1]`. Any other value will overflow and wrap around. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. * To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example). */ store_32(value: int64): boolean /** Stores an integer as 64 bits in the file. * * **Note:** The [param value] must lie in the interval `[-2^63, 2^63 - 1]` (i.e. be a valid [int] value). * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_64(value: int64): boolean /** Stores a half-precision floating-point number as 16 bits in the file. */ store_half(value: float64): boolean /** Stores a floating-point number as 32 bits in the file. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_float(value: float64): boolean /** Stores a floating-point number as 64 bits in the file. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_double(value: float64): boolean /** Stores a floating-point number in the file. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_real(value: float64): boolean /** Stores the given array of bytes in the file. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): boolean /** Stores [param line] in the file followed by a newline character (`\n`), encoding the text as UTF-8. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_line(line: string): boolean /** Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [param delim] to use other than the default `","` (comma). This delimiter must be one-character long. * Text will be encoded as UTF-8. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_csv_line(values: PackedStringArray | string[], delim: string = ','): boolean /** Stores [param string] in the file without a newline character (`\n`), encoding the text as UTF-8. * * **Note:** This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using [method store_pascal_string] instead. For retrieving strings from a text file, you can use `get_buffer(length).get_string_from_utf8()` (if you know the length) or [method get_as_text]. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_string(string_: string): boolean /** Stores any Variant value in the file. If [param full_objects] is `true`, encoding objects is allowed (and can potentially include code). * Internally, this uses the same encoding mechanism as the [method @GlobalScope.var_to_bytes] method. * * **Note:** Not all properties are included. Only properties that are configured with the [constant PROPERTY_USAGE_STORAGE] flag set will be serialized. You can add a new usage flag to a property by overriding the [method Object._get_property_list] method in your class. You can also check how property usage is configured by calling [method Object._get_property_list]. See [enum PropertyUsageFlags] for the possible usage flags. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_var(value: any, full_objects: boolean = false): boolean /** Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). * Text will be encoded as UTF-8. * * **Note:** If an error occurs, the resulting value of the file position indicator is indeterminate. */ store_pascal_string(string_: string): boolean /** Returns a [String] saved in Pascal format from the file. * Text is interpreted as being UTF-8 encoded. */ get_pascal_string(): string /** Closes the currently opened file and prevents subsequent read/write operations. Use [method flush] to persist the data to disk without closing the file. * * **Note:** [FileAccess] will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with `null`. In C# the reference must be disposed after we are done using it, this can be done with the `using` statement or calling the `Dispose` method directly. */ close(): void /** Returns `true` if the file exists in the given path. * * **Note:** Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account. * For a non-static, relative equivalent, use [method DirAccess.file_exists]. */ static file_exists(path: string): boolean /** Returns the last time the [param file] was modified in Unix timestamp format, or `0` on error. This Unix timestamp can be converted to another format using the [Time] singleton. */ static get_modified_time(file: string): int64 /** Returns file UNIX permissions. * * **Note:** This method is implemented on iOS, Linux/BSD, and macOS. */ static get_unix_permissions(file: string): FileAccess.UnixPermissionFlags /** Sets file UNIX permissions. * * **Note:** This method is implemented on iOS, Linux/BSD, and macOS. */ static set_unix_permissions(file: string, permissions: FileAccess.UnixPermissionFlags): GError /** Returns `true`, if file `hidden` attribute is set. * * **Note:** This method is implemented on iOS, BSD, macOS, and Windows. */ static get_hidden_attribute(file: string): boolean /** Sets file **hidden** attribute. * * **Note:** This method is implemented on iOS, BSD, macOS, and Windows. */ static set_hidden_attribute(file: string, hidden: boolean): GError /** Sets file **read only** attribute. * * **Note:** This method is implemented on iOS, BSD, macOS, and Windows. */ static set_read_only_attribute(file: string, ro: boolean): GError /** Returns `true`, if file `read only` attribute is set. * * **Note:** This method is implemented on iOS, BSD, macOS, and Windows. */ static get_read_only_attribute(file: string): boolean /** If `true`, the file is read with big-endian [url=https://en.wikipedia.org/wiki/Endianness]endianness[/url]. If `false`, the file is read with little-endian endianness. If in doubt, leave this to `false` as most files are written with little-endian endianness. * * **Note:** [member big_endian] is only about the file format, not the CPU type. The CPU endianness doesn't affect the default endianness for files written. * * **Note:** This is always reset to `false` whenever you open the file. Therefore, you must set [member big_endian] *after* opening the file, not before. */ get big_endian(): boolean set big_endian(value: boolean) } namespace FileDialog { enum FileMode { /** The dialog allows selecting one, and only one file. */ FILE_MODE_OPEN_FILE = 0, /** The dialog allows selecting multiple files. */ FILE_MODE_OPEN_FILES = 1, /** The dialog only allows selecting a directory, disallowing the selection of any file. */ FILE_MODE_OPEN_DIR = 2, /** The dialog allows selecting one file or directory. */ FILE_MODE_OPEN_ANY = 3, /** The dialog will warn when a file exists. */ FILE_MODE_SAVE_FILE = 4, } enum Access { /** The dialog only allows accessing files under the [Resource] path (`res://`). */ ACCESS_RESOURCES = 0, /** The dialog only allows accessing files under user data path (`user://`). */ ACCESS_USERDATA = 1, /** The dialog allows accessing files on the whole file system. */ ACCESS_FILESYSTEM = 2, } } /** A dialog for selecting files or directories in the filesystem. * * @link https://docs.godotengine.org/en/4.4/classes/class_filedialog.html */ class FileDialog = Record> extends ConfirmationDialog { constructor(identifier?: any) _cancel_pressed(): void /** Clear all the added filters in the dialog. */ clear_filters(): void /** Adds a comma-delimited file name [param filter] option to the [FileDialog] with an optional [param description], which restricts what files can be picked. * A [param filter] should be of the form `"filename.extension"`, where filename and extension can be `*` to match any string. Filters starting with `.` (i.e. empty filenames) are not allowed. * For example, a [param filter] of `"*.png, *.jpg"` and a [param description] of `"Images"` results in filter text "Images (*.png, *.jpg)". */ add_filter(filter: string, description: string = ''): void /** Clear the filter for file names. */ clear_filename_filter(): void /** Returns the name of the [OptionButton] or [CheckBox] with index [param option]. */ get_option_name(option: int64): string /** Returns an array of values of the [OptionButton] with index [param option]. */ get_option_values(option: int64): PackedStringArray /** Returns the default value index of the [OptionButton] or [CheckBox] with index [param option]. */ get_option_default(option: int64): int64 /** Sets the name of the [OptionButton] or [CheckBox] with index [param option]. */ set_option_name(option: int64, name: string): void /** Sets the option values of the [OptionButton] with index [param option]. */ set_option_values(option: int64, values: PackedStringArray | string[]): void /** Sets the default value index of the [OptionButton] or [CheckBox] with index [param option]. */ set_option_default(option: int64, default_value_index: int64): void /** Adds an additional [OptionButton] to the file dialog. If [param values] is empty, a [CheckBox] is added instead. * [param default_value_index] should be an index of the value in the [param values]. If [param values] is empty it should be either `1` (checked), or `0` (unchecked). */ add_option(name: string, values: PackedStringArray | string[], default_value_index: int64): void /** Returns a [Dictionary] with the selected values of the additional [OptionButton]s and/or [CheckBox]es. [Dictionary] keys are names and values are selected value indices. */ get_selected_options(): GDictionary /** Returns the vertical box container of the dialog, custom controls can be added to it. * **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. * * **Note:** Changes to this node are ignored by native file dialogs, use [method add_option] to add custom elements to the dialog instead. */ get_vbox(): VBoxContainer /** Returns the LineEdit for the selected file. * **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. */ get_line_edit(): LineEdit /** Clear all currently selected items in the dialog. */ deselect_all(): void /** Invalidate and update the current dialog content list. * * **Note:** This method does nothing on native file dialogs. */ invalidate(): void /** If `true`, changing the [member file_mode] property will set the window title accordingly (e.g. setting [member file_mode] to [constant FILE_MODE_OPEN_FILE] will change the window title to "Open a File"). */ get mode_overrides_title(): boolean set mode_overrides_title(value: boolean) /** The dialog's open or save mode, which affects the selection behavior. See [enum FileMode]. */ get file_mode(): int64 set file_mode(value: int64) /** The file system access scope. See [enum Access] constants. * **Warning:** In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, [member use_native_dialog] is automatically used to allow limited access to host file system. */ get access(): int64 set access(value: int64) /** If non-empty, the given sub-folder will be "root" of this [FileDialog], i.e. user won't be able to go to its parent directory. * * **Note:** This property is ignored by native file dialogs. */ get root_subfolder(): string set root_subfolder(value: string) /** The available file type filters. Each filter string in the array should be formatted like this: `*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg`. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. * * **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. */ get filters(): PackedStringArray set filters(value: PackedStringArray | string[]) /** The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. [member filename_filter] can be edited by the user with the filter button at the top of the file dialog. * See also [member filters], which should be used to restrict the file types that can be selected instead of [member filename_filter] which is meant to be set by the user. */ get filename_filter(): string set filename_filter(value: string) /** The number of additional [OptionButton]s and [CheckBox]es in the dialog. */ get option_count(): any /*Options,option_*/ set option_count(value: any /*Options,option_*/) /** If `true`, the dialog will show hidden files. * * **Note:** This property is ignored by native file dialogs on Android and Linux. */ get show_hidden_files(): boolean set show_hidden_files(value: boolean) /** If `true`, and if supported by the current [DisplayServer], OS native dialog will be used instead of custom one. * * **Note:** On Android, it is only supported when using [constant ACCESS_FILESYSTEM]. For access mode [constant ACCESS_RESOURCES] and [constant ACCESS_USERDATA], the system will fall back to custom FileDialog. * * **Note:** On Linux and macOS, sandboxed apps always use native dialogs to access the host file system. * * **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use [method OS.get_granted_permissions] to get a list of saved bookmarks. * * **Note:** Native dialogs are isolated from the base process, file dialog properties can't be modified once the dialog is shown. */ get use_native_dialog(): boolean set use_native_dialog(value: boolean) /** The current working directory of the file dialog. * * **Note:** For native file dialogs, this property is only treated as a hint and may not be respected by specific OS implementations. */ get current_dir(): string set current_dir(value: string) /** The currently selected file of the file dialog. */ get current_file(): string set current_file(value: string) /** The currently selected file path of the file dialog. */ get current_path(): string set current_path(value: string) /** Emitted when the user selects a file by double-clicking it or pressing the **OK** button. */ readonly file_selected: Signal1 /** Emitted when the user selects multiple files. */ readonly files_selected: Signal1 /** Emitted when the user selects a directory. */ readonly dir_selected: Signal1 /** Emitted when the filter for file names changes. */ readonly filename_filter_changed: Signal1 } /** Godot editor's dock for managing files in the project. * * @link https://docs.godotengine.org/en/4.4/classes/class_filesystemdock.html */ class FileSystemDock = Record> extends VBoxContainer { constructor(identifier?: any) _file_list_thumbnail_done(_unnamed_arg0: string, _unnamed_arg1: Texture2D, _unnamed_arg2: Texture2D, _unnamed_arg3: any): void _tree_thumbnail_done(_unnamed_arg0: string, _unnamed_arg1: Texture2D, _unnamed_arg2: Texture2D, _unnamed_arg3: any): void /** Sets the given [param path] as currently selected, ensuring that the selected file/directory is visible. */ navigate_to_path(path: string): void /** Registers a new [EditorResourceTooltipPlugin]. */ add_resource_tooltip_plugin(plugin: EditorResourceTooltipPlugin): void /** Removes an [EditorResourceTooltipPlugin]. Fails if the plugin wasn't previously added. */ remove_resource_tooltip_plugin(plugin: EditorResourceTooltipPlugin): void _set_dock_horizontal(enable: boolean): void _can_dock_horizontal(): boolean _save_layout_to_config(_unnamed_arg0: ConfigFile, _unnamed_arg1: string): void _load_layout_from_config(_unnamed_arg0: ConfigFile, _unnamed_arg1: string): void /** Emitted when a new scene is created that inherits the scene at [param file] path. */ readonly inherit: Signal1 /** Emitted when the given scenes are being instantiated in the editor. */ readonly instantiate: Signal1 /** Emitted when an external [param resource] had its file removed. */ readonly resource_removed: Signal1 /** Emitted when the given [param file] was removed. */ readonly file_removed: Signal1 /** Emitted when the given [param folder] was removed. */ readonly folder_removed: Signal1 /** Emitted when a file is moved from [param old_file] path to [param new_file] path. */ readonly files_moved: Signal2 /** Emitted when a folder is moved from [param old_folder] path to [param new_folder] path. */ readonly folder_moved: Signal2 /** Emitted when folders change color. */ readonly folder_color_changed: Signal0 /** Emitted when the user switches file display mode or split mode. */ readonly display_mode_changed: Signal0 } class FileSystemList = Record> extends ItemList { constructor(identifier?: any) readonly item_edited: Signal0 } class FindInFiles = Record> extends Node { constructor(identifier?: any) readonly result_found: Signal5 readonly finished: Signal0 } class FindInFilesDialog = Record> extends AcceptDialog { constructor(identifier?: any) readonly find_requested: Signal0 readonly replace_requested: Signal0 } class FindInFilesPanel = Record> extends Control { constructor(identifier?: any) _on_result_found(_unnamed_arg0: string, _unnamed_arg1: int64, _unnamed_arg2: int64, _unnamed_arg3: int64, _unnamed_arg4: string): void _on_finished(): void readonly result_selected: Signal4 readonly files_modified: Signal1 readonly close_button_clicked: Signal0 } class FindReplaceBar = Record> extends HBoxContainer { constructor(identifier?: any) _search_current(): boolean readonly error: Signal0 } namespace FlowContainer { enum AlignmentMode { /** The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout). */ ALIGNMENT_BEGIN = 0, /** The child controls will be centered in the container. */ ALIGNMENT_CENTER = 1, /** The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout). */ ALIGNMENT_END = 2, } enum LastWrapAlignmentMode { /** The last partially filled row or column will wrap aligned to the previous row or column in accordance with [member alignment]. */ LAST_WRAP_ALIGNMENT_INHERIT = 0, /** The last partially filled row or column will wrap aligned to the beginning of the previous row or column. */ LAST_WRAP_ALIGNMENT_BEGIN = 1, /** The last partially filled row or column will wrap aligned to the center of the previous row or column. */ LAST_WRAP_ALIGNMENT_CENTER = 2, /** The last partially filled row or column will wrap aligned to the end of the previous row or column. */ LAST_WRAP_ALIGNMENT_END = 3, } } /** A container that arranges its child controls horizontally or vertically and wraps them around at the borders. * * @link https://docs.godotengine.org/en/4.4/classes/class_flowcontainer.html */ class FlowContainer = Record> extends Container { constructor(identifier?: any) /** Returns the current line count. */ get_line_count(): int64 /** The alignment of the container's children (must be one of [constant ALIGNMENT_BEGIN], [constant ALIGNMENT_CENTER], or [constant ALIGNMENT_END]). */ get alignment(): int64 set alignment(value: int64) /** The wrap behavior of the last, partially filled row or column (must be one of [constant LAST_WRAP_ALIGNMENT_INHERIT], [constant LAST_WRAP_ALIGNMENT_BEGIN], [constant LAST_WRAP_ALIGNMENT_CENTER], or [constant LAST_WRAP_ALIGNMENT_END]). */ get last_wrap_alignment(): int64 set last_wrap_alignment(value: int64) /** If `true`, the [FlowContainer] will arrange its children vertically, rather than horizontally. * Can't be changed when using [HFlowContainer] and [VFlowContainer]. */ get vertical(): boolean set vertical(value: boolean) /** If `true`, reverses fill direction. Horizontal [FlowContainer]s will fill rows bottom to top, vertical [FlowContainer]s will fill columns right to left. * When using a vertical [FlowContainer] with a right to left [member Control.layout_direction], columns will fill left to right instead. */ get reverse_fill(): boolean set reverse_fill(value: boolean) } /** A material that controls how volumetric fog is rendered, to be assigned to a [FogVolume]. * * @link https://docs.godotengine.org/en/4.4/classes/class_fogmaterial.html */ class FogMaterial extends Material { constructor(identifier?: any) /** The density of the [FogVolume]. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes. Negative values can be used to subtract fog from other [FogVolume]s or global volumetric fog. * * **Note:** Due to limited precision, [member density] values between `-0.001` and `0.001` (exclusive) act like `0.0`. This does not apply to [member Environment.volumetric_fog_density]. */ get density(): float64 set density(value: float64) /** The single-scattering [Color] of the [FogVolume]. Internally, [member albedo] is converted into single-scattering, which is additively blended with other [FogVolume]s and the [member Environment.volumetric_fog_albedo]. */ get albedo(): Color set albedo(value: Color) /** The [Color] of the light emitted by the [FogVolume]. Emitted light will not cast light or shadows on other objects, but can be useful for modulating the [Color] of the [FogVolume] independently from light sources. */ get emission(): Color set emission(value: Color) /** The rate by which the height-based fog decreases in density as height increases in world space. A high falloff will result in a sharp transition, while a low falloff will result in a smoother transition. A value of `0.0` results in uniform-density fog. The height threshold is determined by the height of the associated [FogVolume]. */ get height_falloff(): float64 set height_falloff(value: float64) /** The hardness of the edges of the [FogVolume]. A higher value will result in softer edges, while a lower value will result in harder edges. */ get edge_fade(): float64 set edge_fade(value: float64) /** The 3D texture that is used to scale the [member density] of the [FogVolume]. This can be used to vary fog density within the [FogVolume] with any kind of static pattern. For animated effects, consider using a custom [url=https://docs.godotengine.org/en/4.4/tutorials/shaders/shader_reference/fog_shader.html]fog shader[/url]. */ get density_texture(): Texture3D set density_texture(value: Texture3D) } class FogMaterialConversionPlugin extends EditorResourceConversionPlugin { constructor(identifier?: any) } /** A region that contributes to the default volumetric fog from the world environment. * * @link https://docs.godotengine.org/en/4.4/classes/class_fogvolume.html */ class FogVolume = Record> extends VisualInstance3D { constructor(identifier?: any) /** The size of the [FogVolume] when [member shape] is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX]. * * **Note:** Thin fog volumes may appear to flicker when the camera moves or rotates. This can be alleviated by increasing [member ProjectSettings.rendering/environment/volumetric_fog/volume_depth] (at a performance cost) or by decreasing [member Environment.volumetric_fog_length] (at no performance cost, but at the cost of lower fog range). Alternatively, the [FogVolume] can be made thicker and use a lower density in the [member material]. * * **Note:** If [member shape] is [constant RenderingServer.FOG_VOLUME_SHAPE_CONE] or [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], the cone/cylinder will be adjusted to fit within the size. Non-uniform scaling of cone/cylinder shapes via the [member size] property is not supported, but you can scale the [FogVolume] node instead. */ get size(): Vector3 set size(value: Vector3) /** The shape of the [FogVolume]. This can be set to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_CONE], [constant RenderingServer.FOG_VOLUME_SHAPE_CYLINDER], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD]. */ get shape(): int64 set shape(value: int64) /** The [Material] used by the [FogVolume]. Can be either a built-in [FogMaterial] or a custom [ShaderMaterial]. */ get material(): FogMaterial | ShaderMaterial set material(value: FogMaterial | ShaderMaterial) } class FogVolumeGizmoPlugin extends EditorNode3DGizmoPlugin { constructor(identifier?: any) } /** Abstract base class for fonts and font variations. * * @link https://docs.godotengine.org/en/4.4/classes/class_font.html */ class Font extends Resource { constructor(identifier?: any) /** Returns [TextServer] RID of the font cache for specific variation. */ find_variation(variation_coordinates: GDictionary, face_index: int64 = 0, strength: float64 = 0, transform: Transform2D = new Transform2D(), spacing_top: int64 = 0, spacing_bottom: int64 = 0, spacing_space: int64 = 0, spacing_glyph: int64 = 0, baseline_offset: float64 = 0): RID /** Returns [Array] of valid [Font] [RID]s, which can be passed to the [TextServer] methods. */ get_rids(): GArray /** Returns the total average font height (ascent plus descent) in pixels. * * **Note:** Real height of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the height of empty line). */ get_height(font_size: int64 = 16): float64 /** Returns the average font ascent (number of pixels above the baseline). * * **Note:** Real ascent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the ascent of empty line). */ get_ascent(font_size: int64 = 16): float64 /** Returns the average font descent (number of pixels below the baseline). * * **Note:** Real descent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the descent of empty line). */ get_descent(font_size: int64 = 16): float64 /** Returns average pixel offset of the underline below the baseline. * * **Note:** Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. */ get_underline_position(font_size: int64 = 16): float64 /** Returns average thickness of the underline. * * **Note:** Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. */ get_underline_thickness(font_size: int64 = 16): float64 /** Returns font family name. */ get_font_name(): string /** Returns font style name. */ get_font_style_name(): string /** Returns [Dictionary] with OpenType font name strings (localized font names, version, description, license information, sample text, etc.). */ get_ot_name_strings(): GDictionary /** Returns font style flags, see [enum TextServer.FontStyle]. */ get_font_style(): TextServer.FontStyle /** Returns weight (boldness) of the font. A value in the `100...999` range, normal font weight is `400`, bold font weight is `700`. */ get_font_weight(): int64 /** Returns font stretch amount, compared to a normal width. A percentage value between `50%` and `200%`. */ get_font_stretch(): int64 /** Returns the spacing for the given `type` (see [enum TextServer.SpacingType]). */ get_spacing(spacing: TextServer.SpacingType): int64 /** Returns a set of OpenType feature tags. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url]. */ get_opentype_features(): GDictionary /** Sets LRU cache capacity for `draw_*` methods. */ set_cache_capacity(single_line: int64, multi_line: int64): void /** Returns the size of a bounding box of a single-line string, taking kerning, advance and subpixel positioning into account. See also [method get_multiline_string_size] and [method draw_string]. * For example, to get the string size as displayed by a single-line Label, use: * * * **Note:** Since kerning, advance and subpixel positioning are taken into account by [method get_string_size], using separate [method get_string_size] calls on substrings of a string then adding the results together will return a different result compared to using a single [method get_string_size] call on the full string. * * **Note:** Real height of the string is context-dependent and can be significantly different from the value returned by [method get_height]. */ get_string_size(text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): Vector2 /** Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. * See also [method draw_multiline_string]. */ get_multiline_string_size(text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, max_lines: int64 = -1, brk_flags: TextServer.LineBreakFlag = 3, justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): Vector2 /** Draw [param text] into a canvas item using the font, at a given position, with [param modulate] color, optionally clipping the width and aligning horizontally. [param pos] specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. * See also [method CanvasItem.draw_string]. */ draw_string(canvas_item: RID, pos: Vector2, text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, modulate: Color = new Color(1, 1, 1, 1), justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): void /** Breaks [param text] into lines using rules specified by [param brk_flags] and draws it into a canvas item using the font, at a given position, with [param modulate] color, optionally clipping the width and aligning horizontally. [param pos] specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. * See also [method CanvasItem.draw_multiline_string]. */ draw_multiline_string(canvas_item: RID, pos: Vector2, text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, max_lines: int64 = -1, modulate: Color = new Color(1, 1, 1, 1), brk_flags: TextServer.LineBreakFlag = 3, justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): void /** Draw [param text] outline into a canvas item using the font, at a given position, with [param modulate] color and [param size] outline size, optionally clipping the width and aligning horizontally. [param pos] specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. * See also [method CanvasItem.draw_string_outline]. */ draw_string_outline(canvas_item: RID, pos: Vector2, text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, size: int64 = 1, modulate: Color = new Color(1, 1, 1, 1), justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): void /** Breaks [param text] to the lines using rules specified by [param brk_flags] and draws text outline into a canvas item using the font, at a given position, with [param modulate] color and [param size] outline size, optionally clipping the width and aligning horizontally. [param pos] specifies the baseline of the first line, not the top. To draw from the top, *ascent* must be added to the Y axis. * See also [method CanvasItem.draw_multiline_string_outline]. */ draw_multiline_string_outline(canvas_item: RID, pos: Vector2, text: string, alignment: HorizontalAlignment = 0, width: float64 = -1, font_size: int64 = 16, max_lines: int64 = -1, size: int64 = 1, modulate: Color = new Color(1, 1, 1, 1), brk_flags: TextServer.LineBreakFlag = 3, justification_flags: TextServer.JustificationFlag = 3, direction: TextServer.Direction = 0, orientation: TextServer.Orientation = 0): void /** Returns the size of a character. Does not take kerning into account. * * **Note:** Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height. */ get_char_size(char: int64, font_size: int64): Vector2 /** Draw a single Unicode character [param char] into a canvas item using the font, at a given position, with [param modulate] color. [param pos] specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. * * **Note:** Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. */ draw_char(canvas_item: RID, pos: Vector2, char: int64, font_size: int64, modulate: Color = new Color(1, 1, 1, 1)): float64 /** Draw a single Unicode character [param char] outline into a canvas item using the font, at a given position, with [param modulate] color and [param size] outline size. [param pos] specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. * * **Note:** Do not use this function to draw strings character by character, use [method draw_string] or [TextLine] instead. */ draw_char_outline(canvas_item: RID, pos: Vector2, char: int64, font_size: int64, size: int64 = -1, modulate: Color = new Color(1, 1, 1, 1)): float64 /** Returns `true` if a Unicode [param char] is available in the font. */ has_char(char: int64): boolean /** Returns a string containing all the characters available in the font. * If a given character is included in more than one font data source, it appears only once in the returned string. */ get_supported_chars(): string /** Returns `true`, if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). */ is_language_supported(language: string): boolean /** Returns `true`, if font supports given script ([url=https://en.wikipedia.org/wiki/ISO_15924]ISO 15924[/url] code). */ is_script_supported(script: string): boolean /** Returns list of OpenType features supported by font. */ get_supported_feature_list(): GDictionary /** Returns list of supported [url=https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg]variation coordinates[/url], each coordinate is returned as `tag: Vector3i(min_value,max_value,default_value)`. * Font variations allow for continuous change of glyph characteristics along some given design axis, such as weight, width or slant. * To print available variation axes of a variable font: * * * **Note:** To set and get variation coordinates of a [FontVariation], use [member FontVariation.variation_opentype]. */ get_supported_variation_list(): GDictionary /** Returns number of faces in the TrueType / OpenType collection. */ get_face_count(): int64 /** Array of fallback [Font]s to use as a substitute if a glyph is not found in this current [Font]. * If this array is empty in a [FontVariation], the [member FontVariation.base_font]'s fallbacks are used instead. */ get fallbacks(): GArray set fallbacks(value: GArray) } class FontEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } /** Holds font source data and prerendered glyph cache, imported from a dynamic or a bitmap font. * * @link https://docs.godotengine.org/en/4.4/classes/class_fontfile.html */ class FontFile extends Font { constructor(identifier?: any) /** Loads an AngelCode BMFont (.fnt, .font) bitmap font from file [param path]. * **Warning:** This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the `user://` directory. */ load_bitmap_font(path: string): GError /** Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file [param path]. * **Warning:** This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the `user://` directory. */ load_dynamic_font(path: string): GError /** Returns number of the font cache entries. */ get_cache_count(): int64 /** Removes all font cache entries. */ clear_cache(): void /** Removes specified font cache entry. */ remove_cache(cache_index: int64): void /** Returns list of the font sizes in the cache. Each size is [Vector2i] with font size and outline size. */ get_size_cache_list(cache_index: int64): GArray /** Removes all font sizes from the cache entry. */ clear_size_cache(cache_index: int64): void /** Removes specified font size from the cache entry. */ remove_size_cache(cache_index: int64, size: Vector2i): void /** Sets variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. */ set_variation_coordinates(cache_index: int64, variation_coordinates: GDictionary): void /** Returns variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info. */ get_variation_coordinates(cache_index: int64): GDictionary /** Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. */ set_embolden(cache_index: int64, strength: float64): void /** Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. */ get_embolden(cache_index: int64): float64 /** Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs. */ set_transform(cache_index: int64, transform: Transform2D): void /** Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. */ get_transform(cache_index: int64): Transform2D /** Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). */ set_extra_spacing(cache_index: int64, spacing: TextServer.SpacingType, value: int64): void /** Returns spacing for [param spacing] (see [enum TextServer.SpacingType]) in pixels (not relative to the font size). */ get_extra_spacing(cache_index: int64, spacing: TextServer.SpacingType): int64 /** Sets extra baseline offset (as a fraction of font height). */ set_extra_baseline_offset(cache_index: int64, baseline_offset: float64): void /** Returns extra baseline offset (as a fraction of font height). */ get_extra_baseline_offset(cache_index: int64): float64 /** Sets an active face index in the TrueType / OpenType collection. */ set_face_index(cache_index: int64, face_index: int64): void /** Returns an active face index in the TrueType / OpenType collection. */ get_face_index(cache_index: int64): int64 /** Sets the font ascent (number of pixels above the baseline). */ set_cache_ascent(cache_index: int64, size: int64, ascent: float64): void /** Returns the font ascent (number of pixels above the baseline). */ get_cache_ascent(cache_index: int64, size: int64): float64 /** Sets the font descent (number of pixels below the baseline). */ set_cache_descent(cache_index: int64, size: int64, descent: float64): void /** Returns the font descent (number of pixels below the baseline). */ get_cache_descent(cache_index: int64, size: int64): float64 /** Sets pixel offset of the underline below the baseline. */ set_cache_underline_position(cache_index: int64, size: int64, underline_position: float64): void /** Returns pixel offset of the underline below the baseline. */ get_cache_underline_position(cache_index: int64, size: int64): float64 /** Sets thickness of the underline in pixels. */ set_cache_underline_thickness(cache_index: int64, size: int64, underline_thickness: float64): void /** Returns thickness of the underline in pixels. */ get_cache_underline_thickness(cache_index: int64, size: int64): float64 /** Sets scaling factor of the color bitmap font. */ set_cache_scale(cache_index: int64, size: int64, scale: float64): void /** Returns scaling factor of the color bitmap font. */ get_cache_scale(cache_index: int64, size: int64): float64 /** Returns number of textures used by font cache entry. */ get_texture_count(cache_index: int64, size: Vector2i): int64 /** Removes all textures from font cache entry. * * **Note:** This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually. */ clear_textures(cache_index: int64, size: Vector2i): void /** Removes specified texture from the cache entry. * * **Note:** This function will not remove glyphs associated with the texture. Remove them manually using [method remove_glyph]. */ remove_texture(cache_index: int64, size: Vector2i, texture_index: int64): void /** Sets font cache texture image. */ set_texture_image(cache_index: int64, size: Vector2i, texture_index: int64, image: Image): void /** Returns a copy of the font cache texture image. */ get_texture_image(cache_index: int64, size: Vector2i, texture_index: int64): Image /** Sets array containing glyph packing data. */ set_texture_offsets(cache_index: int64, size: Vector2i, texture_index: int64, offset: PackedInt32Array | int32[]): void /** Returns a copy of the array containing glyph packing data. */ get_texture_offsets(cache_index: int64, size: Vector2i, texture_index: int64): PackedInt32Array /** Returns list of rendered glyphs in the cache entry. */ get_glyph_list(cache_index: int64, size: Vector2i): PackedInt32Array /** Removes all rendered glyph information from the cache entry. * * **Note:** This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. */ clear_glyphs(cache_index: int64, size: Vector2i): void /** Removes specified rendered glyph information from the cache entry. * * **Note:** This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. */ remove_glyph(cache_index: int64, size: Vector2i, glyph: int64): void /** Sets glyph advance (offset of the next glyph). * * **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved. */ set_glyph_advance(cache_index: int64, size: int64, glyph: int64, advance: Vector2): void /** Returns glyph advance (offset of the next glyph). * * **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved. */ get_glyph_advance(cache_index: int64, size: int64, glyph: int64): Vector2 /** Sets glyph offset from the baseline. */ set_glyph_offset(cache_index: int64, size: Vector2i, glyph: int64, offset: Vector2): void /** Returns glyph offset from the baseline. */ get_glyph_offset(cache_index: int64, size: Vector2i, glyph: int64): Vector2 /** Sets glyph size. */ set_glyph_size(cache_index: int64, size: Vector2i, glyph: int64, gl_size: Vector2): void /** Returns glyph size. */ get_glyph_size(cache_index: int64, size: Vector2i, glyph: int64): Vector2 /** Sets rectangle in the cache texture containing the glyph. */ set_glyph_uv_rect(cache_index: int64, size: Vector2i, glyph: int64, uv_rect: Rect2): void /** Returns rectangle in the cache texture containing the glyph. */ get_glyph_uv_rect(cache_index: int64, size: Vector2i, glyph: int64): Rect2 /** Sets index of the cache texture containing the glyph. */ set_glyph_texture_idx(cache_index: int64, size: Vector2i, glyph: int64, texture_idx: int64): void /** Returns index of the cache texture containing the glyph. */ get_glyph_texture_idx(cache_index: int64, size: Vector2i, glyph: int64): int64 /** Returns list of the kerning overrides. */ get_kerning_list(cache_index: int64, size: int64): GArray /** Removes all kerning overrides. */ clear_kerning_map(cache_index: int64, size: int64): void /** Removes kerning override for the pair of glyphs. */ remove_kerning(cache_index: int64, size: int64, glyph_pair: Vector2i): void /** Sets kerning for the pair of glyphs. */ set_kerning(cache_index: int64, size: int64, glyph_pair: Vector2i, kerning: Vector2): void /** Returns kerning for the pair of glyphs. */ get_kerning(cache_index: int64, size: int64, glyph_pair: Vector2i): Vector2 /** Renders the range of characters to the font cache texture. */ render_range(cache_index: int64, size: Vector2i, start: int64, end: int64): void /** Renders specified glyph to the font cache texture. */ render_glyph(cache_index: int64, size: Vector2i, index: int64): void /** Adds override for [method Font.is_language_supported]. */ set_language_support_override(language: string, supported: boolean): void /** Returns `true` if support override is enabled for the [param language]. */ get_language_support_override(language: string): boolean /** Remove language support override. */ remove_language_support_override(language: string): void /** Returns list of language support overrides. */ get_language_support_overrides(): PackedStringArray /** Adds override for [method Font.is_script_supported]. */ set_script_support_override(script: string, supported: boolean): void /** Returns `true` if support override is enabled for the [param script]. */ get_script_support_override(script: string): boolean /** Removes script support override. */ remove_script_support_override(script: string): void /** Returns list of script support overrides. */ get_script_support_overrides(): PackedStringArray /** Returns the glyph index of a [param char], optionally modified by the [param variation_selector]. */ get_glyph_index(size: int64, char: int64, variation_selector: int64): int64 /** Returns character code associated with [param glyph_index], or `0` if [param glyph_index] is invalid. See [method get_glyph_index]. */ get_char_from_glyph_index(size: int64, glyph_index: int64): int64 /** Contents of the dynamic font source file. */ get data(): PackedByteArray set data(value: PackedByteArray | byte[] | ArrayBuffer) /** If set to `true`, generate mipmaps for the font textures. */ get generate_mipmaps(): boolean set generate_mipmaps(value: boolean) /** If set to `true`, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property). */ get disable_embedded_bitmaps(): boolean set disable_embedded_bitmaps(value: boolean) /** Font anti-aliasing mode. */ get antialiasing(): int64 set antialiasing(value: int64) /** Font family name. */ get font_name(): string set font_name(value: string) /** Font style name. */ get style_name(): string set style_name(value: string) /** Font style flags, see [enum TextServer.FontStyle]. */ get font_style(): int64 set font_style(value: int64) /** Weight (boldness) of the font. A value in the `100...999` range, normal font weight is `400`, bold font weight is `700`. */ get font_weight(): int64 set font_weight(value: int64) /** Font stretch amount, compared to a normal width. A percentage value between `50%` and `200%`. */ get font_stretch(): int64 set font_stretch(value: int64) /** Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of higher memory usage and lower font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size. */ get subpixel_positioning(): int64 set subpixel_positioning(value: int64) /** If set to `true`, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled. */ get keep_rounding_remainders(): boolean set keep_rounding_remainders(value: boolean) /** If set to `true`, glyphs of all sizes are rendered using single multichannel signed distance field (MSDF) generated from the dynamic font vector data. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for [Control]s that are scaled down (or for [Label3D]s viewed from a long distance). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. * * **Note:** If using font outlines, [member msdf_pixel_range] must be set to at least *twice* the size of the largest font outline. * * **Note:** MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. */ get multichannel_signed_distance_field(): boolean set multichannel_signed_distance_field(value: boolean) /** The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, [member msdf_pixel_range] must be set to at least *twice* the size of the largest font outline. The default [member msdf_pixel_range] value of `16` allows outline sizes up to `8` to look correct. */ get msdf_pixel_range(): int64 set msdf_pixel_range(value: int64) /** Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering. */ get msdf_size(): int64 set msdf_size(value: int64) /** If set to `true`, system fonts can be automatically used as fallbacks. */ get allow_system_fallback(): boolean set allow_system_fallback(value: boolean) /** If set to `true`, auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only (MSDF fonts don't support hinting). */ get force_autohinter(): boolean set force_autohinter(value: boolean) /** Font hinting mode. Used by dynamic fonts only. */ get hinting(): int64 set hinting(value: int64) /** Font oversampling factor. If set to `0.0`, the global oversampling factor is used instead. Used by dynamic fonts only (MSDF fonts ignore oversampling). */ get oversampling(): float64 set oversampling(value: float64) /** Font size, used only for the bitmap fonts. */ get fixed_size(): int64 set fixed_size(value: int64) /** Scaling mode, used only for the bitmap fonts with [member fixed_size] greater than zero. */ get fixed_size_scale_mode(): int64 set fixed_size_scale_mode(value: int64) /** Font OpenType feature set override. */ get opentype_feature_overrides(): GDictionary set opentype_feature_overrides(value: GDictionary) } /** A variation of a font with additional settings. * * @link https://docs.godotengine.org/en/4.4/classes/class_fontvariation.html */ class FontVariation extends Font { constructor(identifier?: any) /** Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). */ set_spacing(spacing: TextServer.SpacingType, value: int64): void /** Base font used to create a variation. If not set, default [Theme] font is used. */ get base_font(): Font set base_font(value: Font) /** Font OpenType variation coordinates. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg]OpenType variation tags[/url]. * * **Note:** This [Dictionary] uses OpenType tags as keys. Variation axes can be identified both by tags ([int], e.g. `0x77678674`) and names ([String], e.g. `wght`). Some axes might be accessible by multiple names. For example, `wght` refers to the same axis as `weight`. Tags on the other hand are unique. To convert between names and tags, use [method TextServer.name_to_tag] and [method TextServer.tag_to_name]. * * **Note:** To get available variation axes of a font, use [method Font.get_supported_variation_list]. */ get variation_opentype(): GDictionary set variation_opentype(value: GDictionary) /** Active face index in the TrueType / OpenType collection file. */ get variation_face_index(): int64 set variation_face_index(value: int64) /** If is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. * * **Note:** Emboldened fonts might have self-intersecting outlines, which will prevent MSDF fonts and [TextMesh] from working correctly. */ get variation_embolden(): float64 set variation_embolden(value: float64) /** 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs. * For example, to simulate italic typeface by slanting, apply the following transform `Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)`. */ get variation_transform(): Transform2D set variation_transform(value: Transform2D) /** A set of OpenType feature tags. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url]. */ get opentype_features(): GDictionary set opentype_features(value: GDictionary) /** Extra spacing between graphical glyphs. */ get spacing_glyph(): int64 set spacing_glyph(value: int64) /** Extra width of the space glyphs. */ get spacing_space(): int64 set spacing_space(value: int64) /** Extra spacing at the top of the line in pixels. */ get spacing_top(): int64 set spacing_top(value: int64) /** Extra spacing at the bottom of the line in pixels. */ get spacing_bottom(): int64 set spacing_bottom(value: int64) /** Extra baseline offset (as a fraction of font height). */ get baseline_offset(): float64 set baseline_offset(value: float64) } /** Framebuffer cache manager for Rendering Device based renderers. * * @link https://docs.godotengine.org/en/4.4/classes/class_framebuffercacherd.html */ class FramebufferCacheRD extends Object { constructor(identifier?: any) /** Creates, or obtains a cached, framebuffer. [param textures] lists textures accessed. [param passes] defines the subpasses and texture allocation, if left empty a single pass is created and textures are allocated depending on their usage flags. [param views] defines the number of views used when rendering. */ static get_cache_multipass(textures: GArray, passes: GArray, views: int64): RID } namespace GDExtension { enum InitializationLevel { /** The library is initialized at the same time as the core features of the engine. */ INITIALIZATION_LEVEL_CORE = 0, /** The library is initialized at the same time as the engine's servers (such as [RenderingServer] or [PhysicsServer3D]). */ INITIALIZATION_LEVEL_SERVERS = 1, /** The library is initialized at the same time as the engine's scene-related classes. */ INITIALIZATION_LEVEL_SCENE = 2, /** The library is initialized at the same time as the engine's editor classes. Only happens when loading the GDExtension in the editor. */ INITIALIZATION_LEVEL_EDITOR = 3, } } /** A native library for GDExtension. * * @link https://docs.godotengine.org/en/4.4/classes/class_gdextension.html */ class GDExtension extends Resource { constructor(identifier?: any) /** Returns `true` if this extension's library has been opened. */ is_library_open(): boolean /** Returns the lowest level required for this extension to be properly initialized (see the [enum InitializationLevel] enum). */ get_minimum_library_initialization_level(): GDExtension.InitializationLevel } class GDScriptLanguageServer = Record> extends EditorPlugin { constructor(identifier?: any) } /** @link https://docs.godotengine.org/en/4.4/classes/class_gdscripttextdocument.html */ class GDScriptTextDocument extends RefCounted { constructor(identifier?: any) didOpen(_unnamed_arg0: any): void didClose(_unnamed_arg0: any): void didChange(_unnamed_arg0: any): void willSaveWaitUntil(_unnamed_arg0: any): void didSave(_unnamed_arg0: any): void nativeSymbol(_unnamed_arg0: GDictionary): any documentSymbol(_unnamed_arg0: GDictionary): GArray completion(_unnamed_arg0: GDictionary): GArray resolve(_unnamed_arg0: GDictionary): GDictionary rename(_unnamed_arg0: GDictionary): GDictionary prepareRename(_unnamed_arg0: GDictionary): any references(_unnamed_arg0: GDictionary): GArray foldingRange(_unnamed_arg0: GDictionary): GArray codeLens(_unnamed_arg0: GDictionary): GArray documentLink(_unnamed_arg0: GDictionary): GArray colorPresentation(_unnamed_arg0: GDictionary): GArray hover(_unnamed_arg0: GDictionary): any definition(_unnamed_arg0: GDictionary): GArray declaration(_unnamed_arg0: GDictionary): any signatureHelp(_unnamed_arg0: GDictionary): any show_native_symbol_in_editor(_unnamed_arg0: string): void } /** @link https://docs.godotengine.org/en/4.4/classes/class_gdscriptworkspace.html */ class GDScriptWorkspace extends RefCounted { constructor(identifier?: any) apply_new_signal(_unnamed_arg0: Object, _unnamed_arg1: string, _unnamed_arg2: PackedStringArray | string[]): void didDeleteFiles(_unnamed_arg0: GDictionary): void parse_script(path: string, content: string): GError parse_local_script(path: string): GError get_file_path(uri: string): string get_file_uri(path: string): string publish_diagnostics(path: string): void generate_script_api(path: string): GDictionary } namespace GLTFAccessor { enum GLTFAccessorType { /** Accessor type "SCALAR". For the glTF object model, this can be used to map to a single float, int, or bool value, or a float array. */ TYPE_SCALAR = 0, /** Accessor type "VEC2". For the glTF object model, this maps to "float2", represented in the glTF JSON as an array of two floats. */ TYPE_VEC2 = 1, /** Accessor type "VEC3". For the glTF object model, this maps to "float3", represented in the glTF JSON as an array of three floats. */ TYPE_VEC3 = 2, /** Accessor type "VEC4". For the glTF object model, this maps to "float4", represented in the glTF JSON as an array of four floats. */ TYPE_VEC4 = 3, /** Accessor type "MAT2". For the glTF object model, this maps to "float2x2", represented in the glTF JSON as an array of four floats. */ TYPE_MAT2 = 4, /** Accessor type "MAT3". For the glTF object model, this maps to "float3x3", represented in the glTF JSON as an array of nine floats. */ TYPE_MAT3 = 5, /** Accessor type "MAT4". For the glTF object model, this maps to "float4x4", represented in the glTF JSON as an array of sixteen floats. */ TYPE_MAT4 = 6, } enum GLTFComponentType { /** Component type "NONE". This is not a valid component type, and is used to indicate that the component type is not set. */ COMPONENT_TYPE_NONE = 0, /** Component type "BYTE". The value is `0x1400` which comes from OpenGL. This indicates data is stored in 1-byte or 8-bit signed integers. This is a core part of the glTF specification. */ COMPONENT_TYPE_SIGNED_BYTE = 5120, /** Component type "UNSIGNED_BYTE". The value is `0x1401` which comes from OpenGL. This indicates data is stored in 1-byte or 8-bit unsigned integers. This is a core part of the glTF specification. */ COMPONENT_TYPE_UNSIGNED_BYTE = 5121, /** Component type "SHORT". The value is `0x1402` which comes from OpenGL. This indicates data is stored in 2-byte or 16-bit signed integers. This is a core part of the glTF specification. */ COMPONENT_TYPE_SIGNED_SHORT = 5122, /** Component type "UNSIGNED_SHORT". The value is `0x1403` which comes from OpenGL. This indicates data is stored in 2-byte or 16-bit unsigned integers. This is a core part of the glTF specification. */ COMPONENT_TYPE_UNSIGNED_SHORT = 5123, /** Component type "INT". The value is `0x1404` which comes from OpenGL. This indicates data is stored in 4-byte or 32-bit signed integers. This is NOT a core part of the glTF specification, and may not be supported by all glTF importers. May be used by some extensions including `KHR_interactivity`. */ COMPONENT_TYPE_SIGNED_INT = 5124, /** Component type "UNSIGNED_INT". The value is `0x1405` which comes from OpenGL. This indicates data is stored in 4-byte or 32-bit unsigned integers. This is a core part of the glTF specification. */ COMPONENT_TYPE_UNSIGNED_INT = 5125, /** Component type "FLOAT". The value is `0x1406` which comes from OpenGL. This indicates data is stored in 4-byte or 32-bit floating-point numbers. This is a core part of the glTF specification. */ COMPONENT_TYPE_SINGLE_FLOAT = 5126, /** Component type "DOUBLE". The value is `0x140A` which comes from OpenGL. This indicates data is stored in 8-byte or 64-bit floating-point numbers. This is NOT a core part of the glTF specification, and may not be supported by all glTF importers. May be used by some extensions including `KHR_interactivity`. */ COMPONENT_TYPE_DOUBLE_FLOAT = 5130, /** Component type "HALF_FLOAT". The value is `0x140B` which comes from OpenGL. This indicates data is stored in 2-byte or 16-bit floating-point numbers. This is NOT a core part of the glTF specification, and may not be supported by all glTF importers. May be used by some extensions including `KHR_interactivity`. */ COMPONENT_TYPE_HALF_FLOAT = 5131, /** Component type "LONG". The value is `0x140E` which comes from OpenGL. This indicates data is stored in 8-byte or 64-bit signed integers. This is NOT a core part of the glTF specification, and may not be supported by all glTF importers. May be used by some extensions including `KHR_interactivity`. */ COMPONENT_TYPE_SIGNED_LONG = 5134, /** Component type "UNSIGNED_LONG". The value is `0x140F` which comes from OpenGL. This indicates data is stored in 8-byte or 64-bit unsigned integers. This is NOT a core part of the glTF specification, and may not be supported by all glTF importers. May be used by some extensions including `KHR_interactivity`. */ COMPONENT_TYPE_UNSIGNED_LONG = 5135, } } /** Represents a glTF accessor. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfaccessor.html */ class GLTFAccessor extends Resource { constructor(identifier?: any) /** The index of the buffer view this accessor is referencing. If `-1`, this accessor is not referencing any buffer view. */ get buffer_view(): int64 set buffer_view(value: int64) /** The offset relative to the start of the buffer view in bytes. */ get byte_offset(): int64 set byte_offset(value: int64) /** The glTF component type as an enum. See [enum GLTFComponentType] for possible values. Within the core glTF specification, a value of 5125 or "UNSIGNED_INT" must not be used for any accessor that is not referenced by mesh.primitive.indices. */ get component_type(): int64 set component_type(value: int64) /** Specifies whether integer data values are normalized before usage. */ get normalized(): boolean set normalized(value: boolean) /** The number of elements referenced by this accessor. */ get count(): int64 set count(value: int64) /** The glTF accessor type as an enum. Possible values are 0 for "SCALAR", 1 for "VEC2", 2 for "VEC3", 3 for "VEC4", 4 for "MAT2", 5 for "MAT3", and 6 for "MAT4". */ get accessor_type(): int64 set accessor_type(value: int64) /** The glTF accessor type as an enum. Use [member accessor_type] instead. */ get type(): int64 set type(value: int64) /** Minimum value of each component in this accessor. */ get min(): PackedFloat64Array set min(value: PackedFloat64Array | float64[]) /** Maximum value of each component in this accessor. */ get max(): PackedFloat64Array set max(value: PackedFloat64Array | float64[]) /** Number of deviating accessor values stored in the sparse array. */ get sparse_count(): int64 set sparse_count(value: int64) /** The index of the buffer view with sparse indices. The referenced buffer view MUST NOT have its target or byteStride properties defined. The buffer view and the optional byteOffset MUST be aligned to the componentType byte length. */ get sparse_indices_buffer_view(): int64 set sparse_indices_buffer_view(value: int64) /** The offset relative to the start of the buffer view in bytes. */ get sparse_indices_byte_offset(): int64 set sparse_indices_byte_offset(value: int64) /** The indices component data type as an enum. Possible values are 5121 for "UNSIGNED_BYTE", 5123 for "UNSIGNED_SHORT", and 5125 for "UNSIGNED_INT". */ get sparse_indices_component_type(): int64 set sparse_indices_component_type(value: int64) /** The index of the bufferView with sparse values. The referenced buffer view MUST NOT have its target or byteStride properties defined. */ get sparse_values_buffer_view(): int64 set sparse_values_buffer_view(value: int64) /** The offset relative to the start of the bufferView in bytes. */ get sparse_values_byte_offset(): int64 set sparse_values_byte_offset(value: int64) } /** @link https://docs.godotengine.org/en/4.4/classes/class_gltfanimation.html */ class GLTFAnimation extends Resource { constructor(identifier?: any) /** Gets additional arbitrary data in this [GLTFAnimation] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is `null`. */ get_additional_data(extension_name: StringName): any /** Sets additional arbitrary data in this [GLTFAnimation] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the second argument can be anything you want. */ set_additional_data(extension_name: StringName, additional_data: any): void /** The original name of the animation. */ get original_name(): string set original_name(value: string) get loop(): boolean set loop(value: boolean) } /** Represents a glTF buffer view. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfbufferview.html */ class GLTFBufferView extends Resource { constructor(identifier?: any) /** Loads the buffer view data from the buffer referenced by this buffer view in the given [GLTFState]. Interleaved data with a byte stride is not yet supported by this method. The data is returned as a [PackedByteArray]. */ load_buffer_view_data(state: GLTFState): PackedByteArray /** The index of the buffer this buffer view is referencing. If `-1`, this buffer view is not referencing any buffer. */ get buffer(): int64 set buffer(value: int64) /** The offset, in bytes, from the start of the buffer to the start of this buffer view. */ get byte_offset(): int64 set byte_offset(value: int64) /** The length, in bytes, of this buffer view. If `0`, this buffer view is empty. */ get byte_length(): int64 set byte_length(value: int64) /** The stride, in bytes, between interleaved data. If `-1`, this buffer view is not interleaved. */ get byte_stride(): int64 set byte_stride(value: int64) /** `true` if the GLTFBufferView's OpenGL GPU buffer type is an `ELEMENT_ARRAY_BUFFER` used for vertex indices (integer constant `34963`). `false` if the buffer type is any other value. See [url=https://github.com/KhronosGroup/glTF-Tutorials/blob/master/gltfTutorial/gltfTutorial_005_BuffersBufferViewsAccessors.md]Buffers, BufferViews, and Accessors[/url] for possible values. This property is set on import and used on export. */ get indices(): boolean set indices(value: boolean) /** `true` if the GLTFBufferView's OpenGL GPU buffer type is an `ARRAY_BUFFER` used for vertex attributes (integer constant `34962`). `false` if the buffer type is any other value. See [url=https://github.com/KhronosGroup/glTF-Tutorials/blob/master/gltfTutorial/gltfTutorial_005_BuffersBufferViewsAccessors.md]Buffers, BufferViews, and Accessors[/url] for possible values. This property is set on import and used on export. */ get vertex_attributes(): boolean set vertex_attributes(value: boolean) } /** Represents a glTF camera. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfcamera.html */ class GLTFCamera extends Resource { constructor(identifier?: any) /** Create a new GLTFCamera instance from the given Godot [Camera3D] node. */ static from_node(camera_node: Camera3D): GLTFCamera /** Converts this GLTFCamera instance into a Godot [Camera3D] node. */ to_node(): Camera3D /** Creates a new GLTFCamera instance by parsing the given [Dictionary]. */ static from_dictionary(dictionary: GDictionary): GLTFCamera /** Serializes this GLTFCamera instance into a [Dictionary]. */ to_dictionary(): GDictionary /** If `true`, the camera is in perspective mode. Otherwise, the camera is in orthographic/orthogonal mode. This maps to glTF's camera `type` property. See [member Camera3D.projection] and the glTF spec for more information. */ get perspective(): boolean set perspective(value: boolean) /** The FOV of the camera. This class and glTF define the camera FOV in radians, while Godot uses degrees. This maps to glTF's `yfov` property. This value is only used for perspective cameras, when [member perspective] is `true`. */ get fov(): float64 set fov(value: float64) /** The size of the camera. This class and glTF define the camera size magnitude as a radius in meters, while Godot defines it as a diameter in meters. This maps to glTF's `ymag` property. This value is only used for orthographic/orthogonal cameras, when [member perspective] is `false`. */ get size_mag(): float64 set size_mag(value: float64) /** The distance to the far culling boundary for this camera relative to its local Z axis, in meters. This maps to glTF's `zfar` property. */ get depth_far(): float64 set depth_far(value: float64) /** The distance to the near culling boundary for this camera relative to its local Z axis, in meters. This maps to glTF's `znear` property. */ get depth_near(): float64 set depth_near(value: float64) } namespace GLTFDocument { enum RootNodeMode { /** Treat the Godot scene's root node as the root node of the glTF file, and mark it as the single root node via the `GODOT_single_root` glTF extension. This will be parsed the same as [constant ROOT_NODE_MODE_KEEP_ROOT] if the implementation does not support `GODOT_single_root`. */ ROOT_NODE_MODE_SINGLE_ROOT = 0, /** Treat the Godot scene's root node as the root node of the glTF file, but do not mark it as anything special. An extra root node will be generated when importing into Godot. This uses only vanilla glTF features. This is equivalent to the behavior in Godot 4.1 and earlier. */ ROOT_NODE_MODE_KEEP_ROOT = 1, /** Treat the Godot scene's root node as the name of the glTF scene, and add all of its children as root nodes of the glTF file. This uses only vanilla glTF features. This avoids an extra root node, but only the name of the Godot scene's root node will be preserved, as it will not be saved as a node. */ ROOT_NODE_MODE_MULTI_ROOT = 2, } } /** Class for importing and exporting glTF files in and out of Godot. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfdocument.html */ class GLTFDocument extends Resource { constructor(identifier?: any) /** Takes a path to a glTF file and imports the data at that file path to the given [GLTFState] object through the [param state] parameter. * * **Note:** The [param base_path] tells [method append_from_file] where to find dependencies and can be empty. */ append_from_file(path: string, state: GLTFState, flags: int64 = 0, base_path: string = ''): GError /** Takes a [PackedByteArray] defining a glTF and imports the data to the given [GLTFState] object through the [param state] parameter. * * **Note:** The [param base_path] tells [method append_from_buffer] where to find dependencies and can be empty. */ append_from_buffer(bytes: PackedByteArray | byte[] | ArrayBuffer, base_path: string, state: GLTFState, flags: int64 = 0): GError /** Takes a Godot Engine scene node and exports it and its descendants to the given [GLTFState] object through the [param state] parameter. */ append_from_scene(node: Node, state: GLTFState, flags: int64 = 0): GError /** Takes a [GLTFState] object through the [param state] parameter and returns a Godot Engine scene node. * The [param bake_fps] parameter overrides the bake_fps in [param state]. */ generate_scene(state: GLTFState, bake_fps: float64 = 30, trimming: boolean = false, remove_immutable_tracks: boolean = true): Node /** Takes a [GLTFState] object through the [param state] parameter and returns a glTF [PackedByteArray]. */ generate_buffer(state: GLTFState): PackedByteArray /** Takes a [GLTFState] object through the [param state] parameter and writes a glTF file to the filesystem. * * **Note:** The extension of the glTF file determines if it is a .glb binary file or a .gltf text file. */ write_to_filesystem(state: GLTFState, path: string): GError /** Determines a mapping between the given glTF Object Model [param json_pointer] and the corresponding Godot node path(s) in the generated Godot scene. The details of this mapping are returned in a [GLTFObjectModelProperty] object. Additional mappings can be supplied via the [method GLTFDocumentExtension._export_object_model_property] callback method. */ static import_object_model_property(state: GLTFState, json_pointer: string): GLTFObjectModelProperty /** Determines a mapping between the given Godot [param node_path] and the corresponding glTF Object Model JSON pointer(s) in the generated glTF file. The details of this mapping are returned in a [GLTFObjectModelProperty] object. Additional mappings can be supplied via the [method GLTFDocumentExtension._import_object_model_property] callback method. */ static export_object_model_property(state: GLTFState, node_path: NodePath | string, godot_node: Node, gltf_node_index: int64): GLTFObjectModelProperty /** Registers the given [GLTFDocumentExtension] instance with GLTFDocument. If [param first_priority] is `true`, this extension will be run first. Otherwise, it will be run last. * * **Note:** Like GLTFDocument itself, all GLTFDocumentExtension classes must be stateless in order to function properly. If you need to store data, use the `set_additional_data` and `get_additional_data` methods in [GLTFState] or [GLTFNode]. */ static register_gltf_document_extension(extension: GLTFDocumentExtension, first_priority: boolean = false): void /** Unregisters the given [GLTFDocumentExtension] instance. */ static unregister_gltf_document_extension(extension: GLTFDocumentExtension): void /** Returns a list of all support glTF extensions, including extensions supported directly by the engine, and extensions supported by user plugins registering [GLTFDocumentExtension] classes. * * **Note:** If this method is run before a GLTFDocumentExtension is registered, its extensions won't be included in the list. Be sure to only run this method after all extensions are registered. If you run this when the engine starts, consider waiting a frame before calling this method to ensure all extensions are registered. */ static get_supported_gltf_extensions(): PackedStringArray /** The user-friendly name of the export image format. This is used when exporting the glTF file, including writing to a file and writing to a byte array. * By default, Godot allows the following options: "None", "PNG", "JPEG", "Lossless WebP", and "Lossy WebP". Support for more image formats can be added in [GLTFDocumentExtension] classes. */ get image_format(): string set image_format(value: string) /** If [member image_format] is a lossy image format, this determines the lossy quality of the image. On a range of `0.0` to `1.0`, where `0.0` is the lowest quality and `1.0` is the highest quality. A lossy quality of `1.0` is not the same as lossless. */ get lossy_quality(): float64 set lossy_quality(value: float64) /** How to process the root node during export. See [enum RootNodeMode] for details. The default and recommended value is [constant ROOT_NODE_MODE_SINGLE_ROOT]. * * **Note:** Regardless of how the glTF file is exported, when importing, the root node type and name can be overridden in the scene import settings tab. */ get root_node_mode(): int64 set root_node_mode(value: int64) } /** [GLTFDocument] extension class. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfdocumentextension.html */ class GLTFDocumentExtension extends Resource { constructor(identifier?: any) /** Part of the import process. This method is run first, before all other parts of the import process. * The return value is used to determine if this [GLTFDocumentExtension] instance should be used for importing a given glTF file. If [constant OK], the import will use this [GLTFDocumentExtension] instance. If not overridden, [constant OK] is returned. */ /* gdvirtual */ _import_preflight(state: GLTFState, extensions: PackedStringArray | string[]): GError /** Part of the import process. This method is run after [method _import_preflight] and before [method _parse_node_extensions]. * Returns an array of the glTF extensions supported by this GLTFDocumentExtension class. This is used to validate if a glTF file with required extensions can be loaded. */ /* gdvirtual */ _get_supported_extensions(): PackedStringArray /** Part of the import process. This method is run after [method _get_supported_extensions] and before [method _import_post_parse]. * Runs when parsing the node extensions of a GLTFNode. This method can be used to process the extension JSON data into a format that can be used by [method _generate_scene_node]. The return value should be a member of the [enum Error] enum. */ /* gdvirtual */ _parse_node_extensions(state: GLTFState, gltf_node: GLTFNode, extensions: GDictionary): GError /** Part of the import process. This method is run after [method _parse_node_extensions] and before [method _parse_texture_json]. * Runs when parsing image data from a glTF file. The data could be sourced from a separate file, a URI, or a buffer, and then is passed as a byte array. */ /* gdvirtual */ _parse_image_data(state: GLTFState, image_data: PackedByteArray | byte[] | ArrayBuffer, mime_type: string, ret_image: Image): GError /** Returns the file extension to use for saving image data into, for example, `".png"`. If defined, when this extension is used to handle images, and the images are saved to a separate file, the image bytes will be copied to a file with this extension. If this is set, there should be a [ResourceImporter] class able to import the file. If not defined or empty, Godot will save the image into a PNG file. */ /* gdvirtual */ _get_image_file_extension(): string /** Part of the import process. This method is run after [method _parse_image_data] and before [method _generate_scene_node]. * Runs when parsing the texture JSON from the glTF textures array. This can be used to set the source image index to use as the texture. */ /* gdvirtual */ _parse_texture_json(state: GLTFState, texture_json: GDictionary, ret_gltf_texture: GLTFTexture): GError /** Part of the import process. Allows GLTFDocumentExtension classes to provide mappings for JSON pointers to glTF properties, as defined by the glTF object model, to properties of nodes in the Godot scene tree. * Returns a [GLTFObjectModelProperty] instance that defines how the property should be mapped. If your extension can't handle the property, return `null` or an instance without any NodePaths (see [method GLTFObjectModelProperty.has_node_paths]). You should use [method GLTFObjectModelProperty.set_types] to set the types, and [method GLTFObjectModelProperty.append_path_to_property] function is useful for most simple cases. * In many cases, [param partial_paths] will contain the start of a path, allowing the extension to complete the path. For example, for `/nodes/3/extensions/MY_ext/prop`, Godot will pass you a NodePath that leads to node 3, so the GLTFDocumentExtension class only needs to resolve the last `MY_ext/prop` part of the path. In this example, the extension should check `split.size() > 4 and split[0] == "nodes" and split[2] == "extensions" and split[3] == "MY_ext"` at the start of the function to check if this JSON pointer applies to it, then it can use [param partial_paths] and handle `split[4]`. */ /* gdvirtual */ _import_object_model_property(state: GLTFState, split_json_pointer: PackedStringArray | string[], partial_paths: GArray): GLTFObjectModelProperty /** Part of the import process. This method is run after [method _parse_node_extensions] and before [method _import_pre_generate]. * This method can be used to modify any of the data imported so far after parsing each node, but before generating the scene or any of its nodes. */ /* gdvirtual */ _import_post_parse(state: GLTFState): GError /** Part of the import process. This method is run after [method _import_post_parse] and before [method _generate_scene_node]. * This method can be used to modify or read from any of the processed data structures, before generating the nodes and then running the final per-node import step. */ /* gdvirtual */ _import_pre_generate(state: GLTFState): GError /** Part of the import process. This method is run after [method _import_pre_generate] and before [method _import_node]. * Runs when generating a Godot scene node from a GLTFNode. The returned node will be added to the scene tree. Multiple nodes can be generated in this step if they are added as a child of the returned node. * * **Note:** The [param scene_parent] parameter may be `null` if this is the single root node. */ /* gdvirtual */ _generate_scene_node(state: GLTFState, gltf_node: GLTFNode, scene_parent: Node): Node3D /** Part of the import process. This method is run after [method _generate_scene_node] and before [method _import_post]. * This method can be used to make modifications to each of the generated Godot scene nodes. */ /* gdvirtual */ _import_node(state: GLTFState, gltf_node: GLTFNode, json: GDictionary, node: Node): GError /** Part of the import process. This method is run last, after all other parts of the import process. * This method can be used to modify the final Godot scene generated by the import process. */ /* gdvirtual */ _import_post(state: GLTFState, root: Node): GError /** Part of the export process. This method is run first, before all other parts of the export process. * The return value is used to determine if this [GLTFDocumentExtension] instance should be used for exporting a given glTF file. If [constant OK], the export will use this [GLTFDocumentExtension] instance. If not overridden, [constant OK] is returned. */ /* gdvirtual */ _export_preflight(state: GLTFState, root: Node): GError /** Part of the export process. This method is run after [method _export_preflight] and before [method _export_post_convert]. * Runs when converting the data from a Godot scene node. This method can be used to process the Godot scene node data into a format that can be used by [method _export_node]. */ /* gdvirtual */ _convert_scene_node(state: GLTFState, gltf_node: GLTFNode, scene_node: Node): void /** Part of the export process. This method is run after [method _convert_scene_node] and before [method _export_preserialize]. * This method can be used to modify the converted node data structures before serialization with any additional data from the scene tree. */ /* gdvirtual */ _export_post_convert(state: GLTFState, root: Node): GError /** Part of the export process. This method is run after [method _export_post_convert] and before [method _get_saveable_image_formats]. * This method can be used to alter the state before performing serialization. It runs every time when generating a buffer with [method GLTFDocument.generate_buffer] or writing to the file system with [method GLTFDocument.write_to_filesystem]. */ /* gdvirtual */ _export_preserialize(state: GLTFState): GError /** Part of the export process. Allows GLTFDocumentExtension classes to provide mappings for properties of nodes in the Godot scene tree, to JSON pointers to glTF properties, as defined by the glTF object model. * Returns a [GLTFObjectModelProperty] instance that defines how the property should be mapped. If your extension can't handle the property, return `null` or an instance without any JSON pointers (see [method GLTFObjectModelProperty.has_json_pointers]). You should use [method GLTFObjectModelProperty.set_types] to set the types, and set the JSON pointer(s) using the [member GLTFObjectModelProperty.json_pointers] property. * The parameters provide context for the property, including the NodePath, the Godot node, the GLTF node index, and the target object. The [param target_object] will be equal to [param godot_node] if no sub-object can be found, otherwise it will point to a sub-object. For example, if the path is `^"A/B/C/MeshInstance3D:mesh:surface_0/material:emission_intensity"`, it will get the node, then the mesh, and then the material, so [param target_object] will be the [Material] resource, and [param target_depth] will be 2 because 2 levels were traversed to get to the target. */ /* gdvirtual */ _export_object_model_property(state: GLTFState, node_path: NodePath | string, godot_node: Node, gltf_node_index: int64, target_object: Object, target_depth: int64): GLTFObjectModelProperty /** Part of the export process. This method is run after [method _convert_scene_node] and before [method _export_node]. * Returns an array of the image formats that can be saved/exported by this extension. This extension will only be selected as the image exporter if the [GLTFDocument]'s [member GLTFDocument.image_format] is in this array. If this [GLTFDocumentExtension] is selected as the image exporter, one of the [method _save_image_at_path] or [method _serialize_image_to_bytes] methods will run next, otherwise [method _export_node] will run next. If the format name contains `"Lossy"`, the lossy quality slider will be displayed. */ /* gdvirtual */ _get_saveable_image_formats(): PackedStringArray /** Part of the export process. This method is run after [method _get_saveable_image_formats] and before [method _serialize_texture_json]. * This method is run when embedding images in the glTF file. When images are saved separately, [method _save_image_at_path] runs instead. Note that these methods only run when this [GLTFDocumentExtension] is selected as the image exporter. * This method must set the image MIME type in the [param image_dict] with the `"mimeType"` key. For example, for a PNG image, it would be set to `"image/png"`. The return value must be a [PackedByteArray] containing the image data. */ /* gdvirtual */ _serialize_image_to_bytes(state: GLTFState, image: Image, image_dict: GDictionary, image_format: string, lossy_quality: float64): PackedByteArray /** Part of the export process. This method is run after [method _get_saveable_image_formats] and before [method _serialize_texture_json]. * This method is run when saving images separately from the glTF file. When images are embedded, [method _serialize_image_to_bytes] runs instead. Note that these methods only run when this [GLTFDocumentExtension] is selected as the image exporter. */ /* gdvirtual */ _save_image_at_path(state: GLTFState, image: Image, file_path: string, image_format: string, lossy_quality: float64): GError /** Part of the export process. This method is run after [method _save_image_at_path] or [method _serialize_image_to_bytes], and before [method _export_node]. Note that this method only runs when this [GLTFDocumentExtension] is selected as the image exporter. * This method can be used to set up the extensions for the texture JSON by editing [param texture_json]. The extension must also be added as used extension with [method GLTFState.add_used_extension], be sure to set `required` to `true` if you are not providing a fallback. */ /* gdvirtual */ _serialize_texture_json(state: GLTFState, texture_json: GDictionary, gltf_texture: GLTFTexture, image_format: string): GError /** Part of the export process. This method is run after [method _get_saveable_image_formats] and before [method _export_post]. If this [GLTFDocumentExtension] is used for exporting images, this runs after [method _serialize_texture_json]. * This method can be used to modify the final JSON of each node. Data should be primarily stored in [param gltf_node] prior to serializing the JSON, but the original Godot [Node] is also provided if available. [param node] may be `null` if not available, such as when exporting glTF data not generated from a Godot scene. */ /* gdvirtual */ _export_node(state: GLTFState, gltf_node: GLTFNode, json: GDictionary, node: Node): GError /** Part of the export process. This method is run last, after all other parts of the export process. * This method can be used to modify the final JSON of the generated glTF file. */ /* gdvirtual */ _export_post(state: GLTFState): GError } /** @link https://docs.godotengine.org/en/4.4/classes/class_gltfdocumentextensionconvertimportermesh.html */ class GLTFDocumentExtensionConvertImporterMesh extends GLTFDocumentExtension { constructor(identifier?: any) } class GLTFDocumentExtensionPhysics extends GLTFDocumentExtension { constructor(identifier?: any) } class GLTFDocumentExtensionTextureKTX extends GLTFDocumentExtension { constructor(identifier?: any) } class GLTFDocumentExtensionTextureWebP extends GLTFDocumentExtension { constructor(identifier?: any) } /** Represents a glTF light. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltflight.html */ class GLTFLight extends Resource { constructor(identifier?: any) /** Create a new GLTFLight instance from the given Godot [Light3D] node. */ static from_node(light_node: Light3D): GLTFLight /** Converts this GLTFLight instance into a Godot [Light3D] node. */ to_node(): Light3D /** Creates a new GLTFLight instance by parsing the given [Dictionary]. */ static from_dictionary(dictionary: GDictionary): GLTFLight /** Serializes this GLTFLight instance into a [Dictionary]. */ to_dictionary(): GDictionary get_additional_data(extension_name: StringName): any set_additional_data(extension_name: StringName, additional_data: any): void /** The [Color] of the light. Defaults to white. A black color causes the light to have no effect. */ get color(): Color set color(value: Color) /** The intensity of the light. This is expressed in candelas (lumens per steradian) for point and spot lights, and lux (lumens per m²) for directional lights. When creating a Godot light, this value is converted to a unitless multiplier. */ get intensity(): float64 set intensity(value: float64) /** The type of the light. The values accepted by Godot are "point", "spot", and "directional", which correspond to Godot's [OmniLight3D], [SpotLight3D], and [DirectionalLight3D] respectively. */ get light_type(): string set light_type(value: string) /** The range of the light, beyond which the light has no effect. glTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096. */ get range(): float64 set range(value: float64) /** The inner angle of the cone in a spotlight. Must be less than or equal to the outer cone angle. * Within this angle, the light is at full brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. When creating a Godot [SpotLight3D], the ratio between the inner and outer cone angles is used to calculate the attenuation of the light. */ get inner_cone_angle(): float64 set inner_cone_angle(value: float64) /** The outer angle of the cone in a spotlight. Must be greater than or equal to the inner angle. * At this angle, the light drops off to zero brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. If this angle is a half turn, then the spotlight emits in all directions. When creating a Godot [SpotLight3D], the outer cone angle is used as the angle of the spotlight. */ get outer_cone_angle(): float64 set outer_cone_angle(value: float64) } /** GLTFMesh represents a glTF mesh. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfmesh.html */ class GLTFMesh extends Resource { constructor(identifier?: any) /** Gets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is `null`. */ get_additional_data(extension_name: StringName): any /** Sets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the second argument can be anything you want. */ set_additional_data(extension_name: StringName, additional_data: any): void /** The original name of the mesh. */ get original_name(): string set original_name(value: string) /** The [ImporterMesh] object representing the mesh itself. */ get mesh(): Object set mesh(value: Object) /** An array of floats representing the blend weights of the mesh. */ get blend_weights(): PackedFloat32Array set blend_weights(value: PackedFloat32Array | float32[]) /** An array of Material objects representing the materials used in the mesh. */ get instance_materials(): GArray set instance_materials(value: GArray) } /** glTF node class. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfnode.html */ class GLTFNode extends Resource { constructor(identifier?: any) /** Appends the given child node index to the [member children] array. */ append_child_index(child_index: int64): void /** Gets additional arbitrary data in this [GLTFNode] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is `null`. */ get_additional_data(extension_name: StringName): any /** Sets additional arbitrary data in this [GLTFNode] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the second argument can be anything you want. */ set_additional_data(extension_name: StringName, additional_data: any): void /** Returns the [NodePath] that this GLTF node will have in the Godot scene tree after being imported. This is useful when importing glTF object model pointers with [GLTFObjectModelProperty], for handling extensions such as `KHR_animation_pointer` or `KHR_interactivity`. * If [param handle_skeletons] is `true`, paths to skeleton bone glTF nodes will be resolved properly. For example, a path that would be `^"A/B/C/Bone1/Bone2/Bone3"` if `false` will become `^"A/B/C/Skeleton3D:Bone3"`. */ get_scene_node_path(gltf_state: GLTFState, handle_skeletons: boolean = true): NodePath /** The original name of the node. */ get original_name(): string set original_name(value: string) /** The index of the parent node in the [GLTFState]. If -1, this node is a root node. */ get parent(): int64 set parent(value: int64) /** How deep into the node hierarchy this node is. A root node will have a height of 0, its children will have a height of 1, and so on. If -1, the height has not been calculated. */ get height(): int64 set height(value: int64) /** The transform of the glTF node relative to its parent. This property is usually unused since the position, rotation, and scale properties are preferred. */ get xform(): Transform3D set xform(value: Transform3D) /** If this glTF node is a mesh, the index of the [GLTFMesh] in the [GLTFState] that describes the mesh's properties. If -1, this node is not a mesh. */ get mesh(): int64 set mesh(value: int64) /** If this glTF node is a camera, the index of the [GLTFCamera] in the [GLTFState] that describes the camera's properties. If -1, this node is not a camera. */ get camera(): int64 set camera(value: int64) /** If this glTF node has a skin, the index of the [GLTFSkin] in the [GLTFState] that describes the skin's properties. If -1, this node does not have a skin. */ get skin(): int64 set skin(value: int64) /** If this glTF node has a skeleton, the index of the [GLTFSkeleton] in the [GLTFState] that describes the skeleton's properties. If -1, this node does not have a skeleton. */ get skeleton(): int64 set skeleton(value: int64) /** The position of the glTF node relative to its parent. */ get position(): Vector3 set position(value: Vector3) /** The rotation of the glTF node relative to its parent. */ get rotation(): Quaternion set rotation(value: Quaternion) /** The scale of the glTF node relative to its parent. */ get scale(): Vector3 set scale(value: Vector3) /** The indices of the child nodes in the [GLTFState]. If this glTF node has no children, this will be an empty array. */ get children(): PackedInt32Array set children(value: PackedInt32Array | int32[]) /** If this glTF node is a light, the index of the [GLTFLight] in the [GLTFState] that describes the light's properties. If -1, this node is not a light. */ get light(): int64 set light(value: int64) } namespace GLTFObjectModelProperty { enum GLTFObjectModelType { /** Unknown or not set object model type. If the object model type is set to this value, the real type still needs to be determined. */ GLTF_OBJECT_MODEL_TYPE_UNKNOWN = 0, /** Object model type "bool". Represented in the glTF JSON as a boolean, and encoded in a [GLTFAccessor] as "SCALAR". When encoded in an accessor, a value of `0` is `false`, and any other value is `true`. */ GLTF_OBJECT_MODEL_TYPE_BOOL = 1, /** Object model type "float". Represented in the glTF JSON as a number, and encoded in a [GLTFAccessor] as "SCALAR". */ GLTF_OBJECT_MODEL_TYPE_FLOAT = 2, /** Object model type "float[lb][rb]". Represented in the glTF JSON as an array of numbers, and encoded in a [GLTFAccessor] as "SCALAR". */ GLTF_OBJECT_MODEL_TYPE_FLOAT_ARRAY = 3, /** Object model type "float2". Represented in the glTF JSON as an array of two numbers, and encoded in a [GLTFAccessor] as "VEC2". */ GLTF_OBJECT_MODEL_TYPE_FLOAT2 = 4, /** Object model type "float3". Represented in the glTF JSON as an array of three numbers, and encoded in a [GLTFAccessor] as "VEC3". */ GLTF_OBJECT_MODEL_TYPE_FLOAT3 = 5, /** Object model type "float4". Represented in the glTF JSON as an array of four numbers, and encoded in a [GLTFAccessor] as "VEC4". */ GLTF_OBJECT_MODEL_TYPE_FLOAT4 = 6, /** Object model type "float2x2". Represented in the glTF JSON as an array of four numbers, and encoded in a [GLTFAccessor] as "MAT2". */ GLTF_OBJECT_MODEL_TYPE_FLOAT2X2 = 7, /** Object model type "float3x3". Represented in the glTF JSON as an array of nine numbers, and encoded in a [GLTFAccessor] as "MAT3". */ GLTF_OBJECT_MODEL_TYPE_FLOAT3X3 = 8, /** Object model type "float4x4". Represented in the glTF JSON as an array of sixteen numbers, and encoded in a [GLTFAccessor] as "MAT4". */ GLTF_OBJECT_MODEL_TYPE_FLOAT4X4 = 9, /** Object model type "int". Represented in the glTF JSON as a number, and encoded in a [GLTFAccessor] as "SCALAR". The range of values is limited to signed integers. For `KHR_interactivity`, only 32-bit integers are supported. */ GLTF_OBJECT_MODEL_TYPE_INT = 10, } } /** Describes how to access a property as defined in the glTF object model. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfobjectmodelproperty.html */ class GLTFObjectModelProperty extends RefCounted { constructor(identifier?: any) /** Appends a [NodePath] to [member node_paths]. This can be used by [GLTFDocumentExtension] classes to define how a glTF object model property maps to a Godot property, or multiple Godot properties. Prefer using [method append_path_to_property] for simple cases. Be sure to also call [method set_types] once (the order does not matter). */ append_node_path(node_path: NodePath | string): void /** High-level wrapper over [method append_node_path] that handles the most common cases. It constructs a new [NodePath] using [param node_path] as a base and appends [param prop_name] to the subpath. Be sure to also call [method set_types] once (the order does not matter). */ append_path_to_property(node_path: NodePath | string, prop_name: StringName): void /** The GLTF accessor type associated with this property's [member object_model_type]. See [member GLTFAccessor.accessor_type] for possible values, and see [enum GLTFObjectModelType] for how the object model type maps to accessor types. */ get_accessor_type(): GLTFAccessor.GLTFAccessorType /** Returns `true` if [member node_paths] is not empty. This is used during import to determine if a [GLTFObjectModelProperty] can handle converting a glTF object model property to a Godot property. */ has_node_paths(): boolean /** Returns `true` if [member json_pointers] is not empty. This is used during export to determine if a [GLTFObjectModelProperty] can handle converting a Godot property to a glTF object model property. */ has_json_pointers(): boolean /** Sets the [member variant_type] and [member object_model_type] properties. This is a convenience method to set both properties at once, since they are almost always known at the same time. This method should be called once. Calling it again with the same values will have no effect. */ set_types(variant_type: Variant.Type, obj_model_type: GLTFObjectModelProperty.GLTFObjectModelType): void /** If set, this [Expression] will be used to convert the property value from the glTF object model to the value expected by the Godot property. This is useful when the glTF object model uses a different unit system, or when the data needs to be transformed in some way. If `null`, the value will be copied as-is. */ get gltf_to_godot_expression(): Expression set gltf_to_godot_expression(value: Expression) /** If set, this [Expression] will be used to convert the property value from the Godot property to the value expected by the glTF object model. This is useful when the glTF object model uses a different unit system, or when the data needs to be transformed in some way. If `null`, the value will be copied as-is. */ get godot_to_gltf_expression(): Expression set godot_to_gltf_expression(value: Expression) /** An array of [NodePath]s that point to a property, or multiple properties, in the Godot scene tree. On import, this will either be set by [GLTFDocument], or by a [GLTFDocumentExtension] class. For simple cases, use [method append_path_to_property] to add properties to this array. * In most cases [member node_paths] will only have one item, but in some cases a single glTF JSON pointer will map to multiple Godot properties. For example, a [GLTFCamera] or [GLTFLight] used on multiple glTF nodes will be represented by multiple Godot nodes. */ get node_paths(): GArray set node_paths(value: GArray) /** The type of data stored in the glTF file as defined by the object model. This is a superset of the available accessor types, and determines the accessor type. See [enum GLTFObjectModelType] for possible values. */ get object_model_type(): int64 set object_model_type(value: int64) /** The glTF object model JSON pointers used to identify the property in the glTF object model. In most cases, there will be only one item in this array, but niche cases may require multiple pointers. The items are themselves arrays which represent the JSON pointer split into its components. */ get json_pointers(): PackedStringArray set json_pointers(value: PackedStringArray | string[]) /** The type of data stored in the Godot property. This is the type of the property that the [member node_paths] point to. */ get variant_type(): int64 set variant_type(value: int64) } /** Represents a glTF physics body. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfphysicsbody.html */ class GLTFPhysicsBody extends Resource { constructor(identifier?: any) /** Creates a new GLTFPhysicsBody instance from the given Godot [CollisionObject3D] node. */ static from_node(body_node: CollisionObject3D): GLTFPhysicsBody /** Converts this GLTFPhysicsBody instance into a Godot [CollisionObject3D] node. */ to_node(): CollisionObject3D /** Creates a new GLTFPhysicsBody instance by parsing the given [Dictionary] in the `OMI_physics_body` glTF extension format. */ static from_dictionary(dictionary: GDictionary): GLTFPhysicsBody /** Serializes this GLTFPhysicsBody instance into a [Dictionary]. It will be in the format expected by the `OMI_physics_body` glTF extension. */ to_dictionary(): GDictionary /** The type of the body. When importing, this controls what type of [CollisionObject3D] node Godot should generate. Valid values are "static", "animatable", "character", "rigid", "vehicle", and "trigger". When exporting, this will be squashed down to one of "static", "kinematic", or "dynamic" motion types, or the "trigger" property. */ get body_type(): string set body_type(value: string) /** The mass of the physics body, in kilograms. This is only used when the body type is "rigid" or "vehicle". */ get mass(): float64 set mass(value: float64) /** The linear velocity of the physics body, in meters per second. This is only used when the body type is "rigid" or "vehicle". */ get linear_velocity(): Vector3 set linear_velocity(value: Vector3) /** The angular velocity of the physics body, in radians per second. This is only used when the body type is "rigid" or "vehicle". */ get angular_velocity(): Vector3 set angular_velocity(value: Vector3) /** The center of mass of the body, in meters. This is in local space relative to the body. By default, the center of the mass is the body's origin. */ get center_of_mass(): Vector3 set center_of_mass(value: Vector3) /** The inertia strength of the physics body, in kilogram meter squared (kg⋅m²). This represents the inertia around the principle axes, the diagonal of the inertia tensor matrix. This is only used when the body type is "rigid" or "vehicle". * When converted to a Godot [RigidBody3D] node, if this value is zero, then the inertia will be calculated automatically. */ get inertia_diagonal(): Vector3 set inertia_diagonal(value: Vector3) /** The inertia orientation of the physics body. This defines the rotation of the inertia's principle axes relative to the object's local axes. This is only used when the body type is "rigid" or "vehicle" and [member inertia_diagonal] is set to a non-zero value. */ get inertia_orientation(): Quaternion set inertia_orientation(value: Quaternion) /** The inertia tensor of the physics body, in kilogram meter squared (kg⋅m²). This is only used when the body type is "rigid" or "vehicle". * When converted to a Godot [RigidBody3D] node, if this value is zero, then the inertia will be calculated automatically. */ get inertia_tensor(): Basis set inertia_tensor(value: Basis) } /** Represents a glTF physics shape. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfphysicsshape.html */ class GLTFPhysicsShape extends Resource { constructor(identifier?: any) /** Creates a new GLTFPhysicsShape instance from the given Godot [CollisionShape3D] node. */ static from_node(shape_node: CollisionShape3D): GLTFPhysicsShape /** Converts this GLTFPhysicsShape instance into a Godot [CollisionShape3D] node. */ to_node(cache_shapes: boolean = false): CollisionShape3D /** Creates a new GLTFPhysicsShape instance from the given Godot [Shape3D] resource. */ static from_resource(shape_resource: Shape3D): GLTFPhysicsShape /** Converts this GLTFPhysicsShape instance into a Godot [Shape3D] resource. */ to_resource(cache_shapes: boolean = false): Shape3D /** Creates a new GLTFPhysicsShape instance by parsing the given [Dictionary]. */ static from_dictionary(dictionary: GDictionary): GLTFPhysicsShape /** Serializes this GLTFPhysicsShape instance into a [Dictionary] in the format defined by `OMI_physics_shape`. */ to_dictionary(): GDictionary /** The type of shape this shape represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh". */ get shape_type(): string set shape_type(value: string) /** The size of the shape, in meters. This is only used when the shape type is "box", and it represents the "diameter" of the box. This value should not be negative. */ get size(): Vector3 set size(value: Vector3) /** The radius of the shape, in meters. This is only used when the shape type is "capsule", "cylinder", or "sphere". This value should not be negative. */ get radius(): float64 set radius(value: float64) /** The height of the shape, in meters. This is only used when the shape type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius. */ get height(): float64 set height(value: float64) /** If `true`, indicates that this shape is a trigger. For Godot, this means that the shape should be a child of an Area3D node. * This is the only variable not used in the [method to_node] method, it's intended to be used alongside when deciding where to add the generated node as a child. */ get is_trigger(): boolean set is_trigger(value: boolean) /** The index of the shape's mesh in the glTF file. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). */ get mesh_index(): int64 set mesh_index(value: int64) /** The [ImporterMesh] resource of the shape. This is only used when the shape type is "hull" (convex hull) or "trimesh" (concave trimesh). */ get importer_mesh(): ImporterMesh set importer_mesh(value: ImporterMesh) } /** @link https://docs.godotengine.org/en/4.4/classes/class_gltfskeleton.html */ class GLTFSkeleton extends Resource { constructor(identifier?: any) get_godot_skeleton(): Skeleton3D get_bone_attachment_count(): int64 get_bone_attachment(idx: int64): BoneAttachment3D get joints(): PackedInt32Array set joints(value: PackedInt32Array | int32[]) get roots(): PackedInt32Array set roots(value: PackedInt32Array | int32[]) get unique_names(): GArray set unique_names(value: GArray) get godot_bone_node(): GDictionary set godot_bone_node(value: GDictionary) } /** @link https://docs.godotengine.org/en/4.4/classes/class_gltfskin.html */ class GLTFSkin extends Resource { constructor(identifier?: any) get skin_root(): int64 set skin_root(value: int64) get joints_original(): PackedInt32Array set joints_original(value: PackedInt32Array | int32[]) get inverse_binds(): GArray set inverse_binds(value: GArray) get joints(): PackedInt32Array set joints(value: PackedInt32Array | int32[]) get non_joints(): PackedInt32Array set non_joints(value: PackedInt32Array | int32[]) get roots(): PackedInt32Array set roots(value: PackedInt32Array | int32[]) get skeleton(): int64 set skeleton(value: int64) get joint_i_to_bone_i(): GDictionary set joint_i_to_bone_i(value: GDictionary) get joint_i_to_name(): GDictionary set joint_i_to_name(value: GDictionary) get godot_skin(): Skin set godot_skin(value: Skin) } /** Archived glTF extension for specular/glossy materials. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfspecgloss.html */ class GLTFSpecGloss extends Resource { constructor(identifier?: any) /** The diffuse texture. */ get diffuse_img(): Object set diffuse_img(value: Object) /** The reflected diffuse factor of the material. */ get diffuse_factor(): Color set diffuse_factor(value: Color) /** The glossiness or smoothness of the material. */ get gloss_factor(): float64 set gloss_factor(value: float64) /** The specular RGB color of the material. The alpha channel is unused. */ get specular_factor(): Color set specular_factor(value: Color) /** The specular-glossiness texture. */ get spec_gloss_img(): Object set spec_gloss_img(value: Object) } /** Represents all data of a glTF file. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltfstate.html */ class GLTFState extends Resource { /** Discards all embedded textures and uses untextured materials. */ static readonly HANDLE_BINARY_DISCARD_TEXTURES = 0 /** Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime. */ static readonly HANDLE_BINARY_EXTRACT_TEXTURES = 1 /** Embeds textures VRAM compressed with Basis Universal into the generated scene. */ static readonly HANDLE_BINARY_EMBED_AS_BASISU = 2 /** Embeds textures compressed losslessly into the generated scene, matching old behavior. */ static readonly HANDLE_BINARY_EMBED_AS_UNCOMPRESSED = 3 constructor(identifier?: any) /** Appends an extension to the list of extensions used by this glTF file during serialization. If [param required] is `true`, the extension will also be added to the list of required extensions. Do not run this in [method GLTFDocumentExtension._export_post], as that stage is too late to add extensions. The final list is sorted alphabetically. */ add_used_extension(extension_name: string, required: boolean): void /** Appends the given byte array data to the buffers and creates a [GLTFBufferView] for it. The index of the destination [GLTFBufferView] is returned. If [param deduplication] is `true`, the buffers will first be searched for duplicate data, otherwise new bytes will always be appended. */ append_data_to_buffers(data: PackedByteArray | byte[] | ArrayBuffer, deduplication: boolean): int64 /** Append the given [GLTFNode] to the state, and return its new index. This can be used to export one Godot node as multiple glTF nodes, or inject new glTF nodes at import time. On import, this must be called before [method GLTFDocumentExtension._generate_scene_node] finishes for the parent node. On export, this must be called before [method GLTFDocumentExtension._export_node] runs for the parent node. * The [param godot_scene_node] parameter is the Godot scene node that corresponds to this glTF node. This is highly recommended to be set to a valid node, but may be `null` if there is no corresponding Godot scene node. One Godot scene node may be used for multiple glTF nodes, so if exporting multiple glTF nodes for one Godot scene node, use the same Godot scene node for each. * The [param parent_node_index] parameter is the index of the parent [GLTFNode] in the state. If `-1`, the node will be a root node, otherwise the new node will be added to the parent's list of children. The index will also be written to the [member GLTFNode.parent] property of the new node. */ append_gltf_node(gltf_node: GLTFNode, godot_scene_node: Node, parent_node_index: int64): int64 /** Returns the number of [AnimationPlayer] nodes in this [GLTFState]. These nodes are only used during the export process when converting Godot [AnimationPlayer] nodes to glTF animations. */ get_animation_players_count(idx: int64): int64 /** Returns the [AnimationPlayer] node with the given index. These nodes are only used during the export process when converting Godot [AnimationPlayer] nodes to glTF animations. */ get_animation_player(idx: int64): AnimationPlayer /** Returns the Godot scene node that corresponds to the same index as the [GLTFNode] it was generated from. This is the inverse of [method get_node_index]. Useful during the import process. * * **Note:** Not every [GLTFNode] will have a scene node generated, and not every generated scene node will have a corresponding [GLTFNode]. If there is no scene node for this [GLTFNode] index, `null` is returned. */ get_scene_node(idx: int64): Node /** Returns the index of the [GLTFNode] corresponding to this Godot scene node. This is the inverse of [method get_scene_node]. Useful during the export process. * * **Note:** Not every Godot scene node will have a corresponding [GLTFNode], and not every [GLTFNode] will have a scene node generated. If there is no [GLTFNode] index for this scene node, `-1` is returned. */ get_node_index(scene_node: Node): int64 /** Gets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is `null`. */ get_additional_data(extension_name: StringName): any /** Sets additional arbitrary data in this [GLTFState] instance. This can be used to keep per-file state data in [GLTFDocumentExtension] classes, which is important because they are stateless. * The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the glTF file), and the second argument can be anything you want. */ set_additional_data(extension_name: StringName, additional_data: any): void /** The original raw JSON document corresponding to this GLTFState. */ get json(): GDictionary set json(value: GDictionary) get major_version(): int64 set major_version(value: int64) get minor_version(): int64 set minor_version(value: int64) /** The copyright string in the asset header of the glTF file. This is set during import if present and export if non-empty. See the glTF asset header documentation for more information. */ get copyright(): string set copyright(value: string) /** The binary buffer attached to a .glb file. */ get glb_data(): PackedByteArray set glb_data(value: PackedByteArray | byte[] | ArrayBuffer) get use_named_skin_binds(): boolean set use_named_skin_binds(value: boolean) get nodes(): GArray set nodes(value: GArray) get buffers(): GArray set buffers(value: GArray) get buffer_views(): GArray set buffer_views(value: GArray) get accessors(): GArray set accessors(value: GArray) get meshes(): GArray set meshes(value: GArray) get materials(): GArray set materials(value: GArray) /** The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the glTF file. */ get scene_name(): string set scene_name(value: string) /** The folder path associated with this glTF data. This is used to find other files the glTF file references, like images or binary buffers. This will be set during import when appending from a file, and will be set during export when writing to a file. */ get base_path(): string set base_path(value: string) /** The file name associated with this glTF data. If it ends with `.gltf`, this is text-based glTF, otherwise this is binary GLB. This will be set during import when appending from a file, and will be set during export when writing to a file. If writing to a buffer, this will be an empty string. */ get filename(): string set filename(value: string) /** The root nodes of the glTF file. Typically, a glTF file will only have one scene, and therefore one root node. However, a glTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Godot scene. */ get root_nodes(): PackedInt32Array set root_nodes(value: PackedInt32Array | int32[]) get textures(): GArray set textures(value: GArray) get texture_samplers(): GArray set texture_samplers(value: GArray) get images(): GArray set images(value: GArray) get skins(): GArray set skins(value: GArray) get cameras(): GArray set cameras(value: GArray) get lights(): GArray set lights(value: GArray) get unique_names(): GArray set unique_names(value: GArray) get unique_animation_names(): GArray set unique_animation_names(value: GArray) get skeletons(): GArray set skeletons(value: GArray) get create_animations(): boolean set create_animations(value: boolean) /** If `true`, forces all GLTFNodes in the document to be bones of a single [Skeleton3D] Godot node. */ get import_as_skeleton_bones(): boolean set import_as_skeleton_bones(value: boolean) get animations(): GArray set animations(value: GArray) get handle_binary_image(): int64 set handle_binary_image(value: int64) /** The baking fps of the animation for either import or export. */ get bake_fps(): float64 set bake_fps(value: float64) } /** GLTFTexture represents a texture in a glTF file. * * @link https://docs.godotengine.org/en/4.4/classes/class_gltftexture.html */ class GLTFTexture extends Resource { constructor(identifier?: any) /** The index of the image associated with this texture, see [method GLTFState.get_images]. If -1, then this texture does not have an image assigned. */ get src_image(): int64 set src_image(value: int64) /** ID of the texture sampler to use when sampling the image. If -1, then the default texture sampler is used (linear filtering, and repeat wrapping in both axes). */ get sampler(): int64 set sampler(value: int64) } /** Represents a glTF texture sampler * * @link https://docs.godotengine.org/en/4.4/classes/class_gltftexturesampler.html */ class GLTFTextureSampler extends Resource { constructor(identifier?: any) /** Texture's magnification filter, used when texture appears larger on screen than the source image. */ get mag_filter(): int64 set mag_filter(value: int64) /** Texture's minification filter, used when the texture appears smaller on screen than the source image. */ get min_filter(): int64 set min_filter(value: int64) /** Wrapping mode to use for S-axis (horizontal) texture coordinates. */ get wrap_s(): int64 set wrap_s(value: int64) /** Wrapping mode to use for T-axis (vertical) texture coordinates. */ get wrap_t(): int64 set wrap_t(value: int64) } namespace GPUParticles2D { enum DrawOrder { /** Particles are drawn in the order emitted. */ DRAW_ORDER_INDEX = 0, /** Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. */ DRAW_ORDER_LIFETIME = 1, /** Particles are drawn in reverse order of remaining lifetime. In other words, the particle with the lowest lifetime is drawn at the front. */ DRAW_ORDER_REVERSE_LIFETIME = 2, } enum EmitFlags { /** Particle starts at the specified position. */ EMIT_FLAG_POSITION = 1, /** Particle starts with specified rotation and scale. */ EMIT_FLAG_ROTATION_SCALE = 2, /** Particle starts with the specified velocity vector, which defines the emission direction and speed. */ EMIT_FLAG_VELOCITY = 4, /** Particle starts with specified color. */ EMIT_FLAG_COLOR = 8, /** Particle starts with specified `CUSTOM` data. */ EMIT_FLAG_CUSTOM = 16, } } /** A 2D particle emitter. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticles2d.html */ class GPUParticles2D = Record> extends Node2D { constructor(identifier?: any) /** Requests the particles to process for extra process time during a single frame. * Useful for particle playback, if used in combination with [member use_fixed_seed] or by calling [method restart] with parameter `keep_seed` set to `true`. */ request_particles_process(process_time: float64): void /** Returns a rectangle containing the positions of all existing particles. * * **Note:** When using threaded rendering this method synchronizes the rendering thread. Calling it often may have a negative impact on performance. */ capture_rect(): Rect2 /** Restarts the particle emission cycle, clearing existing particles. To avoid particles vanishing from the viewport, wait for the [signal finished] signal before calling. * * **Note:** The [signal finished] signal is only emitted by [member one_shot] emitters. * If [param keep_seed] is `true`, the current random seed will be preserved. Useful for seeking and playback. */ restart(keep_seed: boolean = false): void /** Emits a single particle. Whether [param xform], [param velocity], [param color] and [param custom] are applied depends on the value of [param flags]. See [enum EmitFlags]. * The default ParticleProcessMaterial will overwrite [param color] and use the contents of [param custom] as `(rotation, age, animation, lifetime)`. * * **Note:** [method emit_particle] is only supported on the Forward+ and Mobile rendering methods, not Compatibility. */ emit_particle(xform: Transform2D, velocity: Vector2, color: Color, custom: Color, flags: int64): void /** Sets this node's properties to match a given [CPUParticles2D] node. */ convert_from_particles(particles: Node): void /** If `true`, particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is `true` setting [member emitting] to `true` will not restart the emission cycle unless all active particles have finished processing. Use the [signal finished] signal to be notified once all active particles finish processing. * * **Note:** For [member one_shot] emitters, due to the particles being computed on the GPU, there may be a short period after receiving the [signal finished] signal during which setting this to `true` will not restart the emission cycle. * **Tip:** If your [member one_shot] emitter needs to immediately restart emitting particles once [signal finished] signal is received, consider calling [method restart] instead of setting [member emitting]. */ get emitting(): boolean set emitting(value: boolean) /** The number of particles to emit in one emission cycle. The effective emission rate is `(amount * amount_ratio) / lifetime` particles per second. Higher values will increase GPU requirements, even if not all particles are visible at a given time or if [member amount_ratio] is decreased. * * **Note:** Changing this value will cause the particle system to restart. To avoid this, change [member amount_ratio] instead. */ get amount(): int64 set amount(value: int64) /** The ratio of particles that should actually be emitted. If set to a value lower than `1.0`, this will set the amount of emitted particles throughout the lifetime to `amount * amount_ratio`. Unlike changing [member amount], changing [member amount_ratio] while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. [member amount_ratio] can be used to create effects that make the number of emitted particles vary over time. * * **Note:** Reducing the [member amount_ratio] has no performance benefit, since resources need to be allocated and processed for the total [member amount] of particles regardless of the [member amount_ratio]. If you don't intend to change the number of particles emitted while the particles are emitting, make sure [member amount_ratio] is set to `1` and change [member amount] to your liking instead. */ get amount_ratio(): float64 set amount_ratio(value: float64) /** Path to another [GPUParticles2D] node that will be used as a subemitter (see [member ParticleProcessMaterial.sub_emitter_mode]). Subemitters can be used to achieve effects such as fireworks, sparks on collision, bubbles popping into water drops, and more. * * **Note:** When [member sub_emitter] is set, the target [GPUParticles2D] node will no longer emit particles on its own. */ get sub_emitter(): NodePath set sub_emitter(value: NodePath | string) /** Particle texture. If `null`, particles will be squares with a size of 1×1 pixels. * * **Note:** To use a flipbook texture, assign a new [CanvasItemMaterial] to the [GPUParticles2D]'s [member CanvasItem.material] property, then enable [member CanvasItemMaterial.particles_animation] and set [member CanvasItemMaterial.particles_anim_h_frames], [member CanvasItemMaterial.particles_anim_v_frames], and [member CanvasItemMaterial.particles_anim_loop] to match the flipbook texture. */ get texture(): Texture2D set texture(value: Texture2D) /** The amount of time each particle will exist (in seconds). The effective emission rate is `(amount * amount_ratio) / lifetime` particles per second. */ get lifetime(): float64 set lifetime(value: float64) /** Causes all the particles in this node to interpolate towards the end of their lifetime. * * **Note:** This only works when used with a [ParticleProcessMaterial]. It needs to be manually implemented for custom process shaders. */ get interp_to_end(): float64 set interp_to_end(value: float64) /** If `true`, only one emission cycle occurs. If set `true` during a cycle, emission will stop at the cycle's end. */ get one_shot(): boolean set one_shot(value: boolean) /** Particle system starts as if it had already run for this many seconds. * * **Note:** This can be very expensive if set to a high number as it requires running the particle shader a number of times equal to the [member fixed_fps] (or 30, if [member fixed_fps] is 0) for every second. In extreme cases it can even lead to a GPU crash due to the volume of work done in a single frame. */ get preprocess(): float64 set preprocess(value: float64) /** Particle system's running speed scaling ratio. A value of `0` can be used to pause the particles. */ get speed_scale(): float64 set speed_scale(value: float64) /** How rapidly particles in an emission cycle are emitted. If greater than `0`, there will be a gap in emissions before the next cycle begins. */ get explosiveness(): float64 set explosiveness(value: float64) /** Emission lifetime randomness ratio. */ get randomness(): float64 set randomness(value: float64) /** If `true`, particles will use the same seed for every simulation using the seed defined in [member seed]. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode. */ get use_fixed_seed(): boolean set use_fixed_seed(value: boolean) /** Sets the random seed used by the particle system. Only effective if [member use_fixed_seed] is `true`. */ get seed(): int64 set seed(value: int64) /** The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. */ get fixed_fps(): int64 set fixed_fps(value: int64) /** Enables particle interpolation, which makes the particle movement smoother when their [member fixed_fps] is lower than the screen refresh rate. */ get interpolate(): boolean set interpolate(value: boolean) /** If `true`, results in fractional delta calculation which has a smoother particles display effect. */ get fract_delta(): boolean set fract_delta(value: boolean) /** Multiplier for particle's collision radius. `1.0` corresponds to the size of the sprite. If particles appear to sink into the ground when colliding, increase this value. If particles appear to float when colliding, decrease this value. Only effective if [member ParticleProcessMaterial.collision_mode] is [constant ParticleProcessMaterial.COLLISION_RIGID] or [constant ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT]. * * **Note:** Particles always have a spherical collision shape. */ get collision_base_size(): float64 set collision_base_size(value: float64) /** The [Rect2] that determines the node's region which needs to be visible on screen for the particle system to be active. * Grow the rect if particles suddenly appear/disappear when the node enters/exits the screen. The [Rect2] can be grown via code or with the **Particles → Generate Visibility Rect** editor tool. */ get visibility_rect(): Rect2 set visibility_rect(value: Rect2) /** If `true`, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [GPUParticles2D] node (and its parents) when it is moved or rotated. If `false`, particles use global coordinates; they will not move or rotate along the [GPUParticles2D] node (and its parents) when it is moved or rotated. */ get local_coords(): boolean set local_coords(value: boolean) /** Particle draw order. Uses [enum DrawOrder] values. */ get draw_order(): int64 set draw_order(value: int64) /** If `true`, enables particle trails using a mesh skinning system. * * **Note:** Unlike [GPUParticles3D], the number of trail sections and subdivisions is set with the [member trail_sections] and [member trail_section_subdivisions] properties. */ get trail_enabled(): boolean set trail_enabled(value: boolean) /** The amount of time the particle's trail should represent (in seconds). Only effective if [member trail_enabled] is `true`. */ get trail_lifetime(): float64 set trail_lifetime(value: float64) /** The number of sections to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also [member trail_section_subdivisions]. Only effective if [member trail_enabled] is `true`. */ get trail_sections(): int64 set trail_sections(value: int64) /** The number of subdivisions to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also [member trail_sections]. Only effective if [member trail_enabled] is `true`. */ get trail_section_subdivisions(): int64 set trail_section_subdivisions(value: int64) /** [Material] for processing particles. Can be a [ParticleProcessMaterial] or a [ShaderMaterial]. */ get process_material(): ParticleProcessMaterial | ShaderMaterial set process_material(value: ParticleProcessMaterial | ShaderMaterial) /** Emitted when all active particles have finished processing. To immediately restart the emission cycle, call [method restart]. * This signal is never emitted when [member one_shot] is disabled, as particles will be emitted and processed continuously. * * **Note:** For [member one_shot] emitters, due to the particles being computed on the GPU, there may be a short period after receiving the signal during which setting [member emitting] to `true` will not restart the emission cycle. This delay is avoided by instead calling [method restart]. */ readonly finished: Signal0 } class GPUParticles2DEditorPlugin = Record> extends Particles2DEditorPlugin { constructor(identifier?: any) } namespace GPUParticles3D { enum DrawOrder { /** Particles are drawn in the order emitted. */ DRAW_ORDER_INDEX = 0, /** Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front. */ DRAW_ORDER_LIFETIME = 1, /** Particles are drawn in reverse order of remaining lifetime. In other words, the particle with the lowest lifetime is drawn at the front. */ DRAW_ORDER_REVERSE_LIFETIME = 2, /** Particles are drawn in order of depth. */ DRAW_ORDER_VIEW_DEPTH = 3, } enum EmitFlags { /** Particle starts at the specified position. */ EMIT_FLAG_POSITION = 1, /** Particle starts with specified rotation and scale. */ EMIT_FLAG_ROTATION_SCALE = 2, /** Particle starts with the specified velocity vector, which defines the emission direction and speed. */ EMIT_FLAG_VELOCITY = 4, /** Particle starts with specified color. */ EMIT_FLAG_COLOR = 8, /** Particle starts with specified `CUSTOM` data. */ EMIT_FLAG_CUSTOM = 16, } enum TransformAlign { TRANSFORM_ALIGN_DISABLED = 0, TRANSFORM_ALIGN_Z_BILLBOARD = 1, TRANSFORM_ALIGN_Y_TO_VELOCITY = 2, TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY = 3, } } /** A 3D particle emitter. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticles3d.html */ class GPUParticles3D = Record> extends GeometryInstance3D { /** Maximum number of draw passes supported. */ static readonly MAX_DRAW_PASSES = 4 constructor(identifier?: any) /** Sets the [Mesh] that is drawn at index [param pass]. */ set_draw_pass_mesh(pass: int64, mesh: Mesh): void /** Returns the [Mesh] that is drawn at index [param pass]. */ get_draw_pass_mesh(pass: int64): Mesh /** Restarts the particle emission cycle, clearing existing particles. To avoid particles vanishing from the viewport, wait for the [signal finished] signal before calling. * * **Note:** The [signal finished] signal is only emitted by [member one_shot] emitters. * If [param keep_seed] is `true`, the current random seed will be preserved. Useful for seeking and playback. */ restart(keep_seed: boolean = false): void /** Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. */ capture_aabb(): AABB /** Emits a single particle. Whether [param xform], [param velocity], [param color] and [param custom] are applied depends on the value of [param flags]. See [enum EmitFlags]. * The default ParticleProcessMaterial will overwrite [param color] and use the contents of [param custom] as `(rotation, age, animation, lifetime)`. * * **Note:** [method emit_particle] is only supported on the Forward+ and Mobile rendering methods, not Compatibility. */ emit_particle(xform: Transform3D, velocity: Vector3, color: Color, custom: Color, flags: int64): void /** Sets this node's properties to match a given [CPUParticles3D] node. */ convert_from_particles(particles: Node): void /** Requests the particles to process for extra process time during a single frame. * Useful for particle playback, if used in combination with [member use_fixed_seed] or by calling [method restart] with parameter `keep_seed` set to `true`. */ request_particles_process(process_time: float64): void /** If `true`, particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is `true` setting [member emitting] to `true` will not restart the emission cycle unless all active particles have finished processing. Use the [signal finished] signal to be notified once all active particles finish processing. * * **Note:** For [member one_shot] emitters, due to the particles being computed on the GPU, there may be a short period after receiving the [signal finished] signal during which setting this to `true` will not restart the emission cycle. * **Tip:** If your [member one_shot] emitter needs to immediately restart emitting particles once [signal finished] signal is received, consider calling [method restart] instead of setting [member emitting]. */ get emitting(): boolean set emitting(value: boolean) /** The number of particles to emit in one emission cycle. The effective emission rate is `(amount * amount_ratio) / lifetime` particles per second. Higher values will increase GPU requirements, even if not all particles are visible at a given time or if [member amount_ratio] is decreased. * * **Note:** Changing this value will cause the particle system to restart. To avoid this, change [member amount_ratio] instead. */ get amount(): int64 set amount(value: int64) /** The ratio of particles that should actually be emitted. If set to a value lower than `1.0`, this will set the amount of emitted particles throughout the lifetime to `amount * amount_ratio`. Unlike changing [member amount], changing [member amount_ratio] while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. [member amount_ratio] can be used to create effects that make the number of emitted particles vary over time. * * **Note:** Reducing the [member amount_ratio] has no performance benefit, since resources need to be allocated and processed for the total [member amount] of particles regardless of the [member amount_ratio]. If you don't intend to change the number of particles emitted while the particles are emitting, make sure [member amount_ratio] is set to `1` and change [member amount] to your liking instead. */ get amount_ratio(): float64 set amount_ratio(value: float64) /** Path to another [GPUParticles3D] node that will be used as a subemitter (see [member ParticleProcessMaterial.sub_emitter_mode]). Subemitters can be used to achieve effects such as fireworks, sparks on collision, bubbles popping into water drops, and more. * * **Note:** When [member sub_emitter] is set, the target [GPUParticles3D] node will no longer emit particles on its own. */ get sub_emitter(): NodePath set sub_emitter(value: NodePath | string) /** The amount of time each particle will exist (in seconds). The effective emission rate is `(amount * amount_ratio) / lifetime` particles per second. */ get lifetime(): float64 set lifetime(value: float64) /** Causes all the particles in this node to interpolate towards the end of their lifetime. * * **Note:** This only works when used with a [ParticleProcessMaterial]. It needs to be manually implemented for custom process shaders. */ get interp_to_end(): float64 set interp_to_end(value: float64) /** If `true`, only the number of particles equal to [member amount] will be emitted. */ get one_shot(): boolean set one_shot(value: boolean) /** Amount of time to preprocess the particles before animation starts. Lets you start the animation some time after particles have started emitting. * * **Note:** This can be very expensive if set to a high number as it requires running the particle shader a number of times equal to the [member fixed_fps] (or 30, if [member fixed_fps] is 0) for every second. In extreme cases it can even lead to a GPU crash due to the volume of work done in a single frame. */ get preprocess(): float64 set preprocess(value: float64) /** Speed scaling ratio. A value of `0` can be used to pause the particles. */ get speed_scale(): float64 set speed_scale(value: float64) /** Time ratio between each emission. If `0`, particles are emitted continuously. If `1`, all particles are emitted simultaneously. */ get explosiveness(): float64 set explosiveness(value: float64) /** Emission randomness ratio. */ get randomness(): float64 set randomness(value: float64) /** If `true`, particles will use the same seed for every simulation using the seed defined in [member seed]. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode. */ get use_fixed_seed(): boolean set use_fixed_seed(value: boolean) /** Sets the random seed used by the particle system. Only effective if [member use_fixed_seed] is `true`. */ get seed(): int64 set seed(value: int64) /** The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. */ get fixed_fps(): int64 set fixed_fps(value: int64) /** Enables particle interpolation, which makes the particle movement smoother when their [member fixed_fps] is lower than the screen refresh rate. */ get interpolate(): boolean set interpolate(value: boolean) /** If `true`, results in fractional delta calculation which has a smoother particles display effect. */ get fract_delta(): boolean set fract_delta(value: boolean) /** The base diameter for particle collision in meters. If particles appear to sink into the ground when colliding, increase this value. If particles appear to float when colliding, decrease this value. Only effective if [member ParticleProcessMaterial.collision_mode] is [constant ParticleProcessMaterial.COLLISION_RIGID] or [constant ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT]. * * **Note:** Particles always have a spherical collision shape. */ get collision_base_size(): float64 set collision_base_size(value: float64) /** The [AABB] that determines the node's region which needs to be visible on screen for the particle system to be active. [member GeometryInstance3D.extra_cull_margin] is added on each of the AABB's axes. Particle collisions and attraction will only occur within this area. * Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The [AABB] can be grown via code or with the **Particles → Generate AABB** editor tool. * * **Note:** [member visibility_aabb] is overridden by [member GeometryInstance3D.custom_aabb] if that property is set to a non-default value. */ get visibility_aabb(): AABB set visibility_aabb(value: AABB) /** If `true`, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [GPUParticles3D] node (and its parents) when it is moved or rotated. If `false`, particles use global coordinates; they will not move or rotate along the [GPUParticles3D] node (and its parents) when it is moved or rotated. */ get local_coords(): boolean set local_coords(value: boolean) /** Particle draw order. Uses [enum DrawOrder] values. * * **Note:** [constant DRAW_ORDER_INDEX] is the only option that supports motion vectors for effects like TAA. It is suggested to use this draw order if the particles are opaque to fix ghosting artifacts. */ get draw_order(): int64 set draw_order(value: int64) get transform_align(): int64 set transform_align(value: int64) /** If `true`, enables particle trails using a mesh skinning system. Designed to work with [RibbonTrailMesh] and [TubeTrailMesh]. * * **Note:** [member BaseMaterial3D.use_particle_trails] must also be enabled on the particle mesh's material. Otherwise, setting [member trail_enabled] to `true` will have no effect. * * **Note:** Unlike [GPUParticles2D], the number of trail sections and subdivisions is set in the [RibbonTrailMesh] or the [TubeTrailMesh]'s properties. */ get trail_enabled(): boolean set trail_enabled(value: boolean) /** The amount of time the particle's trail should represent (in seconds). Only effective if [member trail_enabled] is `true`. */ get trail_lifetime(): float64 set trail_lifetime(value: float64) /** [Material] for processing particles. Can be a [ParticleProcessMaterial] or a [ShaderMaterial]. */ get process_material(): ParticleProcessMaterial | ShaderMaterial set process_material(value: ParticleProcessMaterial | ShaderMaterial) /** The number of draw passes when rendering particles. */ get draw_passes(): int64 set draw_passes(value: int64) /** [Mesh] that is drawn for the first draw pass. */ get draw_pass_1(): Mesh set draw_pass_1(value: Mesh) /** [Mesh] that is drawn for the second draw pass. */ get draw_pass_2(): Mesh set draw_pass_2(value: Mesh) /** [Mesh] that is drawn for the third draw pass. */ get draw_pass_3(): Mesh set draw_pass_3(value: Mesh) /** [Mesh] that is drawn for the fourth draw pass. */ get draw_pass_4(): Mesh set draw_pass_4(value: Mesh) get draw_skin(): Skin set draw_skin(value: Skin) /** Emitted when all active particles have finished processing. To immediately restart the emission cycle, call [method restart]. * This signal is never emitted when [member one_shot] is disabled, as particles will be emitted and processed continuously. * * **Note:** For [member one_shot] emitters, due to the particles being computed on the GPU, there may be a short period after receiving the signal during which setting [member emitting] to `true` will not restart the emission cycle. This delay is avoided by instead calling [method restart]. */ readonly finished: Signal0 } class GPUParticles3DEditorPlugin = Record> extends Particles3DEditorPlugin { constructor(identifier?: any) } class GPUParticles3DGizmoPlugin extends EditorNode3DGizmoPlugin { constructor(identifier?: any) } /** Abstract base class for 3D particle attractors. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlesattractor3d.html */ class GPUParticlesAttractor3D = Record> extends VisualInstance3D { constructor(identifier?: any) /** Adjusts the strength of the attractor. If [member strength] is negative, particles will be pushed in the opposite direction. Particles will be pushed *away* from the attractor's origin if [member directionality] is `0.0`, or towards local +Z if [member directionality] is greater than `0.0`. */ get strength(): float64 set strength(value: float64) /** The particle attractor's attenuation. Higher values result in more gradual pushing of particles as they come closer to the attractor's origin. Zero or negative values will cause particles to be pushed very fast as soon as the touch the attractor's edges. */ get attenuation(): float64 set attenuation(value: float64) /** Adjusts how directional the attractor is. At `0.0`, the attractor is not directional at all: it will attract particles towards its center. At `1.0`, the attractor is fully directional: particles will always be pushed towards local -Z (or +Z if [member strength] is negative). * * **Note:** If [member directionality] is greater than `0.0`, the direction in which particles are pushed can be changed by rotating the [GPUParticlesAttractor3D] node. */ get directionality(): float64 set directionality(value: float64) /** The particle rendering layers ([member VisualInstance3D.layers]) that will be affected by the attractor. By default, all particles are affected by an attractor. * After configuring particle nodes accordingly, specific layers can be unchecked to prevent certain particles from being affected by attractors. For example, this can be used if you're using an attractor as part of a spell effect but don't want the attractor to affect unrelated weather particles at the same position. * Particle attraction can also be disabled on a per-process material basis by setting [member ParticleProcessMaterial.attractor_interaction_enabled] on the [GPUParticles3D] node. */ get cull_mask(): int64 set cull_mask(value: int64) } /** A box-shaped attractor that influences particles from [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlesattractorbox3d.html */ class GPUParticlesAttractorBox3D = Record> extends GPUParticlesAttractor3D { constructor(identifier?: any) /** The attractor box's size in 3D units. */ get size(): Vector3 set size(value: Vector3) } /** A spheroid-shaped attractor that influences particles from [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlesattractorsphere3d.html */ class GPUParticlesAttractorSphere3D = Record> extends GPUParticlesAttractor3D { constructor(identifier?: any) /** The attractor sphere's radius in 3D units. * * **Note:** Stretched ellipses can be obtained by using non-uniform scaling on the [GPUParticlesAttractorSphere3D] node. */ get radius(): float64 set radius(value: float64) } /** A box-shaped attractor with varying directions and strengths defined in it that influences particles from [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlesattractorvectorfield3d.html */ class GPUParticlesAttractorVectorField3D = Record> extends GPUParticlesAttractor3D { constructor(identifier?: any) /** The size of the vector field box in 3D units. */ get size(): Vector3 set size(value: Vector3) /** The 3D texture to be used. Values are linearly interpolated between the texture's pixels. * * **Note:** To get better performance, the 3D texture's resolution should reflect the [member size] of the attractor. Since particle attraction is usually low-frequency data, the texture can be kept at a low resolution such as 64×64×64. */ get texture(): Texture3D set texture(value: Texture3D) } /** Abstract base class for 3D particle collision shapes affecting [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlescollision3d.html */ class GPUParticlesCollision3D = Record> extends VisualInstance3D { constructor(identifier?: any) /** The particle rendering layers ([member VisualInstance3D.layers]) that will be affected by the collision shape. By default, all particles that have [member ParticleProcessMaterial.collision_mode] set to [constant ParticleProcessMaterial.COLLISION_RIGID] or [constant ParticleProcessMaterial.COLLISION_HIDE_ON_CONTACT] will be affected by a collision shape. * After configuring particle nodes accordingly, specific layers can be unchecked to prevent certain particles from being affected by colliders. For example, this can be used if you're using a collider as part of a spell effect but don't want the collider to affect unrelated weather particles at the same position. * Particle collision can also be disabled on a per-process material basis by setting [member ParticleProcessMaterial.collision_mode] on the [GPUParticles3D] node. */ get cull_mask(): int64 set cull_mask(value: int64) } class GPUParticlesCollision3DGizmoPlugin extends EditorNode3DGizmoPlugin { constructor(identifier?: any) } /** A box-shaped 3D particle collision shape affecting [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlescollisionbox3d.html */ class GPUParticlesCollisionBox3D = Record> extends GPUParticlesCollision3D { constructor(identifier?: any) /** The collision box's size in 3D units. */ get size(): Vector3 set size(value: Vector3) } namespace GPUParticlesCollisionHeightField3D { enum Resolution { /** Generate a 256×256 heightmap. Intended for small-scale scenes, or larger scenes with no distant particles. */ RESOLUTION_256 = 0, /** Generate a 512×512 heightmap. Intended for medium-scale scenes, or larger scenes with no distant particles. */ RESOLUTION_512 = 1, /** Generate a 1024×1024 heightmap. Intended for large scenes with distant particles. */ RESOLUTION_1024 = 2, /** Generate a 2048×2048 heightmap. Intended for very large scenes with distant particles. */ RESOLUTION_2048 = 3, /** Generate a 4096×4096 heightmap. Intended for huge scenes with distant particles. */ RESOLUTION_4096 = 4, /** Generate a 8192×8192 heightmap. Intended for gigantic scenes with distant particles. */ RESOLUTION_8192 = 5, /** Represents the size of the [enum Resolution] enum. */ RESOLUTION_MAX = 6, } enum UpdateMode { /** Only update the heightmap when the [GPUParticlesCollisionHeightField3D] node is moved, or when the camera moves if [member follow_camera_enabled] is `true`. An update can be forced by slightly moving the [GPUParticlesCollisionHeightField3D] in any direction, or by calling [method RenderingServer.particles_collision_height_field_update]. */ UPDATE_MODE_WHEN_MOVED = 0, /** Update the heightmap every frame. This has a significant performance cost. This update should only be used when geometry that particles can collide with changes significantly during gameplay. */ UPDATE_MODE_ALWAYS = 1, } } /** A real-time heightmap-shaped 3D particle collision shape affecting [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlescollisionheightfield3d.html */ class GPUParticlesCollisionHeightField3D = Record> extends GPUParticlesCollision3D { constructor(identifier?: any) /** Based on [param value], enables or disables the specified layer in the [member heightfield_mask], given a [param layer_number] between `1` and `20`, inclusive. */ set_heightfield_mask_value(layer_number: int64, value: boolean): void /** Returns `true` if the specified layer of the [member heightfield_mask] is enabled, given a [param layer_number] between `1` and `20`, inclusive. */ get_heightfield_mask_value(layer_number: int64): boolean /** The collision heightmap's size in 3D units. To improve heightmap quality, [member size] should be set as small as possible while covering the parts of the scene you need. */ get size(): Vector3 set size(value: Vector3) /** Higher resolutions can represent small details more accurately in large scenes, at the cost of lower performance. If [member update_mode] is [constant UPDATE_MODE_ALWAYS], consider using the lowest resolution possible. */ get resolution(): int64 set resolution(value: int64) /** The update policy to use for the generated heightmap. */ get update_mode(): int64 set update_mode(value: int64) /** If `true`, the [GPUParticlesCollisionHeightField3D] will follow the current camera in global space. The [GPUParticlesCollisionHeightField3D] does not need to be a child of the [Camera3D] node for this to work. * Following the camera has a performance cost, as it will force the heightmap to update whenever the camera moves. Consider lowering [member resolution] to improve performance if [member follow_camera_enabled] is `true`. */ get follow_camera_enabled(): boolean set follow_camera_enabled(value: boolean) /** The visual layers to account for when updating the heightmap. Only [MeshInstance3D]s whose [member VisualInstance3D.layers] match with this [member heightfield_mask] will be included in the heightmap collision update. By default, all 20 user-visible layers are taken into account for updating the heightmap collision. * * **Note:** Since the [member heightfield_mask] allows for 32 layers to be stored in total, there are an additional 12 layers that are only used internally by the engine and aren't exposed in the editor. Setting [member heightfield_mask] using a script allows you to toggle those reserved layers, which can be useful for editor plugins. * To adjust [member heightfield_mask] more easily using a script, use [method get_heightfield_mask_value] and [method set_heightfield_mask_value]. */ get heightfield_mask(): int64 set heightfield_mask(value: int64) } namespace GPUParticlesCollisionSDF3D { enum Resolution { /** Bake a 16×16×16 signed distance field. This is the fastest option, but also the least precise. */ RESOLUTION_16 = 0, /** Bake a 32×32×32 signed distance field. */ RESOLUTION_32 = 1, /** Bake a 64×64×64 signed distance field. */ RESOLUTION_64 = 2, /** Bake a 128×128×128 signed distance field. */ RESOLUTION_128 = 3, /** Bake a 256×256×256 signed distance field. */ RESOLUTION_256 = 4, /** Bake a 512×512×512 signed distance field. This is the slowest option, but also the most precise. */ RESOLUTION_512 = 5, /** Represents the size of the [enum Resolution] enum. */ RESOLUTION_MAX = 6, } } /** A baked signed distance field 3D particle collision shape affecting [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlescollisionsdf3d.html */ class GPUParticlesCollisionSDF3D = Record> extends GPUParticlesCollision3D { constructor(identifier?: any) /** Based on [param value], enables or disables the specified layer in the [member bake_mask], given a [param layer_number] between 1 and 32. */ set_bake_mask_value(layer_number: int64, value: boolean): void /** Returns whether or not the specified layer of the [member bake_mask] is enabled, given a [param layer_number] between 1 and 32. */ get_bake_mask_value(layer_number: int64): boolean /** The collision SDF's size in 3D units. To improve SDF quality, the [member size] should be set as small as possible while covering the parts of the scene you need. */ get size(): Vector3 set size(value: Vector3) /** The bake resolution to use for the signed distance field [member texture]. The texture must be baked again for changes to the [member resolution] property to be effective. Higher resolutions have a greater performance cost and take more time to bake. Higher resolutions also result in larger baked textures, leading to increased VRAM and storage space requirements. To improve performance and reduce bake times, use the lowest resolution possible for the object you're representing the collision of. */ get resolution(): int64 set resolution(value: int64) /** The collision shape's thickness. Unlike other particle colliders, [GPUParticlesCollisionSDF3D] is actually hollow on the inside. [member thickness] can be increased to prevent particles from tunneling through the collision shape at high speeds, or when the [GPUParticlesCollisionSDF3D] is moved. */ get thickness(): float64 set thickness(value: float64) /** The visual layers to account for when baking the particle collision SDF. Only [MeshInstance3D]s whose [member VisualInstance3D.layers] match with this [member bake_mask] will be included in the generated particle collision SDF. By default, all objects are taken into account for the particle collision SDF baking. */ get bake_mask(): int64 set bake_mask(value: int64) /** The 3D texture representing the signed distance field. */ get texture(): Texture3D set texture(value: Texture3D) } class GPUParticlesCollisionSDF3DEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } /** A sphere-shaped 3D particle collision shape affecting [GPUParticles3D] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gpuparticlescollisionsphere3d.html */ class GPUParticlesCollisionSphere3D = Record> extends GPUParticlesCollision3D { constructor(identifier?: any) /** The collision sphere's radius in 3D units. */ get radius(): float64 set radius(value: float64) } class GameView = Record> extends VBoxContainer { constructor(identifier?: any) } class GameViewDebugger extends EditorDebuggerPlugin { constructor(identifier?: any) readonly session_started: Signal0 readonly session_stopped: Signal0 } class GameViewPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } namespace Generic6DOFJoint3D { enum Param { /** The minimum difference between the pivot points' axes. */ PARAM_LINEAR_LOWER_LIMIT = 0, /** The maximum difference between the pivot points' axes. */ PARAM_LINEAR_UPPER_LIMIT = 1, /** A factor applied to the movement across the axes. The lower, the slower the movement. */ PARAM_LINEAR_LIMIT_SOFTNESS = 2, /** The amount of restitution on the axes' movement. The lower, the more momentum gets lost. */ PARAM_LINEAR_RESTITUTION = 3, /** The amount of damping that happens at the linear motion across the axes. */ PARAM_LINEAR_DAMPING = 4, /** The velocity the linear motor will try to reach. */ PARAM_LINEAR_MOTOR_TARGET_VELOCITY = 5, /** The maximum force the linear motor will apply while trying to reach the velocity target. */ PARAM_LINEAR_MOTOR_FORCE_LIMIT = 6, PARAM_LINEAR_SPRING_STIFFNESS = 7, PARAM_LINEAR_SPRING_DAMPING = 8, PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT = 9, /** The minimum rotation in negative direction to break loose and rotate around the axes. */ PARAM_ANGULAR_LOWER_LIMIT = 10, /** The minimum rotation in positive direction to break loose and rotate around the axes. */ PARAM_ANGULAR_UPPER_LIMIT = 11, /** The speed of all rotations across the axes. */ PARAM_ANGULAR_LIMIT_SOFTNESS = 12, /** The amount of rotational damping across the axes. The lower, the more damping occurs. */ PARAM_ANGULAR_DAMPING = 13, /** The amount of rotational restitution across the axes. The lower, the more restitution occurs. */ PARAM_ANGULAR_RESTITUTION = 14, /** The maximum amount of force that can occur, when rotating around the axes. */ PARAM_ANGULAR_FORCE_LIMIT = 15, /** When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. */ PARAM_ANGULAR_ERP = 16, /** Target speed for the motor at the axes. */ PARAM_ANGULAR_MOTOR_TARGET_VELOCITY = 17, /** Maximum acceleration for the motor at the axes. */ PARAM_ANGULAR_MOTOR_FORCE_LIMIT = 18, PARAM_ANGULAR_SPRING_STIFFNESS = 19, PARAM_ANGULAR_SPRING_DAMPING = 20, PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT = 21, /** Represents the size of the [enum Param] enum. */ PARAM_MAX = 22, } enum Flag { /** If enabled, linear motion is possible within the given limits. */ FLAG_ENABLE_LINEAR_LIMIT = 0, /** If enabled, rotational motion is possible within the given limits. */ FLAG_ENABLE_ANGULAR_LIMIT = 1, FLAG_ENABLE_LINEAR_SPRING = 3, FLAG_ENABLE_ANGULAR_SPRING = 2, /** If enabled, there is a rotational motor across these axes. */ FLAG_ENABLE_MOTOR = 4, /** If enabled, there is a linear motor across these axes. */ FLAG_ENABLE_LINEAR_MOTOR = 5, /** Represents the size of the [enum Flag] enum. */ FLAG_MAX = 6, } } /** A physics joint that allows for complex movement and rotation between two 3D physics bodies. * * @link https://docs.godotengine.org/en/4.4/classes/class_generic6dofjoint3d.html */ class Generic6DOFJoint3D = Record> extends Joint3D { constructor(identifier?: any) set_param_x(param: Generic6DOFJoint3D.Param, value: float64): void get_param_x(param: Generic6DOFJoint3D.Param): float64 set_param_y(param: Generic6DOFJoint3D.Param, value: float64): void get_param_y(param: Generic6DOFJoint3D.Param): float64 set_param_z(param: Generic6DOFJoint3D.Param, value: float64): void get_param_z(param: Generic6DOFJoint3D.Param): float64 set_flag_x(flag: Generic6DOFJoint3D.Flag, value: boolean): void get_flag_x(flag: Generic6DOFJoint3D.Flag): boolean set_flag_y(flag: Generic6DOFJoint3D.Flag, value: boolean): void get_flag_y(flag: Generic6DOFJoint3D.Flag): boolean set_flag_z(flag: Generic6DOFJoint3D.Flag, value: boolean): void get_flag_z(flag: Generic6DOFJoint3D.Flag): boolean /** If `true`, the linear motion across the X axis is limited. */ get "linear_limit_x/enabled"(): boolean set "linear_limit_x/enabled"(value: boolean) /** The maximum difference between the pivot points' X axis. */ get "linear_limit_x/upper_distance"(): float64 set "linear_limit_x/upper_distance"(value: float64) /** The minimum difference between the pivot points' X axis. */ get "linear_limit_x/lower_distance"(): float64 set "linear_limit_x/lower_distance"(value: float64) /** A factor applied to the movement across the X axis. The lower, the slower the movement. */ get "linear_limit_x/softness"(): float64 set "linear_limit_x/softness"(value: float64) /** The amount of restitution on the X axis movement. The lower, the more momentum gets lost. */ get "linear_limit_x/restitution"(): float64 set "linear_limit_x/restitution"(value: float64) /** The amount of damping that happens at the X motion. */ get "linear_limit_x/damping"(): float64 set "linear_limit_x/damping"(value: float64) /** If `true`, the linear motion across the Y axis is limited. */ get "linear_limit_y/enabled"(): boolean set "linear_limit_y/enabled"(value: boolean) /** The maximum difference between the pivot points' Y axis. */ get "linear_limit_y/upper_distance"(): float64 set "linear_limit_y/upper_distance"(value: float64) /** The minimum difference between the pivot points' Y axis. */ get "linear_limit_y/lower_distance"(): float64 set "linear_limit_y/lower_distance"(value: float64) /** A factor applied to the movement across the Y axis. The lower, the slower the movement. */ get "linear_limit_y/softness"(): float64 set "linear_limit_y/softness"(value: float64) /** The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. */ get "linear_limit_y/restitution"(): float64 set "linear_limit_y/restitution"(value: float64) /** The amount of damping that happens at the Y motion. */ get "linear_limit_y/damping"(): float64 set "linear_limit_y/damping"(value: float64) /** If `true`, the linear motion across the Z axis is limited. */ get "linear_limit_z/enabled"(): boolean set "linear_limit_z/enabled"(value: boolean) /** The maximum difference between the pivot points' Z axis. */ get "linear_limit_z/upper_distance"(): float64 set "linear_limit_z/upper_distance"(value: float64) /** The minimum difference between the pivot points' Z axis. */ get "linear_limit_z/lower_distance"(): float64 set "linear_limit_z/lower_distance"(value: float64) /** A factor applied to the movement across the Z axis. The lower, the slower the movement. */ get "linear_limit_z/softness"(): float64 set "linear_limit_z/softness"(value: float64) /** The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. */ get "linear_limit_z/restitution"(): float64 set "linear_limit_z/restitution"(value: float64) /** The amount of damping that happens at the Z motion. */ get "linear_limit_z/damping"(): float64 set "linear_limit_z/damping"(value: float64) /** If `true`, then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits. */ get "linear_motor_x/enabled"(): boolean set "linear_motor_x/enabled"(value: boolean) /** The speed that the linear motor will attempt to reach on the X axis. */ get "linear_motor_x/target_velocity"(): float64 set "linear_motor_x/target_velocity"(value: float64) /** The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. */ get "linear_motor_x/force_limit"(): float64 set "linear_motor_x/force_limit"(value: float64) /** If `true`, then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits. */ get "linear_motor_y/enabled"(): boolean set "linear_motor_y/enabled"(value: boolean) /** The speed that the linear motor will attempt to reach on the Y axis. */ get "linear_motor_y/target_velocity"(): float64 set "linear_motor_y/target_velocity"(value: float64) /** The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. */ get "linear_motor_y/force_limit"(): float64 set "linear_motor_y/force_limit"(value: float64) /** If `true`, then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits. */ get "linear_motor_z/enabled"(): boolean set "linear_motor_z/enabled"(value: boolean) /** The speed that the linear motor will attempt to reach on the Z axis. */ get "linear_motor_z/target_velocity"(): float64 set "linear_motor_z/target_velocity"(value: float64) /** The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. */ get "linear_motor_z/force_limit"(): float64 set "linear_motor_z/force_limit"(value: float64) get "linear_spring_x/enabled"(): boolean set "linear_spring_x/enabled"(value: boolean) get "linear_spring_x/stiffness"(): float64 set "linear_spring_x/stiffness"(value: float64) get "linear_spring_x/damping"(): float64 set "linear_spring_x/damping"(value: float64) get "linear_spring_x/equilibrium_point"(): float64 set "linear_spring_x/equilibrium_point"(value: float64) get "linear_spring_y/enabled"(): boolean set "linear_spring_y/enabled"(value: boolean) get "linear_spring_y/stiffness"(): float64 set "linear_spring_y/stiffness"(value: float64) get "linear_spring_y/damping"(): float64 set "linear_spring_y/damping"(value: float64) get "linear_spring_y/equilibrium_point"(): float64 set "linear_spring_y/equilibrium_point"(value: float64) get "linear_spring_z/enabled"(): boolean set "linear_spring_z/enabled"(value: boolean) get "linear_spring_z/stiffness"(): float64 set "linear_spring_z/stiffness"(value: float64) get "linear_spring_z/damping"(): float64 set "linear_spring_z/damping"(value: float64) get "linear_spring_z/equilibrium_point"(): float64 set "linear_spring_z/equilibrium_point"(value: float64) /** If `true`, rotation across the X axis is limited. */ get "angular_limit_x/enabled"(): boolean set "angular_limit_x/enabled"(value: boolean) /** The minimum rotation in positive direction to break loose and rotate around the X axis. */ get "angular_limit_x/upper_angle"(): float64 set "angular_limit_x/upper_angle"(value: float64) /** The minimum rotation in negative direction to break loose and rotate around the X axis. */ get "angular_limit_x/lower_angle"(): float64 set "angular_limit_x/lower_angle"(value: float64) /** The speed of all rotations across the X axis. */ get "angular_limit_x/softness"(): float64 set "angular_limit_x/softness"(value: float64) /** The amount of rotational restitution across the X axis. The lower, the more restitution occurs. */ get "angular_limit_x/restitution"(): float64 set "angular_limit_x/restitution"(value: float64) /** The amount of rotational damping across the X axis. * The lower, the longer an impulse from one side takes to travel to the other side. */ get "angular_limit_x/damping"(): float64 set "angular_limit_x/damping"(value: float64) /** The maximum amount of force that can occur, when rotating around the X axis. */ get "angular_limit_x/force_limit"(): float64 set "angular_limit_x/force_limit"(value: float64) /** When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. */ get "angular_limit_x/erp"(): float64 set "angular_limit_x/erp"(value: float64) /** If `true`, rotation across the Y axis is limited. */ get "angular_limit_y/enabled"(): boolean set "angular_limit_y/enabled"(value: boolean) /** The minimum rotation in positive direction to break loose and rotate around the Y axis. */ get "angular_limit_y/upper_angle"(): float64 set "angular_limit_y/upper_angle"(value: float64) /** The minimum rotation in negative direction to break loose and rotate around the Y axis. */ get "angular_limit_y/lower_angle"(): float64 set "angular_limit_y/lower_angle"(value: float64) /** The speed of all rotations across the Y axis. */ get "angular_limit_y/softness"(): float64 set "angular_limit_y/softness"(value: float64) /** The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. */ get "angular_limit_y/restitution"(): float64 set "angular_limit_y/restitution"(value: float64) /** The amount of rotational damping across the Y axis. The lower, the more damping occurs. */ get "angular_limit_y/damping"(): float64 set "angular_limit_y/damping"(value: float64) /** The maximum amount of force that can occur, when rotating around the Y axis. */ get "angular_limit_y/force_limit"(): float64 set "angular_limit_y/force_limit"(value: float64) /** When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. */ get "angular_limit_y/erp"(): float64 set "angular_limit_y/erp"(value: float64) /** If `true`, rotation across the Z axis is limited. */ get "angular_limit_z/enabled"(): boolean set "angular_limit_z/enabled"(value: boolean) /** The minimum rotation in positive direction to break loose and rotate around the Z axis. */ get "angular_limit_z/upper_angle"(): float64 set "angular_limit_z/upper_angle"(value: float64) /** The minimum rotation in negative direction to break loose and rotate around the Z axis. */ get "angular_limit_z/lower_angle"(): float64 set "angular_limit_z/lower_angle"(value: float64) /** The speed of all rotations across the Z axis. */ get "angular_limit_z/softness"(): float64 set "angular_limit_z/softness"(value: float64) /** The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. */ get "angular_limit_z/restitution"(): float64 set "angular_limit_z/restitution"(value: float64) /** The amount of rotational damping across the Z axis. The lower, the more damping occurs. */ get "angular_limit_z/damping"(): float64 set "angular_limit_z/damping"(value: float64) /** The maximum amount of force that can occur, when rotating around the Z axis. */ get "angular_limit_z/force_limit"(): float64 set "angular_limit_z/force_limit"(value: float64) /** When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. */ get "angular_limit_z/erp"(): float64 set "angular_limit_z/erp"(value: float64) /** If `true`, a rotating motor at the X axis is enabled. */ get "angular_motor_x/enabled"(): boolean set "angular_motor_x/enabled"(value: boolean) /** Target speed for the motor at the X axis. */ get "angular_motor_x/target_velocity"(): float64 set "angular_motor_x/target_velocity"(value: float64) /** Maximum acceleration for the motor at the X axis. */ get "angular_motor_x/force_limit"(): float64 set "angular_motor_x/force_limit"(value: float64) /** If `true`, a rotating motor at the Y axis is enabled. */ get "angular_motor_y/enabled"(): boolean set "angular_motor_y/enabled"(value: boolean) /** Target speed for the motor at the Y axis. */ get "angular_motor_y/target_velocity"(): float64 set "angular_motor_y/target_velocity"(value: float64) /** Maximum acceleration for the motor at the Y axis. */ get "angular_motor_y/force_limit"(): float64 set "angular_motor_y/force_limit"(value: float64) /** If `true`, a rotating motor at the Z axis is enabled. */ get "angular_motor_z/enabled"(): boolean set "angular_motor_z/enabled"(value: boolean) /** Target speed for the motor at the Z axis. */ get "angular_motor_z/target_velocity"(): float64 set "angular_motor_z/target_velocity"(value: float64) /** Maximum acceleration for the motor at the Z axis. */ get "angular_motor_z/force_limit"(): float64 set "angular_motor_z/force_limit"(value: float64) get "angular_spring_x/enabled"(): boolean set "angular_spring_x/enabled"(value: boolean) get "angular_spring_x/stiffness"(): float64 set "angular_spring_x/stiffness"(value: float64) get "angular_spring_x/damping"(): float64 set "angular_spring_x/damping"(value: float64) get "angular_spring_x/equilibrium_point"(): float64 set "angular_spring_x/equilibrium_point"(value: float64) get "angular_spring_y/enabled"(): boolean set "angular_spring_y/enabled"(value: boolean) get "angular_spring_y/stiffness"(): float64 set "angular_spring_y/stiffness"(value: float64) get "angular_spring_y/damping"(): float64 set "angular_spring_y/damping"(value: float64) get "angular_spring_y/equilibrium_point"(): float64 set "angular_spring_y/equilibrium_point"(value: float64) get "angular_spring_z/enabled"(): boolean set "angular_spring_z/enabled"(value: boolean) get "angular_spring_z/stiffness"(): float64 set "angular_spring_z/stiffness"(value: float64) get "angular_spring_z/damping"(): float64 set "angular_spring_z/damping"(value: float64) get "angular_spring_z/equilibrium_point"(): float64 set "angular_spring_z/equilibrium_point"(value: float64) } namespace GeometryInstance3D { enum ShadowCastingSetting { /** Will not cast any shadows. Use this to improve performance for small geometry that is unlikely to cast noticeable shadows (such as debris). */ SHADOW_CASTING_SETTING_OFF = 0, /** Will cast shadows from all visible faces in the GeometryInstance3D. * Will take culling into account, so faces not being rendered will not be taken into account when shadow casting. */ SHADOW_CASTING_SETTING_ON = 1, /** Will cast shadows from all visible faces in the GeometryInstance3D. * Will not take culling into account, so all faces will be taken into account when shadow casting. */ SHADOW_CASTING_SETTING_DOUBLE_SIDED = 2, /** Will only show the shadows casted from this object. * In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be. */ SHADOW_CASTING_SETTING_SHADOWS_ONLY = 3, } enum GIMode { /** Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using [VoxelGI] and SDFGI, the geometry will *receive* indirect lighting and reflections but the geometry will not be considered in GI baking. */ GI_MODE_DISABLED = 0, /** Baked global illumination mode. Use for static objects that contribute to global illumination (such as level geometry). This GI mode is effective when using [VoxelGI], SDFGI and [LightmapGI]. */ GI_MODE_STATIC = 1, /** Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using [VoxelGI], but it has a higher performance impact than [constant GI_MODE_STATIC]. When using other GI methods, this will act the same as [constant GI_MODE_DISABLED]. When using [LightmapGI], the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture. */ GI_MODE_DYNAMIC = 2, } enum LightmapScale { /** The standard texel density for lightmapping with [LightmapGI]. */ LIGHTMAP_SCALE_1X = 0, /** Multiplies texel density by 2× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor between 1.5 and 3.0. */ LIGHTMAP_SCALE_2X = 1, /** Multiplies texel density by 4× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor between 3.0 and 6.0. */ LIGHTMAP_SCALE_4X = 2, /** Multiplies texel density by 8× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor greater than 6.0. */ LIGHTMAP_SCALE_8X = 3, /** Represents the size of the [enum LightmapScale] enum. */ LIGHTMAP_SCALE_MAX = 4, } enum VisibilityRangeFadeMode { /** Will not fade itself nor its visibility dependencies, hysteresis will be used instead. This is the fastest approach to manual LOD, but it can result in noticeable LOD transitions depending on how the LOD meshes are authored. See [member visibility_range_begin] and [member Node3D.visibility_parent] for more information. */ VISIBILITY_RANGE_FADE_DISABLED = 0, /** Will fade-out itself when reaching the limits of its own visibility range. This is slower than [constant VISIBILITY_RANGE_FADE_DISABLED], but it can provide smoother transitions. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. * * **Note:** Only supported when using the Forward+ rendering method. When using the Mobile or Compatibility rendering method, this mode acts like [constant VISIBILITY_RANGE_FADE_DISABLED] but with hysteresis disabled. */ VISIBILITY_RANGE_FADE_SELF = 1, /** Will fade-in its visibility dependencies (see [member Node3D.visibility_parent]) when reaching the limits of its own visibility range. This is slower than [constant VISIBILITY_RANGE_FADE_DISABLED], but it can provide smoother transitions. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. * * **Note:** Only supported when using the Forward+ rendering method. When using the Mobile or Compatibility rendering method, this mode acts like [constant VISIBILITY_RANGE_FADE_DISABLED] but with hysteresis disabled. */ VISIBILITY_RANGE_FADE_DEPENDENCIES = 2, } } /** Base node for geometry-based visual instances. * * @link https://docs.godotengine.org/en/4.4/classes/class_geometryinstance3d.html */ class GeometryInstance3D = Record> extends VisualInstance3D { constructor(identifier?: any) /** Set the value of a shader uniform for this instance only ([url=https://docs.godotengine.org/en/4.4/tutorials/shaders/shader_reference/shading_language.html#per-instance-uniforms]per-instance uniform[/url]). See also [method ShaderMaterial.set_shader_parameter] to assign a uniform on all instances using the same [ShaderMaterial]. * * **Note:** For a shader uniform to be assignable on a per-instance basis, it *must* be defined with `instance uniform ...` rather than `uniform ...` in the shader code. * * **Note:** [param name] is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector). * * **Note:** Per-instance shader uniforms are only available in Spatial and CanvasItem shaders, but not for Fog, Sky, or Particles shaders. */ set_instance_shader_parameter(name: StringName, value: any): void /** Get the value of a shader parameter as set on this instance. */ get_instance_shader_parameter(name: StringName): any /** The material override for the whole geometry. * If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. */ get material_override(): BaseMaterial3D | ShaderMaterial set material_override(value: BaseMaterial3D | ShaderMaterial) /** The material overlay for the whole geometry. * If a material is assigned to this property, it will be rendered on top of any other active material for all the surfaces. */ get material_overlay(): BaseMaterial3D | ShaderMaterial set material_overlay(value: BaseMaterial3D | ShaderMaterial) /** The transparency applied to the whole geometry (as a multiplier of the materials' existing transparency). `0.0` is fully opaque, while `1.0` is fully transparent. Values greater than `0.0` (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [member transparency] to a value greater than `0.0` (exclusive) will *not* disable shadow rendering. * In spatial shaders, `1.0 - transparency` is set as the default value of the `ALPHA` built-in. * * **Note:** [member transparency] is clamped between `0.0` and `1.0`, so this property cannot be used to make transparent materials more opaque than they originally are. * * **Note:** Only supported when using the Forward+ rendering method. When using the Mobile or Compatibility rendering method, [member transparency] is ignored and is considered as always being `0.0`. */ get transparency(): float64 set transparency(value: float64) /** The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values. */ get cast_shadow(): int64 set cast_shadow(value: int64) /** The extra distance added to the GeometryInstance3D's bounding box ([AABB]) to increase its cull box. */ get extra_cull_margin(): float64 set extra_cull_margin(value: float64) /** Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive [AABB] recalculation that happens when a skeleton is used with a [MeshInstance3D] or to have precise control over the [MeshInstance3D]'s bounding box. To use the default AABB, set value to an [AABB] with all fields set to `0.0`. To avoid frustum culling, set [member custom_aabb] to a very large AABB that covers your entire game world such as `AABB(-10000, -10000, -10000, 20000, 20000, 20000)`. To disable all forms of culling (including occlusion culling), call [method RenderingServer.instance_set_ignore_culling] on the [GeometryInstance3D]'s [RID]. */ get custom_aabb(): AABB set custom_aabb(value: AABB) /** Changes how quickly the mesh transitions to a lower level of detail. A value of 0 will force the mesh to its lowest level of detail, a value of 1 will use the default settings, and larger values will keep the mesh in a higher level of detail at farther distances. * Useful for testing level of detail transitions in the editor. */ get lod_bias(): float64 set lod_bias(value: float64) /** If `true`, disables occlusion culling for this instance. Useful for gizmos that must be rendered even when occlusion culling is in use. * * **Note:** [member ignore_occlusion_culling] does not affect frustum culling (which is what happens when an object is not visible given the camera's angle). To avoid frustum culling, set [member custom_aabb] to a very large AABB that covers your entire game world such as `AABB(-10000, -10000, -10000, 20000, 20000, 20000)`. */ get ignore_occlusion_culling(): boolean set ignore_occlusion_culling(value: boolean) /** The global illumination mode to use for the whole geometry. To avoid inconsistent results, use a mode that matches the purpose of the mesh during gameplay (static/dynamic). * * **Note:** Lights' bake mode will also affect the global illumination rendering. See [member Light3D.light_bake_mode]. */ get gi_mode(): int64 set gi_mode(value: int64) /** The texel density to use for lightmapping in [LightmapGI]. Greater scale values provide higher resolution in the lightmap, which can result in sharper shadows for lights that have both direct and indirect light baked. However, greater scale values will also increase the space taken by the mesh in the lightmap texture, which increases the memory, storage, and bake time requirements. When using a single mesh at different scales, consider adjusting this value to keep the lightmap texel density consistent across meshes. * For example, doubling [member gi_lightmap_texel_scale] doubles the lightmap texture resolution for this object *on each axis* , so it will *quadruple* the texel count. */ get gi_lightmap_texel_scale(): float64 set gi_lightmap_texel_scale(value: float64) /** The texel density to use for lightmapping in [LightmapGI]. */ get gi_lightmap_scale(): int64 set gi_lightmap_scale(value: int64) /** Starting distance from which the GeometryInstance3D will be visible, taking [member visibility_range_begin_margin] into account as well. The default value of 0 is used to disable the range check. */ get visibility_range_begin(): float64 set visibility_range_begin(value: float64) /** Margin for the [member visibility_range_begin] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_begin] threshold by this amount. * If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_DISABLED], this acts as a hysteresis distance. If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_SELF] or [constant VISIBILITY_RANGE_FADE_DEPENDENCIES], this acts as a fade transition distance and must be set to a value greater than `0.0` for the effect to be noticeable. */ get visibility_range_begin_margin(): float64 set visibility_range_begin_margin(value: float64) /** Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check. */ get visibility_range_end(): float64 set visibility_range_end(value: float64) /** Margin for the [member visibility_range_end] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_end] threshold by this amount. * If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_DISABLED], this acts as a hysteresis distance. If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_SELF] or [constant VISIBILITY_RANGE_FADE_DEPENDENCIES], this acts as a fade transition distance and must be set to a value greater than `0.0` for the effect to be noticeable. */ get visibility_range_end_margin(): float64 set visibility_range_end_margin(value: float64) /** Controls which instances will be faded when approaching the limits of the visibility range. See [enum VisibilityRangeFadeMode] for possible values. */ get visibility_range_fade_mode(): int64 set visibility_range_fade_mode(value: int64) } class GeometryInstance3DGizmoPlugin extends EditorNode3DGizmoPlugin { constructor(identifier?: any) } class Gizmo3DHelper extends RefCounted { constructor(identifier?: any) } class GodotJSDockedPanel = Record> extends MarginContainer { constructor(identifier?: any) } class GodotJSMonitor extends Object { constructor(identifier?: any) get_value_objects(): any get_value_native_classes(): any get_value_script_classes(): any get_value_cached_string_names(): any get_value_persistent_objects(): any get_value_allocated_variants(): any get_value_memory_used_size(): any } class GodotJSStatisticsViewer = Record> extends VBoxContainer { constructor(identifier?: any) } class GodotNavigationServer2D extends NavigationServer2D { constructor(identifier?: any) } class GodotPhysicsDirectSpaceState2D extends PhysicsDirectSpaceState2D { constructor(identifier?: any) } class GodotPhysicsDirectSpaceState3D extends PhysicsDirectSpaceState3D { constructor(identifier?: any) } class GodotPhysicsServer2D extends PhysicsServer2D { constructor(identifier?: any) } class GodotPhysicsServer3D extends PhysicsServer3D { constructor(identifier?: any) } namespace Gradient { enum InterpolationMode { /** Linear interpolation. */ GRADIENT_INTERPOLATE_LINEAR = 0, /** Constant interpolation, color changes abruptly at each point and stays uniform between. This might cause visible aliasing when used for a gradient texture in some cases. */ GRADIENT_INTERPOLATE_CONSTANT = 1, /** Cubic interpolation. */ GRADIENT_INTERPOLATE_CUBIC = 2, } enum ColorSpace { /** sRGB color space. */ GRADIENT_COLOR_SPACE_SRGB = 0, /** Linear sRGB color space. */ GRADIENT_COLOR_SPACE_LINEAR_SRGB = 1, /** [url=https://bottosson.github.io/posts/oklab/]Oklab[/url] color space. This color space provides a smooth and uniform-looking transition between colors. */ GRADIENT_COLOR_SPACE_OKLAB = 2, } } /** A color transition. * * @link https://docs.godotengine.org/en/4.4/classes/class_gradient.html */ class Gradient extends Resource { constructor(identifier?: any) /** Adds the specified color to the gradient, with the specified offset. */ add_point(offset: float64, color: Color): void /** Removes the color at index [param point]. */ remove_point(point: int64): void /** Sets the offset for the gradient color at index [param point]. */ set_offset(point: int64, offset: float64): void /** Returns the offset of the gradient color at index [param point]. */ get_offset(point: int64): float64 /** Reverses/mirrors the gradient. * * **Note:** This method mirrors all points around the middle of the gradient, which may produce unexpected results when [member interpolation_mode] is set to [constant GRADIENT_INTERPOLATE_CONSTANT]. */ reverse(): void /** Sets the color of the gradient color at index [param point]. */ set_color(point: int64, color: Color): void /** Returns the color of the gradient color at index [param point]. */ get_color(point: int64): Color /** Returns the interpolated color specified by [param offset]. */ sample(offset: float64): Color /** Returns the number of colors in the gradient. */ get_point_count(): int64 /** The algorithm used to interpolate between points of the gradient. See [enum InterpolationMode] for available modes. */ get interpolation_mode(): int64 set interpolation_mode(value: int64) /** The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. See [enum ColorSpace] for available modes. * * **Note:** This setting has no effect when [member interpolation_mode] is set to [constant GRADIENT_INTERPOLATE_CONSTANT]. */ get interpolation_color_space(): int64 set interpolation_color_space(value: int64) /** Gradient's offsets as a [PackedFloat32Array]. * * **Note:** Setting this property updates all offsets at once. To update any offset individually use [method set_offset]. */ get offsets(): PackedFloat32Array set offsets(value: PackedFloat32Array | float32[]) /** Gradient's colors as a [PackedColorArray]. * * **Note:** Setting this property updates all colors at once. To update any color individually use [method set_color]. */ get colors(): PackedColorArray set colors(value: PackedColorArray | Color[]) } class GradientEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } /** A 1D texture that uses colors obtained from a [Gradient]. * * @link https://docs.godotengine.org/en/4.4/classes/class_gradienttexture1d.html */ class GradientTexture1D extends Texture2D { constructor(identifier?: any) /** The [Gradient] used to fill the texture. */ get gradient(): Gradient set gradient(value: Gradient) /** The number of color samples that will be obtained from the [Gradient]. */ get width(): int64 set width(value: int64) /** If `true`, the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is `true`. If `false`, the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). */ get use_hdr(): boolean set use_hdr(value: boolean) } namespace GradientTexture2D { enum Fill { /** The colors are linearly interpolated in a straight line. */ FILL_LINEAR = 0, /** The colors are linearly interpolated in a circular pattern. */ FILL_RADIAL = 1, /** The colors are linearly interpolated in a square pattern. */ FILL_SQUARE = 2, } enum Repeat { /** The gradient fill is restricted to the range defined by [member fill_from] to [member fill_to] offsets. */ REPEAT_NONE = 0, /** The texture is filled starting from [member fill_from] to [member fill_to] offsets, repeating the same pattern in both directions. */ REPEAT = 1, /** The texture is filled starting from [member fill_from] to [member fill_to] offsets, mirroring the pattern in both directions. */ REPEAT_MIRROR = 2, } } /** A 2D texture that creates a pattern with colors obtained from a [Gradient]. * * @link https://docs.godotengine.org/en/4.4/classes/class_gradienttexture2d.html */ class GradientTexture2D extends Texture2D { constructor(identifier?: any) /** The [Gradient] used to fill the texture. */ get gradient(): Gradient set gradient(value: Gradient) /** The number of horizontal color samples that will be obtained from the [Gradient], which also represents the texture's width. */ get width(): int64 set width(value: int64) /** The number of vertical color samples that will be obtained from the [Gradient], which also represents the texture's height. */ get height(): int64 set height(value: int64) /** If `true`, the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is `true`. If `false`, the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). */ get use_hdr(): boolean set use_hdr(value: boolean) /** The gradient fill type, one of the [enum Fill] values. The texture is filled by interpolating colors starting from [member fill_from] to [member fill_to] offsets. */ get fill(): int64 set fill(value: int64) /** The initial offset used to fill the texture specified in UV coordinates. */ get fill_from(): Vector2 set fill_from(value: Vector2) /** The final offset used to fill the texture specified in UV coordinates. */ get fill_to(): Vector2 set fill_to(value: Vector2) /** The gradient repeat type, one of the [enum Repeat] values. The texture is filled starting from [member fill_from] to [member fill_to] offsets by default, but the gradient fill can be repeated to cover the entire texture. */ get repeat(): int64 set repeat(value: int64) } class GradientTexture2DEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } namespace GraphEdit { enum PanningScheme { /** [kbd]Mouse Wheel[/kbd] will zoom, [kbd]Ctrl + Mouse Wheel[/kbd] will move the view. */ SCROLL_ZOOMS = 0, /** [kbd]Mouse Wheel[/kbd] will move the view, [kbd]Ctrl + Mouse Wheel[/kbd] will zoom. */ SCROLL_PANS = 1, } enum GridPattern { /** Draw the grid using solid lines. */ GRID_PATTERN_LINES = 0, /** Draw the grid using dots. */ GRID_PATTERN_DOTS = 1, } } /** An editor for graph-like structures, using [GraphNode]s. * * @link https://docs.godotengine.org/en/4.4/classes/class_graphedit.html */ class GraphEdit = Record> extends Control { constructor(identifier?: any) /** Returns whether the [param mouse_position] is in the input hot zone. * By default, a hot zone is a [Rect2] positioned such that its center is at [param in_node].[method GraphNode.get_input_port_position]([param in_port]) (For output's case, call [method GraphNode.get_output_port_position] instead). The hot zone's width is twice the Theme Property `port_grab_distance_horizontal`, and its height is twice the `port_grab_distance_vertical`. * Below is a sample code to help get started: * */ /* gdvirtual */ _is_in_input_hotzone(in_node: Object, in_port: int64, mouse_position: Vector2): boolean /** Returns whether the [param mouse_position] is in the output hot zone. For more information on hot zones, see [method _is_in_input_hotzone]. * Below is a sample code to help get started: * */ /* gdvirtual */ _is_in_output_hotzone(in_node: Object, in_port: int64, mouse_position: Vector2): boolean /** Virtual method which can be overridden to customize how connections are drawn. */ /* gdvirtual */ _get_connection_line(from_position: Vector2, to_position: Vector2): PackedVector2Array /** This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port. * Return `true` if the connection is indeed valid or return `false` if the connection is impossible. If the connection is impossible, no snapping to the port and thus no connection request to that port will happen. * In this example a connection to same node is suppressed: * */ /* gdvirtual */ _is_node_hover_valid(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): boolean /** Create a connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection already exists, no connection is created. * Connections with [param keep_alive] set to `false` may be deleted automatically if invalid during a redraw. */ connect_node(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64, keep_alive: boolean = false): GError /** Returns `true` if the [param from_port] of the [param from_node] [GraphNode] is connected to the [param to_port] of the [param to_node] [GraphNode]. */ is_node_connected(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): boolean /** Removes the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection does not exist, no connection is removed. */ disconnect_node(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): void /** Sets the coloration of the connection between [param from_node]'s [param from_port] and [param to_node]'s [param to_port] with the color provided in the [theme_item activity] theme property. The color is linearly interpolated between the connection color and the activity color using [param amount] as weight. */ set_connection_activity(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64, amount: float64): void /** Returns the number of connections from [param from_port] of [param from_node]. */ get_connection_count(from_node: StringName, from_port: int64): int64 /** Returns the closest connection to the given point in screen space. If no connection is found within [param max_distance] pixels, an empty [Dictionary] is returned. * A connection is represented as a [Dictionary] in the form of: * * For example, getting a connection at a given mouse position can be achieved like this: * */ get_closest_connection_at_point(point: Vector2, max_distance: float64 = 4): GDictionary /** Returns an [Array] containing the list of connections that intersect with the given [Rect2]. * A connection is represented as a [Dictionary] in the form of: * */ get_connections_intersecting_with_rect(rect: Rect2): GArray /** Removes all connections between nodes. */ clear_connections(): void /** Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor. * This is best used together with [signal connection_drag_started] and [signal connection_drag_ended] to add custom behavior like node addition through shortcuts. * * **Note:** This method suppresses any other connection request signals apart from [signal connection_drag_ended]. */ force_connection_drag_end(): void /** Allows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_right_disconnect_type]. */ add_valid_right_disconnect_type(type: int64): void /** Disallows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_right_disconnect_type]. */ remove_valid_right_disconnect_type(type: int64): void /** Allows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_left_disconnect_type]. */ add_valid_left_disconnect_type(type: int64): void /** Disallows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_left_disconnect_type]. */ remove_valid_left_disconnect_type(type: int64): void /** Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method. * See also [method is_valid_connection_type] and [method remove_valid_connection_type]. */ add_valid_connection_type(from_type: int64, to_type: int64): void /** Disallows the connection between two different port types previously allowed by [method add_valid_connection_type]. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method. * See also [method is_valid_connection_type]. */ remove_valid_connection_type(from_type: int64, to_type: int64): void /** Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method. * See also [method add_valid_connection_type] and [method remove_valid_connection_type]. */ is_valid_connection_type(from_type: int64, to_type: int64): boolean /** Returns the points which would make up a connection between [param from_node] and [param to_node]. */ get_connection_line(from_node: Vector2, to_node: Vector2): PackedVector2Array /** Attaches the [param element] [GraphElement] to the [param frame] [GraphFrame]. */ attach_graph_element_to_frame(element: StringName, frame: StringName): void /** Detaches the [param element] [GraphElement] from the [GraphFrame] it is currently attached to. */ detach_graph_element_from_frame(element: StringName): void /** Returns the [GraphFrame] that contains the [GraphElement] with the given name. */ get_element_frame(element: StringName): GraphFrame /** Returns an array of node names that are attached to the [GraphFrame] with the given name. */ get_attached_nodes_of_frame(frame: StringName): GArray /** Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it. * **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. */ get_menu_hbox(): HBoxContainer /** Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes. */ arrange_nodes(): void /** Sets the specified [param node] as the one selected. */ set_selected(node: Node): void /** The scroll offset. */ get scroll_offset(): Vector2 set scroll_offset(value: Vector2) /** If `true`, the grid is visible. */ get show_grid(): boolean set show_grid(value: boolean) /** The pattern used for drawing the grid. */ get grid_pattern(): int64 set grid_pattern(value: int64) /** If `true`, enables snapping. */ get snapping_enabled(): boolean set snapping_enabled(value: boolean) /** The snapping distance in pixels, also determines the grid line distance. */ get snapping_distance(): int64 set snapping_distance(value: int64) /** Defines the control scheme for panning with mouse wheel. */ get panning_scheme(): int64 set panning_scheme(value: int64) /** If `true`, enables disconnection of existing connections in the GraphEdit by dragging the right end. */ get right_disconnects(): boolean set right_disconnects(value: boolean) /** The curvature of the lines between the nodes. 0 results in straight lines. */ get connection_lines_curvature(): float64 set connection_lines_curvature(value: float64) /** The thickness of the lines between the nodes. */ get connection_lines_thickness(): float64 set connection_lines_thickness(value: float64) /** If `true`, the lines between nodes will use antialiasing. */ get connection_lines_antialiased(): boolean set connection_lines_antialiased(value: boolean) /** The connections between [GraphNode]s. * A connection is represented as a [Dictionary] in the form of: * * Connections with `keep_alive` set to `false` may be deleted automatically if invalid during a redraw. */ get connections(): GArray set connections(value: GArray) /** The current zoom value. */ get zoom(): float64 set zoom(value: float64) /** The lower zoom limit. */ get zoom_min(): float64 set zoom_min(value: float64) /** The upper zoom limit. */ get zoom_max(): float64 set zoom_max(value: float64) /** The step of each zoom level. */ get zoom_step(): float64 set zoom_step(value: float64) /** If `true`, the minimap is visible. */ get minimap_enabled(): boolean set minimap_enabled(value: boolean) /** The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle. */ get minimap_size(): Vector2 set minimap_size(value: Vector2) /** The opacity of the minimap rectangle. */ get minimap_opacity(): float64 set minimap_opacity(value: float64) /** If `true`, the menu toolbar is visible. */ get show_menu(): boolean set show_menu(value: boolean) /** If `true`, the label with the current zoom level is visible. The zoom level is displayed in percents. */ get show_zoom_label(): boolean set show_zoom_label(value: boolean) /** If `true`, buttons that allow to change and reset the zoom level are visible. */ get show_zoom_buttons(): boolean set show_zoom_buttons(value: boolean) /** If `true`, buttons that allow to configure grid and snapping options are visible. */ get show_grid_buttons(): boolean set show_grid_buttons(value: boolean) /** If `true`, the button to toggle the minimap is visible. */ get show_minimap_button(): boolean set show_minimap_button(value: boolean) /** If `true`, the button to automatically arrange graph nodes is visible. */ get show_arrange_button(): boolean set show_arrange_button(value: boolean) /** Emitted to the GraphEdit when the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode] is attempted to be created. */ readonly connection_request: Signal4 /** Emitted to the GraphEdit when the connection between [param from_port] of [param from_node] [GraphNode] and [param to_port] of [param to_node] [GraphNode] is attempted to be removed. */ readonly disconnection_request: Signal4 /** Emitted when user drags a connection from an output port into the empty space of the graph. */ readonly connection_to_empty: Signal3 /** Emitted when user drags a connection from an input port into the empty space of the graph. */ readonly connection_from_empty: Signal3 /** Emitted at the beginning of a connection drag. */ readonly connection_drag_started: Signal3 /** Emitted at the end of a connection drag. */ readonly connection_drag_ended: Signal0 /** Emitted when this [GraphEdit] captures a `ui_copy` action ([kbd]Ctrl + C[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be copied. */ readonly copy_nodes_request: Signal0 /** Emitted when this [GraphEdit] captures a `ui_cut` action ([kbd]Ctrl + X[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be cut. */ readonly cut_nodes_request: Signal0 /** Emitted when this [GraphEdit] captures a `ui_paste` action ([kbd]Ctrl + V[/kbd] by default). In general, this signal indicates that previously copied [GraphElement]s should be pasted. */ readonly paste_nodes_request: Signal0 /** Emitted when this [GraphEdit] captures a `ui_graph_duplicate` action ([kbd]Ctrl + D[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be duplicated. */ readonly duplicate_nodes_request: Signal0 /** Emitted when this [GraphEdit] captures a `ui_graph_delete` action ([kbd]Delete[/kbd] by default). * [param nodes] is an array of node names that should be removed. These usually include all selected nodes. */ readonly delete_nodes_request: Signal1 /** Emitted when the given [GraphElement] node is selected. */ readonly node_selected: Signal1 /** Emitted when the given [GraphElement] node is deselected. */ readonly node_deselected: Signal1 /** Emitted when the [GraphFrame] [param frame] is resized to [param new_rect]. */ readonly frame_rect_changed: Signal2 /** Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [param at_position] is the position of the mouse pointer when the signal is sent. */ readonly popup_request: Signal1 /** Emitted at the beginning of a [GraphElement]'s movement. */ readonly begin_node_move: Signal0 /** Emitted at the end of a [GraphElement]'s movement. */ readonly end_node_move: Signal0 /** Emitted when one or more [GraphElement]s are dropped onto the [GraphFrame] named [param frame], when they were not previously attached to any other one. * [param elements] is an array of [GraphElement]s to be attached. */ readonly graph_elements_linked_to_frame_request: Signal2 /** Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. */ readonly scroll_offset_changed: Signal1 } class GraphEditFilter = Record> extends Control { constructor(identifier?: any) } class GraphEditMinimap = Record> extends Control { constructor(identifier?: any) } /** A container that represents a basic element that can be placed inside a [GraphEdit] control. * * @link https://docs.godotengine.org/en/4.4/classes/class_graphelement.html */ class GraphElement = Record> extends Container { constructor(identifier?: any) /** The offset of the GraphElement, relative to the scroll offset of the [GraphEdit]. */ get position_offset(): Vector2 set position_offset(value: Vector2) /** If `true`, the user can resize the GraphElement. * * **Note:** Dragging the handle will only emit the [signal resize_request] and [signal resize_end] signals, the GraphElement needs to be resized manually. */ get resizable(): boolean set resizable(value: boolean) /** If `true`, the user can drag the GraphElement. */ get draggable(): boolean set draggable(value: boolean) /** If `true`, the user can select the GraphElement. */ get selectable(): boolean set selectable(value: boolean) /** If `true`, the GraphElement is selected. */ get selected(): boolean set selected(value: boolean) /** Emitted when the GraphElement is selected. */ readonly node_selected: Signal0 /** Emitted when the GraphElement is deselected. */ readonly node_deselected: Signal0 /** Emitted when displaying the GraphElement over other ones is requested. Happens on focusing (clicking into) the GraphElement. */ readonly raise_request: Signal0 /** Emitted when removing the GraphElement is requested. */ readonly delete_request: Signal0 /** Emitted when resizing the GraphElement is requested. Happens on dragging the resizer handle (see [member resizable]). */ readonly resize_request: Signal1 /** Emitted when releasing the mouse button after dragging the resizer handle (see [member resizable]). */ readonly resize_end: Signal1 /** Emitted when the GraphElement is dragged. */ readonly dragged: Signal2 /** Emitted when the GraphElement is moved. */ readonly position_offset_changed: Signal0 } /** GraphFrame is a special [GraphElement] that can be used to organize other [GraphElement]s inside a [GraphEdit]. * * @link https://docs.godotengine.org/en/4.4/classes/class_graphframe.html */ class GraphFrame = Record> extends GraphElement { constructor(identifier?: any) /** Returns the [HBoxContainer] used for the title bar, only containing a [Label] for displaying the title by default. * This can be used to add custom controls to the title bar such as option or close buttons. */ get_titlebar_hbox(): HBoxContainer /** Title of the frame. */ get title(): string set title(value: string) /** If `true`, the frame's rect will be adjusted automatically to enclose all attached [GraphElement]s. */ get autoshrink_enabled(): boolean set autoshrink_enabled(value: boolean) /** The margin around the attached nodes that is used to calculate the size of the frame when [member autoshrink_enabled] is `true`. */ get autoshrink_margin(): int64 set autoshrink_margin(value: int64) /** The margin inside the frame that can be used to drag the frame. */ get drag_margin(): int64 set drag_margin(value: int64) /** If `true`, the tint color will be used to tint the frame. */ get tint_color_enabled(): boolean set tint_color_enabled(value: boolean) /** The color of the frame when [member tint_color_enabled] is `true`. */ get tint_color(): Color set tint_color(value: Color) /** Emitted when [member autoshrink_enabled] or [member autoshrink_margin] changes. */ readonly autoshrink_changed: Signal0 } /** A container with connection ports, representing a node in a [GraphEdit]. * * @link https://docs.godotengine.org/en/4.4/classes/class_graphnode.html */ class GraphNode = Record> extends GraphElement { constructor(identifier?: any) /* gdvirtual */ _draw_port(slot_index: int64, position: Vector2i, left: boolean, color: Color): void /** Returns the [HBoxContainer] used for the title bar, only containing a [Label] for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons. */ get_titlebar_hbox(): HBoxContainer /** Sets properties of the slot with the given [param slot_index]. * If [param enable_left_port]/[param enable_right_port] is `true`, a port will appear and the slot will be able to be connected from this side. * With [param type_left]/[param type_right] an arbitrary type can be assigned to each port. Two ports can be connected if they share the same type, or if the connection between their types is allowed in the parent [GraphEdit] (see [method GraphEdit.add_valid_connection_type]). Keep in mind that the [GraphEdit] has the final say in accepting the connection. Type compatibility simply allows the [signal GraphEdit.connection_request] signal to be emitted. * Ports can be further customized using [param color_left]/[param color_right] and [param custom_icon_left]/[param custom_icon_right]. The color parameter adds a tint to the icon. The custom icon can be used to override the default port dot. * Additionally, [param draw_stylebox] can be used to enable or disable drawing of the background stylebox for each slot. See [theme_item slot]. * Individual properties can also be set using one of the `set_slot_*` methods. * * **Note:** This method only sets properties of the slot. To create the slot itself, add a [Control]-derived child to the GraphNode. */ set_slot(slot_index: int64, enable_left_port: boolean, type_left: int64, color_left: Color, enable_right_port: boolean, type_right: int64, color_right: Color, custom_icon_left: Texture2D = undefined, custom_icon_right: Texture2D = undefined, draw_stylebox: boolean = true): void /** Disables the slot with the given [param slot_index]. This will remove the corresponding input and output port from the GraphNode. */ clear_slot(slot_index: int64): void /** Disables all slots of the GraphNode. This will remove all input/output ports from the GraphNode. */ clear_all_slots(): void /** Returns `true` if left (input) side of the slot with the given [param slot_index] is enabled. */ is_slot_enabled_left(slot_index: int64): boolean /** Toggles the left (input) side of the slot with the given [param slot_index]. If [param enable] is `true`, a port will appear on the left side and the slot will be able to be connected from this side. */ set_slot_enabled_left(slot_index: int64, enable: boolean): void /** Sets the left (input) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs. */ set_slot_type_left(slot_index: int64, type: int64): void /** Returns the left (input) type of the slot with the given [param slot_index]. */ get_slot_type_left(slot_index: int64): int64 /** Sets the [Color] of the left (input) side of the slot with the given [param slot_index] to [param color]. */ set_slot_color_left(slot_index: int64, color: Color): void /** Returns the left (input) [Color] of the slot with the given [param slot_index]. */ get_slot_color_left(slot_index: int64): Color /** Sets the custom [Texture2D] of the left (input) side of the slot with the given [param slot_index] to [param custom_icon]. */ set_slot_custom_icon_left(slot_index: int64, custom_icon: Texture2D): void /** Returns the left (input) custom [Texture2D] of the slot with the given [param slot_index]. */ get_slot_custom_icon_left(slot_index: int64): Texture2D /** Returns `true` if right (output) side of the slot with the given [param slot_index] is enabled. */ is_slot_enabled_right(slot_index: int64): boolean /** Toggles the right (output) side of the slot with the given [param slot_index]. If [param enable] is `true`, a port will appear on the right side and the slot will be able to be connected from this side. */ set_slot_enabled_right(slot_index: int64, enable: boolean): void /** Sets the right (output) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs. */ set_slot_type_right(slot_index: int64, type: int64): void /** Returns the right (output) type of the slot with the given [param slot_index]. */ get_slot_type_right(slot_index: int64): int64 /** Sets the [Color] of the right (output) side of the slot with the given [param slot_index] to [param color]. */ set_slot_color_right(slot_index: int64, color: Color): void /** Returns the right (output) [Color] of the slot with the given [param slot_index]. */ get_slot_color_right(slot_index: int64): Color /** Sets the custom [Texture2D] of the right (output) side of the slot with the given [param slot_index] to [param custom_icon]. */ set_slot_custom_icon_right(slot_index: int64, custom_icon: Texture2D): void /** Returns the right (output) custom [Texture2D] of the slot with the given [param slot_index]. */ get_slot_custom_icon_right(slot_index: int64): Texture2D /** Returns `true` if the background [StyleBox] of the slot with the given [param slot_index] is drawn. */ is_slot_draw_stylebox(slot_index: int64): boolean /** Toggles the background [StyleBox] of the slot with the given [param slot_index]. */ set_slot_draw_stylebox(slot_index: int64, enable: boolean): void /** Returns the number of slots with an enabled input port. */ get_input_port_count(): int64 /** Returns the position of the input port with the given [param port_idx]. */ get_input_port_position(port_idx: int64): Vector2 /** Returns the type of the input port with the given [param port_idx]. */ get_input_port_type(port_idx: int64): int64 /** Returns the [Color] of the input port with the given [param port_idx]. */ get_input_port_color(port_idx: int64): Color /** Returns the corresponding slot index of the input port with the given [param port_idx]. */ get_input_port_slot(port_idx: int64): int64 /** Returns the number of slots with an enabled output port. */ get_output_port_count(): int64 /** Returns the position of the output port with the given [param port_idx]. */ get_output_port_position(port_idx: int64): Vector2 /** Returns the type of the output port with the given [param port_idx]. */ get_output_port_type(port_idx: int64): int64 /** Returns the [Color] of the output port with the given [param port_idx]. */ get_output_port_color(port_idx: int64): Color /** Returns the corresponding slot index of the output port with the given [param port_idx]. */ get_output_port_slot(port_idx: int64): int64 /** The text displayed in the GraphNode's title bar. */ get title(): string set title(value: string) /** If `true`, you can connect ports with different types, even if the connection was not explicitly allowed in the parent [GraphEdit]. */ get ignore_invalid_connection_type(): boolean set ignore_invalid_connection_type(value: boolean) /** Emitted when any GraphNode's slot is updated. */ readonly slot_updated: Signal1 } /** A container that arranges its child controls in a grid layout. * * @link https://docs.godotengine.org/en/4.4/classes/class_gridcontainer.html */ class GridContainer = Record> extends Container { constructor(identifier?: any) /** The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its Control-derived children to accommodate the new layout. */ get columns(): int64 set columns(value: int64) } /** Node for 3D tile-based maps. * * @link https://docs.godotengine.org/en/4.4/classes/class_gridmap.html */ class GridMap = Record> extends Node3D { /** Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]). */ static readonly INVALID_CELL_ITEM = -1 constructor(identifier?: any) /** Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32. */ set_collision_mask_value(layer_number: int64, value: boolean): void /** Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [param layer_number] between 1 and 32. */ get_collision_mask_value(layer_number: int64): boolean /** Based on [param value], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32. */ set_collision_layer_value(layer_number: int64, value: boolean): void /** Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [param layer_number] between 1 and 32. */ get_collision_layer_value(layer_number: int64): boolean /** Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes. */ set_navigation_map(navigation_map: RID): void /** Returns the [RID] of the navigation map this GridMap node uses for its cell baked navigation meshes. * This function returns always the map set on the GridMap node and not the map on the NavigationServer. If the map is changed directly with the NavigationServer API the GridMap node will not be aware of the map change. */ get_navigation_map(): RID /** Sets the mesh index for the cell referenced by its grid coordinates. * A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. * Optionally, the item's orientation can be passed. For valid orientation values, see [method get_orthogonal_index_from_basis]. */ set_cell_item(position: Vector3i, item: int64, orientation: int64 = 0): void /** The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned. */ get_cell_item(position: Vector3i): int64 /** The orientation of the cell at the given grid coordinates. `-1` is returned if the cell is empty. */ get_cell_item_orientation(position: Vector3i): int64 /** Returns the basis that gives the specified cell its orientation. */ get_cell_item_basis(position: Vector3i): Basis /** Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code. */ get_basis_with_orthogonal_index(index: int64): Basis /** This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code. */ get_orthogonal_index_from_basis(basis: Basis): int64 /** Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node3D.to_local] before passing it to this method. See also [method map_to_local]. */ local_to_map(local_position: Vector3): Vector3i /** Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use [method Node3D.to_global]. See also [method local_to_map]. */ map_to_local(map_position: Vector3i): Vector3 /** This method does nothing. */ resource_changed(resource: Resource): void /** Clear all cells. */ clear(): void /** Returns an array of [Vector3] with the non-empty cell coordinates in the grid map. */ get_used_cells(): GArray /** Returns an array of all cells with the given item index specified in [param item]. */ get_used_cells_by_item(item: int64): GArray /** Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in local space. */ get_meshes(): GArray /** Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap. */ get_bake_meshes(): GArray /** Returns [RID] of a baked mesh with the given [param idx]. */ get_bake_mesh_instance(idx: int64): RID /** Clears all baked meshes. See [method make_baked_meshes]. */ clear_baked_meshes(): void /** Bakes lightmap data for all meshes in the assigned [MeshLibrary]. */ make_baked_meshes(gen_lightmap_uv: boolean = false, lightmap_uv_texel_size: float64 = 0.1): void /** The assigned [MeshLibrary]. */ get mesh_library(): MeshLibrary set mesh_library(value: MeshLibrary) /** Overrides the default friction and bounce physics properties for the whole [GridMap]. */ get physics_material(): PhysicsMaterial set physics_material(value: PhysicsMaterial) /** The dimensions of the grid's cells. * This does not affect the size of the meshes. See [member cell_scale]. */ get cell_size(): Vector3 set cell_size(value: Vector3) /** The size of each octant measured in number of cells. This applies to all three axis. */ get cell_octant_size(): int64 set cell_octant_size(value: int64) /** If `true`, grid items are centered on the X axis. */ get cell_center_x(): boolean set cell_center_x(value: boolean) /** If `true`, grid items are centered on the Y axis. */ get cell_center_y(): boolean set cell_center_y(value: boolean) /** If `true`, grid items are centered on the Z axis. */ get cell_center_z(): boolean set cell_center_z(value: boolean) /** The scale of the cell items. * This does not affect the size of the grid cells themselves, only the items in them. This can be used to make cell items overlap their neighbors. */ get cell_scale(): float64 set cell_scale(value: float64) /** The physics layers this GridMap is in. * GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them. */ get collision_layer(): int64 set collision_layer(value: int64) /** The physics layers this GridMap detects collisions in. See [url=https://docs.godotengine.org/en/4.4/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. */ get collision_mask(): int64 set collision_mask(value: int64) /** The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. */ get collision_priority(): float64 set collision_priority(value: float64) /** If `true`, this GridMap creates a navigation region for each cell that uses a [member mesh_library] item with a navigation mesh. The created navigation region will use the navigation layers bitmask assigned to the [MeshLibrary]'s item. */ get bake_navigation(): boolean set bake_navigation(value: boolean) /** Emitted when [member cell_size] changes. */ readonly cell_size_changed: Signal1 /** Emitted when the [MeshLibrary] of this GridMap changes. */ readonly changed: Signal0 } class GridMapEditor = Record> extends VBoxContainer { constructor(identifier?: any) _configure(): void _set_selection(_unnamed_arg0: boolean, _unnamed_arg1: Vector3, _unnamed_arg2: Vector3): void } /** Editor for [GridMap] nodes. * * @link https://docs.godotengine.org/en/4.4/classes/class_gridmapeditorplugin.html */ class GridMapEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) /** Returns the [GridMap] node currently edited by the grid map editor. */ get_current_grid_map(): GridMap /** Selects the cells inside the given bounds from [param begin] to [param end]. */ set_selection(begin: Vector3i, end: Vector3i): void /** Deselects any currently selected cells. */ clear_selection(): void /** Returns the cell coordinate bounds of the current selection. Use [method has_selection] to check if there is an active selection. */ get_selection(): AABB /** Returns `true` if there are selected cells. */ has_selection(): boolean /** Returns an array of [Vector3i]s with the selected cells' coordinates. */ get_selected_cells(): GArray /** Selects the [MeshLibrary] item with the given index in the grid map editor's palette. If a negative index is given, no item will be selected. If a value greater than the last index is given, the last item will be selected. * * **Note:** The indices might not be in the same order as they appear in the editor's interface. */ set_selected_palette_item(item: int64): void /** Returns the index of the selected [MeshLibrary] item in the grid map editor's palette or `-1` if no item is selected. * * **Note:** The indices might not be in the same order as they appear in the editor's interface. */ get_selected_palette_item(): int64 } /** A physics joint that restricts the movement of two 2D physics bodies to a fixed axis. * * @link https://docs.godotengine.org/en/4.4/classes/class_groovejoint2d.html */ class GrooveJoint2D = Record> extends Joint2D { constructor(identifier?: any) /** The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis. */ get length(): float64 set length(value: float64) /** The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove). */ get initial_offset(): float64 set initial_offset(value: float64) } class GroupSettingsEditor = Record> extends VBoxContainer { constructor(identifier?: any) remove_references(_unnamed_arg0: StringName): void rename_references(_unnamed_arg0: StringName, _unnamed_arg1: StringName): void update_groups(): void readonly group_changed: Signal0 } class GroupsEditor = Record> extends VBoxContainer { constructor(identifier?: any) _update_tree(): void _update_groups(): void _update_groups_and_tree(): void _add_scene_group(_unnamed_arg0: string): void _rename_scene_group(_unnamed_arg0: string, _unnamed_arg1: string): void _remove_scene_group(_unnamed_arg0: string): void _set_group_checked(_unnamed_arg0: string, _unnamed_arg1: boolean): void } /** A container that arranges its child controls horizontally. * * @link https://docs.godotengine.org/en/4.4/classes/class_hboxcontainer.html */ class HBoxContainer = Record> extends BoxContainer { constructor(identifier?: any) } /** A container that arranges its child controls horizontally and wraps them around at the borders. * * @link https://docs.godotengine.org/en/4.4/classes/class_hflowcontainer.html */ class HFlowContainer = Record> extends FlowContainer { constructor(identifier?: any) } /** Used to create an HMAC for a message using a key. * * @link https://docs.godotengine.org/en/4.4/classes/class_hmaccontext.html */ class HMACContext extends RefCounted { constructor(identifier?: any) /** Initializes the HMACContext. This method cannot be called again on the same HMACContext until [method finish] has been called. */ start(hash_type: HashingContext.HashType, key: PackedByteArray | byte[] | ArrayBuffer): GError /** Updates the message to be HMACed. This can be called multiple times before [method finish] is called to append [param data] to the message, but cannot be called until [method start] has been called. */ update(data: PackedByteArray | byte[] | ArrayBuffer): GError /** Returns the resulting HMAC. If the HMAC failed, an empty [PackedByteArray] is returned. */ finish(): PackedByteArray } /** A horizontal scrollbar that goes from left (min) to right (max). * * @link https://docs.godotengine.org/en/4.4/classes/class_hscrollbar.html */ class HScrollBar = Record> extends ScrollBar { constructor(identifier?: any) } /** A horizontal line used for separating other controls. * * @link https://docs.godotengine.org/en/4.4/classes/class_hseparator.html */ class HSeparator = Record> extends Separator { constructor(identifier?: any) } /** A horizontal slider that goes from left (min) to right (max). * * @link https://docs.godotengine.org/en/4.4/classes/class_hslider.html */ class HSlider = Record> extends Slider { constructor(identifier?: any) } /** A container that splits two child controls horizontally and provides a grabber for adjusting the split ratio. * * @link https://docs.godotengine.org/en/4.4/classes/class_hsplitcontainer.html */ class HSplitContainer = Record> extends SplitContainer { constructor(identifier?: any) } namespace HTTPClient { enum Method { /** HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. */ METHOD_GET = 0, /** HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists. */ METHOD_HEAD = 1, /** HTTP POST method. The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server. This is often used for forms and submitting data or uploading files. */ METHOD_POST = 2, /** HTTP PUT method. The PUT method asks to replace all current representations of the target resource with the request payload. (You can think of POST as "create or update" and PUT as "update", although many services tend to not make a clear distinction or change their meaning). */ METHOD_PUT = 3, /** HTTP DELETE method. The DELETE method requests to delete the specified resource. */ METHOD_DELETE = 4, /** HTTP OPTIONS method. The OPTIONS method asks for a description of the communication options for the target resource. Rarely used. */ METHOD_OPTIONS = 5, /** HTTP TRACE method. The TRACE method performs a message loop-back test along the path to the target resource. Returns the entire HTTP request received in the response body. Rarely used. */ METHOD_TRACE = 6, /** HTTP CONNECT method. The CONNECT method establishes a tunnel to the server identified by the target resource. Rarely used. */ METHOD_CONNECT = 7, /** HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. */ METHOD_PATCH = 8, /** Represents the size of the [enum Method] enum. */ METHOD_MAX = 9, } enum Status { /** Status: Disconnected from the server. */ STATUS_DISCONNECTED = 0, /** Status: Currently resolving the hostname for the given URL into an IP. */ STATUS_RESOLVING = 1, /** Status: DNS failure: Can't resolve the hostname for the given URL. */ STATUS_CANT_RESOLVE = 2, /** Status: Currently connecting to server. */ STATUS_CONNECTING = 3, /** Status: Can't connect to the server. */ STATUS_CANT_CONNECT = 4, /** Status: Connection established. */ STATUS_CONNECTED = 5, /** Status: Currently sending request. */ STATUS_REQUESTING = 6, /** Status: HTTP body received. */ STATUS_BODY = 7, /** Status: Error in HTTP connection. */ STATUS_CONNECTION_ERROR = 8, /** Status: Error in TLS handshake. */ STATUS_TLS_HANDSHAKE_ERROR = 9, } enum ResponseCode { /** HTTP status code `100 Continue`. Interim response that indicates everything so far is OK and that the client should continue with the request (or ignore this status if already finished). */ RESPONSE_CONTINUE = 100, /** HTTP status code `101 Switching Protocol`. Sent in response to an `Upgrade` request header by the client. Indicates the protocol the server is switching to. */ RESPONSE_SWITCHING_PROTOCOLS = 101, /** HTTP status code `102 Processing` (WebDAV). Indicates that the server has received and is processing the request, but no response is available yet. */ RESPONSE_PROCESSING = 102, /** HTTP status code `200 OK`. The request has succeeded. Default response for successful requests. Meaning varies depending on the request: * - [constant METHOD_GET]: The resource has been fetched and is transmitted in the message body. * - [constant METHOD_HEAD]: The entity headers are in the message body. * - [constant METHOD_POST]: The resource describing the result of the action is transmitted in the message body. * - [constant METHOD_TRACE]: The message body contains the request message as received by the server. */ RESPONSE_OK = 200, /** HTTP status code `201 Created`. The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request. */ RESPONSE_CREATED = 201, /** HTTP status code `202 Accepted`. The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing. */ RESPONSE_ACCEPTED = 202, /** HTTP status code `203 Non-Authoritative Information`. This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response. */ RESPONSE_NON_AUTHORITATIVE_INFORMATION = 203, /** HTTP status code `204 No Content`. There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones. */ RESPONSE_NO_CONTENT = 204, /** HTTP status code `205 Reset Content`. The server has fulfilled the request and desires that the client resets the "document view" that caused the request to be sent to its original state as received from the origin server. */ RESPONSE_RESET_CONTENT = 205, /** HTTP status code `206 Partial Content`. This response code is used because of a range header sent by the client to separate download into multiple streams. */ RESPONSE_PARTIAL_CONTENT = 206, /** HTTP status code `207 Multi-Status` (WebDAV). A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. */ RESPONSE_MULTI_STATUS = 207, /** HTTP status code `208 Already Reported` (WebDAV). Used inside a DAV: propstat response element to avoid enumerating the internal members of multiple bindings to the same collection repeatedly. */ RESPONSE_ALREADY_REPORTED = 208, /** HTTP status code `226 IM Used` (WebDAV). The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */ RESPONSE_IM_USED = 226, /** HTTP status code `300 Multiple Choice`. The request has more than one possible responses and there is no standardized way to choose one of the responses. User-agent or user should choose one of them. */ RESPONSE_MULTIPLE_CHOICES = 300, /** HTTP status code `301 Moved Permanently`. Redirection. This response code means the URI of requested resource has been changed. The new URI is usually included in the response. */ RESPONSE_MOVED_PERMANENTLY = 301, /** HTTP status code `302 Found`. Temporary redirection. This response code means the URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests. */ RESPONSE_FOUND = 302, /** HTTP status code `303 See Other`. The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. */ RESPONSE_SEE_OTHER = 303, /** HTTP status code `304 Not Modified`. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to `false`. */ RESPONSE_NOT_MODIFIED = 304, /** HTTP status code `305 Use Proxy`. */ RESPONSE_USE_PROXY = 305, /** HTTP status code `306 Switch Proxy`. */ RESPONSE_SWITCH_PROXY = 306, /** HTTP status code `307 Temporary Redirect`. The target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI. */ RESPONSE_TEMPORARY_REDIRECT = 307, /** HTTP status code `308 Permanent Redirect`. The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs. */ RESPONSE_PERMANENT_REDIRECT = 308, /** HTTP status code `400 Bad Request`. The request was invalid. The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, invalid request contents, or deceptive request routing). */ RESPONSE_BAD_REQUEST = 400, /** HTTP status code `401 Unauthorized`. Credentials required. The request has not been applied because it lacks valid authentication credentials for the target resource. */ RESPONSE_UNAUTHORIZED = 401, /** HTTP status code `402 Payment Required`. This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems, however this is not currently used. */ RESPONSE_PAYMENT_REQUIRED = 402, /** HTTP status code `403 Forbidden`. The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike `401`, the client's identity is known to the server. */ RESPONSE_FORBIDDEN = 403, /** HTTP status code `404 Not Found`. The server can not find requested resource. Either the URL is not recognized or the endpoint is valid but the resource itself does not exist. May also be sent instead of 403 to hide existence of a resource if the client is not authorized. */ RESPONSE_NOT_FOUND = 404, /** HTTP status code `405 Method Not Allowed`. The request's HTTP method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code. */ RESPONSE_METHOD_NOT_ALLOWED = 405, /** HTTP status code `406 Not Acceptable`. The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request. Used when negotiation content. */ RESPONSE_NOT_ACCEPTABLE = 406, /** HTTP status code `407 Proxy Authentication Required`. Similar to 401 Unauthorized, but it indicates that the client needs to authenticate itself in order to use a proxy. */ RESPONSE_PROXY_AUTHENTICATION_REQUIRED = 407, /** HTTP status code `408 Request Timeout`. The server did not receive a complete request message within the time that it was prepared to wait. */ RESPONSE_REQUEST_TIMEOUT = 408, /** HTTP status code `409 Conflict`. The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request. */ RESPONSE_CONFLICT = 409, /** HTTP status code `410 Gone`. The target resource is no longer available at the origin server and this condition is likely permanent. */ RESPONSE_GONE = 410, /** HTTP status code `411 Length Required`. The server refuses to accept the request without a defined Content-Length header. */ RESPONSE_LENGTH_REQUIRED = 411, /** HTTP status code `412 Precondition Failed`. One or more conditions given in the request header fields evaluated to `false` when tested on the server. */ RESPONSE_PRECONDITION_FAILED = 412, /** HTTP status code `413 Entity Too Large`. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. */ RESPONSE_REQUEST_ENTITY_TOO_LARGE = 413, /** HTTP status code `414 Request-URI Too Long`. The server is refusing to service the request because the request-target is longer than the server is willing to interpret. */ RESPONSE_REQUEST_URI_TOO_LONG = 414, /** HTTP status code `415 Unsupported Media Type`. The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource. */ RESPONSE_UNSUPPORTED_MEDIA_TYPE = 415, /** HTTP status code `416 Requested Range Not Satisfiable`. None of the ranges in the request's Range header field overlap the current extent of the selected resource or the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges. */ RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE = 416, /** HTTP status code `417 Expectation Failed`. The expectation given in the request's Expect header field could not be met by at least one of the inbound servers. */ RESPONSE_EXPECTATION_FAILED = 417, /** HTTP status code `418 I'm A Teapot`. Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout. */ RESPONSE_IM_A_TEAPOT = 418, /** HTTP status code `421 Misdirected Request`. The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI. */ RESPONSE_MISDIRECTED_REQUEST = 421, /** HTTP status code `422 Unprocessable Entity` (WebDAV). The server understands the content type of the request entity (hence a 415 Unsupported Media Type status code is inappropriate), and the syntax of the request entity is correct (thus a 400 Bad Request status code is inappropriate) but was unable to process the contained instructions. */ RESPONSE_UNPROCESSABLE_ENTITY = 422, /** HTTP status code `423 Locked` (WebDAV). The source or destination resource of a method is locked. */ RESPONSE_LOCKED = 423, /** HTTP status code `424 Failed Dependency` (WebDAV). The method could not be performed on the resource because the requested action depended on another action and that action failed. */ RESPONSE_FAILED_DEPENDENCY = 424, /** HTTP status code `426 Upgrade Required`. The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */ RESPONSE_UPGRADE_REQUIRED = 426, /** HTTP status code `428 Precondition Required`. The origin server requires the request to be conditional. */ RESPONSE_PRECONDITION_REQUIRED = 428, /** HTTP status code `429 Too Many Requests`. The user has sent too many requests in a given amount of time (see "rate limiting"). Back off and increase time between requests or try again later. */ RESPONSE_TOO_MANY_REQUESTS = 429, /** HTTP status code `431 Request Header Fields Too Large`. The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields. */ RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE = 431, /** HTTP status code `451 Response Unavailable For Legal Reasons`. The server is denying access to the resource as a consequence of a legal demand. */ RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS = 451, /** HTTP status code `500 Internal Server Error`. The server encountered an unexpected condition that prevented it from fulfilling the request. */ RESPONSE_INTERNAL_SERVER_ERROR = 500, /** HTTP status code `501 Not Implemented`. The server does not support the functionality required to fulfill the request. */ RESPONSE_NOT_IMPLEMENTED = 501, /** HTTP status code `502 Bad Gateway`. The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. Usually returned by load balancers or proxies. */ RESPONSE_BAD_GATEWAY = 502, /** HTTP status code `503 Service Unavailable`. The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. Try again later. */ RESPONSE_SERVICE_UNAVAILABLE = 503, /** HTTP status code `504 Gateway Timeout`. The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. Usually returned by load balancers or proxies. */ RESPONSE_GATEWAY_TIMEOUT = 504, /** HTTP status code `505 HTTP Version Not Supported`. The server does not support, or refuses to support, the major version of HTTP that was used in the request message. */ RESPONSE_HTTP_VERSION_NOT_SUPPORTED = 505, /** HTTP status code `506 Variant Also Negotiates`. The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process. */ RESPONSE_VARIANT_ALSO_NEGOTIATES = 506, /** HTTP status code `507 Insufficient Storage`. The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */ RESPONSE_INSUFFICIENT_STORAGE = 507, /** HTTP status code `508 Loop Detected`. The server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". This status indicates that the entire operation failed. */ RESPONSE_LOOP_DETECTED = 508, /** HTTP status code `510 Not Extended`. The policy for accessing the resource has not been met in the request. The server should send back all the information necessary for the client to issue an extended request. */ RESPONSE_NOT_EXTENDED = 510, /** HTTP status code `511 Network Authentication Required`. The client needs to authenticate to gain network access. */ RESPONSE_NETWORK_AUTH_REQUIRED = 511, } } /** Low-level hyper-text transfer protocol client. * * @link https://docs.godotengine.org/en/4.4/classes/class_httpclient.html */ class HTTPClient extends RefCounted { constructor(identifier?: any) /** Connects to a host. This needs to be done before any requests are sent. * If no [param port] is specified (or `-1` is used), it is automatically set to 80 for HTTP and 443 for HTTPS. You can pass the optional [param tls_options] parameter to customize the trusted certification authorities, or the common name verification when using HTTPS. See [method TLSOptions.client] and [method TLSOptions.client_unsafe]. */ connect_to_host(host: string, port: int64 = -1, tls_options: TLSOptions = undefined): GError /** Sends a raw request to the connected host. * The URL parameter is usually just the part after the host, so for `https://example.com/index.php`, it is `/index.php`. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, `*` is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component (`host:port`). * Headers are HTTP request headers. For available HTTP methods, see [enum Method]. * Sends the body data raw, as a byte array and does not encode it in any way. */ request_raw(method: HTTPClient.Method, url: string, headers: PackedStringArray | string[], body: PackedByteArray | byte[] | ArrayBuffer): GError /** Sends a request to the connected host. * The URL parameter is usually just the part after the host, so for `https://example.com/index.php`, it is `/index.php`. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, `*` is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component (`host:port`). * Headers are HTTP request headers. For available HTTP methods, see [enum Method]. * To create a POST request with query strings to push to the server, do: * * * **Note:** The [param body] parameter is ignored if [param method] is [constant HTTPClient.METHOD_GET]. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See [method String.uri_encode] for an example. */ request(method: HTTPClient.Method, url: string, headers: PackedStringArray | string[], body: string = ''): GError /** Closes the current connection, allowing reuse of this [HTTPClient]. */ close(): void /** If `true`, this [HTTPClient] has a response available. */ has_response(): boolean /** If `true`, this [HTTPClient] has a response that is chunked. */ is_response_chunked(): boolean /** Returns the response's HTTP status code. */ get_response_code(): int64 /** Returns the response headers. */ get_response_headers(): PackedStringArray /** Returns all response headers as a [Dictionary]. Each entry is composed by the header name, and a [String] containing the values separated by `"; "`. The casing is kept the same as the headers were received. * */ get_response_headers_as_dictionary(): GDictionary /** Returns the response's body length. * * **Note:** Some Web servers may not send a body length. In this case, the value returned will be `-1`. If using chunked transfer encoding, the body length will also be `-1`. * * **Note:** This function always returns `-1` on the Web platform due to browsers limitations. */ get_response_body_length(): int64 /** Reads one chunk from the response. */ read_response_body_chunk(): PackedByteArray /** Returns a [enum Status] constant. Need to call [method poll] in order to get status updates. */ get_status(): HTTPClient.Status /** This needs to be called in order to have any request processed. Check results with [method get_status]. */ poll(): GError /** Sets the proxy server for HTTP requests. * The proxy server is unset if [param host] is empty or [param port] is -1. */ set_http_proxy(host: string, port: int64): void /** Sets the proxy server for HTTPS requests. * The proxy server is unset if [param host] is empty or [param port] is -1. */ set_https_proxy(host: string, port: int64): void /** Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: * * Furthermore, if a key has a `null` value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. * */ query_string_from_dict(fields: GDictionary): string /** If `true`, execution will block until all data is read from the response. */ get blocking_mode_enabled(): boolean set blocking_mode_enabled(value: boolean) /** The connection to use for this client. */ get connection(): StreamPeer set connection(value: StreamPeer) /** The size of the buffer used and maximum bytes to read per iteration. See [method read_response_body_chunk]. */ get read_chunk_size(): int64 set read_chunk_size(value: int64) } namespace HTTPRequest { enum Result { /** Request successful. */ RESULT_SUCCESS = 0, /** Request failed due to a mismatch between the expected and actual chunked body size during transfer. Possible causes include network errors, server misconfiguration, or issues with chunked encoding. */ RESULT_CHUNKED_BODY_SIZE_MISMATCH = 1, /** Request failed while connecting. */ RESULT_CANT_CONNECT = 2, /** Request failed while resolving. */ RESULT_CANT_RESOLVE = 3, /** Request failed due to connection (read/write) error. */ RESULT_CONNECTION_ERROR = 4, /** Request failed on TLS handshake. */ RESULT_TLS_HANDSHAKE_ERROR = 5, /** Request does not have a response (yet). */ RESULT_NO_RESPONSE = 6, /** Request exceeded its maximum size limit, see [member body_size_limit]. */ RESULT_BODY_SIZE_LIMIT_EXCEEDED = 7, /** Request failed due to an error while decompressing the response body. Possible causes include unsupported or incorrect compression format, corrupted data, or incomplete transfer. */ RESULT_BODY_DECOMPRESS_FAILED = 8, /** Request failed (currently unused). */ RESULT_REQUEST_FAILED = 9, /** HTTPRequest couldn't open the download file. */ RESULT_DOWNLOAD_FILE_CANT_OPEN = 10, /** HTTPRequest couldn't write to the download file. */ RESULT_DOWNLOAD_FILE_WRITE_ERROR = 11, /** Request reached its maximum redirect limit, see [member max_redirects]. */ RESULT_REDIRECT_LIMIT_REACHED = 12, /** Request failed due to a timeout. If you expect requests to take a long time, try increasing the value of [member timeout] or setting it to `0.0` to remove the timeout completely. */ RESULT_TIMEOUT = 13, } } /** A node with the ability to send HTTP(S) requests. * * @link https://docs.godotengine.org/en/4.4/classes/class_httprequest.html */ class HTTPRequest = Record> extends Node { constructor(identifier?: any) /** Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. * Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. * * **Note:** When [param method] is [constant HTTPClient.METHOD_GET], the payload sent via [param request_data] might be ignored by the server or even cause the server to reject the request (check [url=https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.1]RFC 7231 section 4.3.1[/url] for more details). As a workaround, you can send data as a query string in the URL (see [method String.uri_encode] for an example). * * **Note:** It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. */ request(url: string, custom_headers: PackedStringArray | string[] = [], method: HTTPClient.Method = 0, request_data: string = ''): GError /** Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. * Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. */ request_raw(url: string, custom_headers: PackedStringArray | string[] = [], method: HTTPClient.Method = 0, request_data_raw: PackedByteArray | byte[] | ArrayBuffer = []): GError /** Cancels the current request. */ cancel_request(): void /** Sets the [TLSOptions] to be used when connecting to an HTTPS server. See [method TLSOptions.client]. */ set_tls_options(client_options: TLSOptions): void /** Returns the current status of the underlying [HTTPClient]. See [enum HTTPClient.Status]. */ get_http_client_status(): HTTPClient.Status /** Returns the number of bytes this HTTPRequest downloaded. */ get_downloaded_bytes(): int64 /** Returns the response body length. * * **Note:** Some Web servers may not send a body length. In this case, the value returned will be `-1`. If using chunked transfer encoding, the body length will also be `-1`. */ get_body_size(): int64 /** Sets the proxy server for HTTP requests. * The proxy server is unset if [param host] is empty or [param port] is -1. */ set_http_proxy(host: string, port: int64): void /** Sets the proxy server for HTTPS requests. * The proxy server is unset if [param host] is empty or [param port] is -1. */ set_https_proxy(host: string, port: int64): void /** The file to download into. Will output any received file into it. */ get download_file(): string set download_file(value: string) /** The size of the buffer used and maximum bytes to read per iteration. See [member HTTPClient.read_chunk_size]. * Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds. */ get download_chunk_size(): int64 set download_chunk_size(value: int64) /** If `true`, multithreading is used to improve performance. */ get use_threads(): boolean set use_threads(value: boolean) /** If `true`, this header will be added to each request: `Accept-Encoding: gzip, deflate` telling servers that it's okay to compress response bodies. * Any Response body declaring a `Content-Encoding` of either `gzip` or `deflate` will then be automatically decompressed, and the uncompressed bytes will be delivered via [signal request_completed]. * If the user has specified their own `Accept-Encoding` header, then no header will be added regardless of [member accept_gzip]. * If `false` no header will be added, and no decompression will be performed on response bodies. The raw bytes of the response body will be returned via [signal request_completed]. */ get accept_gzip(): boolean set accept_gzip(value: boolean) /** Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. */ get body_size_limit(): int64 set body_size_limit(value: int64) /** Maximum number of allowed redirects. */ get max_redirects(): int64 set max_redirects(value: int64) /** The duration to wait in seconds before a request times out. If [member timeout] is set to `0.0` then the request will never time out. For simple requests, such as communication with a REST API, it is recommended that [member timeout] is set to a value suitable for the server response time (e.g. between `1.0` and `10.0`). This will help prevent unwanted timeouts caused by variation in server response times while still allowing the application to detect when a request has timed out. For larger requests such as file downloads it is suggested the [member timeout] be set to `0.0`, disabling the timeout functionality. This will help to prevent large transfers from failing due to exceeding the timeout value. */ get timeout(): float64 set timeout(value: float64) /** Emitted when a request is completed. */ readonly request_completed: Signal4 } namespace HashingContext { enum HashType { /** Hashing algorithm: MD5. */ HASH_MD5 = 0, /** Hashing algorithm: SHA-1. */ HASH_SHA1 = 1, /** Hashing algorithm: SHA-256. */ HASH_SHA256 = 2, } } /** Provides functionality for computing cryptographic hashes chunk by chunk. * * @link https://docs.godotengine.org/en/4.4/classes/class_hashingcontext.html */ class HashingContext extends RefCounted { constructor(identifier?: any) /** Starts a new hash computation of the given [param type] (e.g. [constant HASH_SHA256] to start computation of an SHA-256). */ start(type: HashingContext.HashType): GError /** Updates the computation with the given [param chunk] of data. */ update(chunk: PackedByteArray | byte[] | ArrayBuffer): GError /** Closes the current context, and return the computed hash. */ finish(): PackedByteArray } /** A 3D height map shape used for physics collision. * * @link https://docs.godotengine.org/en/4.4/classes/class_heightmapshape3d.html */ class HeightMapShape3D extends Shape3D { constructor(identifier?: any) /** Returns the smallest height value found in [member map_data]. Recalculates only when [member map_data] changes. */ get_min_height(): float64 /** Returns the largest height value found in [member map_data]. Recalculates only when [member map_data] changes. */ get_max_height(): float64 /** Updates [member map_data] with data read from an [Image] reference. Automatically resizes heightmap [member map_width] and [member map_depth] to fit the full image width and height. * The image needs to be in either [constant Image.FORMAT_RF] (32 bit), [constant Image.FORMAT_RH] (16 bit), or [constant Image.FORMAT_R8] (8 bit). * Each image pixel is read in as a float on the range from `0.0` (black pixel) to `1.0` (white pixel). This range value gets remapped to [param height_min] and [param height_max] to form the final height value. */ update_map_data_from_image(image: Image, height_min: float64, height_max: float64): void /** Number of vertices in the width of the height map. Changing this will resize the [member map_data]. */ get map_width(): int64 set map_width(value: int64) /** Number of vertices in the depth of the height map. Changing this will resize the [member map_data]. */ get map_depth(): int64 set map_depth(value: int64) /** Height map data. The array's size must be equal to [member map_width] multiplied by [member map_depth]. */ get map_data(): PackedFloat32Array set map_data(value: PackedFloat32Array | float32[]) } namespace HingeJoint3D { enum Param { /** The speed with which the two bodies get pulled together when they move in different directions. */ PARAM_BIAS = 0, /** The maximum rotation. Only active if [member angular_limit/enable] is `true`. */ PARAM_LIMIT_UPPER = 1, /** The minimum rotation. Only active if [member angular_limit/enable] is `true`. */ PARAM_LIMIT_LOWER = 2, /** The speed with which the rotation across the axis perpendicular to the hinge gets corrected. */ PARAM_LIMIT_BIAS = 3, PARAM_LIMIT_SOFTNESS = 4, /** The lower this value, the more the rotation gets slowed down. */ PARAM_LIMIT_RELAXATION = 5, /** Target speed for the motor. */ PARAM_MOTOR_TARGET_VELOCITY = 6, /** Maximum acceleration for the motor. */ PARAM_MOTOR_MAX_IMPULSE = 7, /** Represents the size of the [enum Param] enum. */ PARAM_MAX = 8, } enum Flag { /** If `true`, the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. */ FLAG_USE_LIMIT = 0, /** When activated, a motor turns the hinge. */ FLAG_ENABLE_MOTOR = 1, /** Represents the size of the [enum Flag] enum. */ FLAG_MAX = 2, } } /** A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body. * * @link https://docs.godotengine.org/en/4.4/classes/class_hingejoint3d.html */ class HingeJoint3D = Record> extends Joint3D { constructor(identifier?: any) /** Sets the value of the specified parameter. */ set_param(param: HingeJoint3D.Param, value: float64): void /** Returns the value of the specified parameter. */ get_param(param: HingeJoint3D.Param): float64 /** If `true`, enables the specified flag. */ set_flag(flag: HingeJoint3D.Flag, enabled: boolean): void /** Returns the value of the specified flag. */ get_flag(flag: HingeJoint3D.Flag): boolean /** The speed with which the two bodies get pulled together when they move in different directions. */ get "params/bias"(): float64 set "params/bias"(value: float64) /** If `true`, the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. */ get "angular_limit/enable"(): boolean set "angular_limit/enable"(value: boolean) /** The maximum rotation. Only active if [member angular_limit/enable] is `true`. */ get "angular_limit/upper"(): float64 set "angular_limit/upper"(value: float64) /** The minimum rotation. Only active if [member angular_limit/enable] is `true`. */ get "angular_limit/lower"(): float64 set "angular_limit/lower"(value: float64) /** The speed with which the rotation across the axis perpendicular to the hinge gets corrected. */ get "angular_limit/bias"(): float64 set "angular_limit/bias"(value: float64) get "angular_limit/softness"(): float64 set "angular_limit/softness"(value: float64) /** The lower this value, the more the rotation gets slowed down. */ get "angular_limit/relaxation"(): float64 set "angular_limit/relaxation"(value: float64) /** When activated, a motor turns the hinge. */ get "motor/enable"(): boolean set "motor/enable"(value: boolean) /** Target speed for the motor. */ get "motor/target_velocity"(): float64 set "motor/target_velocity"(value: float64) /** Maximum acceleration for the motor. */ get "motor/max_impulse"(): float64 set "motor/max_impulse"(value: float64) } class HistoryDock = Record> extends VBoxContainer { constructor(identifier?: any) _save_layout_to_config(_unnamed_arg0: ConfigFile, _unnamed_arg1: string): void _load_layout_from_config(_unnamed_arg0: ConfigFile, _unnamed_arg1: string): void } namespace Image { enum Format { /** Texture format with a single 8-bit depth representing luminance. */ FORMAT_L8 = 0, /** OpenGL texture format with two values, luminance and alpha each stored with 8 bits. */ FORMAT_LA8 = 1, /** OpenGL texture format `RED` with a single component and a bitdepth of 8. */ FORMAT_R8 = 2, /** OpenGL texture format `RG` with two components and a bitdepth of 8 for each. */ FORMAT_RG8 = 3, /** OpenGL texture format `RGB` with three components, each with a bitdepth of 8. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_RGB8 = 4, /** OpenGL texture format `RGBA` with four components, each with a bitdepth of 8. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_RGBA8 = 5, /** OpenGL texture format `RGBA` with four components, each with a bitdepth of 4. */ FORMAT_RGBA4444 = 6, /** OpenGL texture format `RGB` with three components. Red and blue have a bitdepth of 5, and green has a bitdepth of 6. */ FORMAT_RGB565 = 7, /** OpenGL texture format `GL_R32F` where there's one component, a 32-bit floating-point value. */ FORMAT_RF = 8, /** OpenGL texture format `GL_RG32F` where there are two components, each a 32-bit floating-point values. */ FORMAT_RGF = 9, /** OpenGL texture format `GL_RGB32F` where there are three components, each a 32-bit floating-point values. */ FORMAT_RGBF = 10, /** OpenGL texture format `GL_RGBA32F` where there are four components, each a 32-bit floating-point values. */ FORMAT_RGBAF = 11, /** OpenGL texture format `GL_R16F` where there's one component, a 16-bit "half-precision" floating-point value. */ FORMAT_RH = 12, /** OpenGL texture format `GL_RG16F` where there are two components, each a 16-bit "half-precision" floating-point value. */ FORMAT_RGH = 13, /** OpenGL texture format `GL_RGB16F` where there are three components, each a 16-bit "half-precision" floating-point value. */ FORMAT_RGBH = 14, /** OpenGL texture format `GL_RGBA16F` where there are four components, each a 16-bit "half-precision" floating-point value. */ FORMAT_RGBAH = 15, /** A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single 5-bit exponent. */ FORMAT_RGBE9995 = 16, /** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_DXT1 = 17, /** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_DXT3 = 18, /** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparent gradients compared to DXT3. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_DXT5 = 19, /** Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. */ FORMAT_RGTC_R = 20, /** Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. */ FORMAT_RGTC_RG = 21, /** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned normalized RGBA components. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_BPTC_RGBA = 22, /** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with signed floating-point RGB components. */ FORMAT_BPTC_RGBF = 23, /** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned floating-point RGB components. */ FORMAT_BPTC_RGBFU = 24, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1]Ericsson Texture Compression format 1[/url], also referred to as "ETC1", and is part of the OpenGL ES graphics standard. This format cannot store an alpha channel. */ FORMAT_ETC = 25, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`R11_EAC` variant), which provides one channel of unsigned data. */ FORMAT_ETC2_R11 = 26, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`SIGNED_R11_EAC` variant), which provides one channel of signed data. */ FORMAT_ETC2_R11S = 27, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RG11_EAC` variant), which provides two channels of unsigned data. */ FORMAT_ETC2_RG11 = 28, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`SIGNED_RG11_EAC` variant), which provides two channels of signed data. */ FORMAT_ETC2_RG11S = 29, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGB8` variant), which is a follow-up of ETC1 and compresses RGB888 data. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_ETC2_RGB8 = 30, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGBA8`variant), which compresses RGBA8888 data with full alpha support. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_ETC2_RGBA8 = 31, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGB8_PUNCHTHROUGH_ALPHA1` variant), which compresses RGBA data to make alpha either fully transparent or fully opaque. * * **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed. */ FORMAT_ETC2_RGB8A1 = 32, /** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGBA8` variant), which compresses RA data and interprets it as two channels (red and green). See also [constant FORMAT_ETC2_RGBA8]. */ FORMAT_ETC2_RA_AS_RG = 33, /** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also [constant FORMAT_DXT5]. */ FORMAT_DXT5_RA_AS_RG = 34, /** [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 4×4 (high quality) mode. */ FORMAT_ASTC_4x4 = 35, /** Same format as [constant FORMAT_ASTC_4x4], but with the hint to let the GPU know it is used for HDR. */ FORMAT_ASTC_4x4_HDR = 36, /** [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 8×8 (low quality) mode. */ FORMAT_ASTC_8x8 = 37, /** Same format as [constant FORMAT_ASTC_8x8], but with the hint to let the GPU know it is used for HDR. */ FORMAT_ASTC_8x8_HDR = 38, /** Represents the size of the [enum Format] enum. */ FORMAT_MAX = 39, } enum Interpolation { /** Performs nearest-neighbor interpolation. If the image is resized, it will be pixelated. */ INTERPOLATE_NEAREST = 0, /** Performs bilinear interpolation. If the image is resized, it will be blurry. This mode is faster than [constant INTERPOLATE_CUBIC], but it results in lower quality. */ INTERPOLATE_BILINEAR = 1, /** Performs cubic interpolation. If the image is resized, it will be blurry. This mode often gives better results compared to [constant INTERPOLATE_BILINEAR], at the cost of being slower. */ INTERPOLATE_CUBIC = 2, /** Performs bilinear separately on the two most-suited mipmap levels, then linearly interpolates between them. * It's slower than [constant INTERPOLATE_BILINEAR], but produces higher-quality results with far fewer aliasing artifacts. * If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image. * * **Note:** If you intend to scale multiple copies of the original image, it's better to call [method generate_mipmaps]] on it in advance, to avoid wasting processing power in generating them again and again. * On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image. */ INTERPOLATE_TRILINEAR = 3, /** Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscaling images. */ INTERPOLATE_LANCZOS = 4, } enum AlphaMode { /** Image does not have alpha. */ ALPHA_NONE = 0, /** Image stores alpha in a single bit. */ ALPHA_BIT = 1, /** Image uses alpha. */ ALPHA_BLEND = 2, } enum CompressMode { /** Use S3TC compression. */ COMPRESS_S3TC = 0, /** Use ETC compression. */ COMPRESS_ETC = 1, /** Use ETC2 compression. */ COMPRESS_ETC2 = 2, /** Use BPTC compression. */ COMPRESS_BPTC = 3, /** Use ASTC compression. */ COMPRESS_ASTC = 4, /** Represents the size of the [enum CompressMode] enum. */ COMPRESS_MAX = 5, } enum UsedChannels { /** The image only uses one channel for luminance (grayscale). */ USED_CHANNELS_L = 0, /** The image uses two channels for luminance and alpha, respectively. */ USED_CHANNELS_LA = 1, /** The image only uses the red channel. */ USED_CHANNELS_R = 2, /** The image uses two channels for red and green. */ USED_CHANNELS_RG = 3, /** The image uses three channels for red, green, and blue. */ USED_CHANNELS_RGB = 4, /** The image uses four channels for red, green, blue, and alpha. */ USED_CHANNELS_RGBA = 5, } enum CompressSource { /** Source texture (before compression) is a regular texture. Default for all textures. */ COMPRESS_SOURCE_GENERIC = 0, /** Source texture (before compression) is in sRGB space. */ COMPRESS_SOURCE_SRGB = 1, /** Source texture (before compression) is a normal texture (e.g. it can be compressed into two channels). */ COMPRESS_SOURCE_NORMAL = 2, } enum ASTCFormat { /** Hint to indicate that the high quality 4×4 ASTC compression format should be used. */ ASTC_FORMAT_4x4 = 0, /** Hint to indicate that the low quality 8×8 ASTC compression format should be used. */ ASTC_FORMAT_8x8 = 1, } } /** Image datatype. * * @link https://docs.godotengine.org/en/4.4/classes/class_image.html */ class Image extends Resource { /** The maximal width allowed for [Image] resources. */ static readonly MAX_WIDTH = 16777216 /** The maximal height allowed for [Image] resources. */ static readonly MAX_HEIGHT = 16777216 constructor(identifier?: any) /** Returns the image's width. */ get_width(): int64 /** Returns the image's height. */ get_height(): int64 /** Returns the image's size (width and height). */ get_size(): Vector2i /** Returns `true` if the image has generated mipmaps. */ has_mipmaps(): boolean /** Returns the image's format. See [enum Format] constants. */ get_format(): Image.Format /** Returns a copy of the image's raw data. */ get_data(): PackedByteArray /** Returns size (in bytes) of the image's raw data. */ get_data_size(): int64 /** Converts the image's format. See [enum Format] constants. */ convert(format: Image.Format): void /** Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count. */ get_mipmap_count(): int64 /** Returns the offset where the image's mipmap with index [param mipmap] is stored in the [member data] dictionary. */ get_mipmap_offset(mipmap: int64): int64 /** Resizes the image to the nearest power of 2 for the width and height. If [param square] is `true` then set width and height to be the same. New pixels are calculated using the [param interpolation] mode defined via [enum Interpolation] constants. */ resize_to_po2(square: boolean = false, interpolation: Image.Interpolation = 1): void /** Resizes the image to the given [param width] and [param height]. New pixels are calculated using the [param interpolation] mode defined via [enum Interpolation] constants. */ resize(width: int64, height: int64, interpolation: Image.Interpolation = 1): void /** Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4). */ shrink_x2(): void /** Crops the image to the given [param width] and [param height]. If the specified size is larger than the current size, the extra area is filled with black pixels. */ crop(width: int64, height: int64): void /** Flips the image horizontally. */ flip_x(): void /** Flips the image vertically. */ flip_y(): void /** Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is `0`. Enabling [param renormalize] when generating mipmaps for normal map textures will make sure all resulting vector values are normalized. * It is possible to check if the image has mipmaps by calling [method has_mipmaps] or [method get_mipmap_count]. Calling [method generate_mipmaps] on an image that already has mipmaps will replace existing mipmaps in the image. */ generate_mipmaps(renormalize: boolean = false): GError /** Removes the image's mipmaps. */ clear_mipmaps(): void /** Creates an empty image of given size and format. See [enum Format] constants. If [param use_mipmaps] is `true`, then generate mipmaps for this image. See the [method generate_mipmaps]. */ static create(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format): Image /** Creates an empty image of given size and format. See [enum Format] constants. If [param use_mipmaps] is `true`, then generate mipmaps for this image. See the [method generate_mipmaps]. */ static create_empty(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format): Image /** Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [param use_mipmaps] is `true` then loads mipmaps for this image from [param data]. See [method generate_mipmaps]. */ static create_from_data(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format, data: PackedByteArray | byte[] | ArrayBuffer): Image /** Overwrites data of an existing [Image]. Non-static equivalent of [method create_from_data]. */ set_data(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format, data: PackedByteArray | byte[] | ArrayBuffer): void /** Returns `true` if the image has no data. */ is_empty(): boolean /** Loads an image from file [param path]. See [url=https://docs.godotengine.org/en/4.4/tutorials/assets_pipeline/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. * **Warning:** This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the `user://` directory, and may not work in exported projects. * See also [ImageTexture] description for usage examples. */ load(path: string): GError /** Creates a new [Image] and loads data from the specified file. */ static load_from_file(path: string): Image /** Saves the image as a PNG file to the file at [param path]. */ save_png(path: string): GError /** Saves the image as a PNG file to a byte array. */ save_png_to_buffer(): PackedByteArray /** Saves the image as a JPEG file to [param path] with the specified [param quality] between `0.01` and `1.0` (inclusive). Higher [param quality] values result in better-looking output at the cost of larger file sizes. Recommended [param quality] values are between `0.75` and `0.90`. Even at quality `1.00`, JPEG compression remains lossy. * * **Note:** JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting JPEG file won't contain the alpha channel. */ save_jpg(path: string, quality: float64 = 0.75): GError /** Saves the image as a JPEG file to a byte array with the specified [param quality] between `0.01` and `1.0` (inclusive). Higher [param quality] values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended [param quality] values are between `0.75` and `0.90`. Even at quality `1.00`, JPEG compression remains lossy. * * **Note:** JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting byte array won't contain the alpha channel. */ save_jpg_to_buffer(quality: float64 = 0.75): PackedByteArray /** Saves the image as an EXR file to [param path]. If [param grayscale] is `true` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. * * **Note:** The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project. */ save_exr(path: string, grayscale: boolean = false): GError /** Saves the image as an EXR file to a byte array. If [param grayscale] is `true` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module. * * **Note:** The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return an empty byte array when it is called from an exported project. */ save_exr_to_buffer(grayscale: boolean = false): PackedByteArray /** Saves the image as a WebP (Web Picture) file to the file at [param path]. By default it will save lossless. If [param lossy] is `true`, the image will be saved lossy, using the [param quality] setting between `0.0` and `1.0` (inclusive). Lossless WebP offers more efficient compression than PNG. * * **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images. */ save_webp(path: string, lossy: boolean = false, quality: float64 = 0.75): GError /** Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If [param lossy] is `true`, the image will be saved lossy, using the [param quality] setting between `0.0` and `1.0` (inclusive). Lossless WebP offers more efficient compression than PNG. * * **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images. */ save_webp_to_buffer(lossy: boolean = false, quality: float64 = 0.75): PackedByteArray /** Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are stored in a single bit. Returns [constant ALPHA_NONE] if no data for alpha values is found. */ detect_alpha(): Image.AlphaMode /** Returns `true` if all the image's pixels have an alpha value of 0. Returns `false` if any pixel has an alpha value higher than 0. */ is_invisible(): boolean /** Returns the color channels used by this image, as one of the [enum UsedChannels] constants. If the image is compressed, the original [param source] must be specified. */ detect_used_channels(source: Image.CompressSource = 0): Image.UsedChannels /** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. * The [param source] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression. * For ASTC compression, the [param astc_format] parameter must be supplied. */ compress(mode: Image.CompressMode, source: Image.CompressSource = 0, astc_format: Image.ASTCFormat = 0): GError /** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. * This is an alternative to [method compress] that lets the user supply the channels used in order for the compressor to pick the best DXT and ETC2 formats. For other formats (non DXT or ETC2), this argument is ignored. * For ASTC compression, the [param astc_format] parameter must be supplied. */ compress_from_channels(mode: Image.CompressMode, channels: Image.UsedChannels, astc_format: Image.ASTCFormat = 0): GError /** Decompresses the image if it is VRAM compressed in a supported format. Returns [constant OK] if the format is supported, otherwise [constant ERR_UNAVAILABLE]. * * **Note:** The following formats can be decompressed: DXT, RGTC, BPTC. The formats ETC1 and ETC2 are not supported. */ decompress(): GError /** Returns `true` if the image is compressed. */ is_compressed(): boolean /** Rotates the image in the specified [param direction] by `90` degrees. The width and height of the image must be greater than `1`. If the width and height are not equal, the image will be resized. */ rotate_90(direction: ClockDirection): void /** Rotates the image by `180` degrees. The width and height of the image must be greater than `1`. */ rotate_180(): void /** Blends low-alpha pixels with nearby pixels. */ fix_alpha_edges(): void /** Multiplies color values with alpha values. Resulting color values for a pixel are `(color * alpha)/256`. See also [member CanvasItemMaterial.blend_mode]. */ premultiply_alpha(): void /** Converts the raw data from the sRGB colorspace to a linear scale. Only works on images with [constant FORMAT_RGB8] or [constant FORMAT_RGBA8] formats. */ srgb_to_linear(): void /** Converts the entire image from the linear colorspace to the sRGB colorspace. Only works on images with [constant FORMAT_RGB8] or [constant FORMAT_RGBA8] formats. */ linear_to_srgb(): void /** Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count. */ normal_map_to_xy(): void /** Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. */ rgbe_to_srgb(): Image /** Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. */ bump_map_to_normal_map(bump_scale: float64 = 1): void /** Compute image metrics on the current image and the compared image. * The dictionary contains `max`, `mean`, `mean_squared`, `root_mean_squared` and `peak_snr`. */ compute_image_metrics(compared_image: Image, use_luma: boolean): GDictionary /** Copies [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image **must** have the same format. [param src_rect] with non-positive size is treated as empty. * * **Note:** The alpha channel data in [param src] will overwrite the corresponding data in this image at the target position. To blend alpha channels, use [method blend_rect] instead. */ blit_rect(src: Image, src_rect: Rect2i, dst: Vector2i): void /** Blits [param src_rect] area from [param src] image to this image at the coordinates given by [param dst], clipped accordingly to both image bounds. [param src] pixel is copied onto [param dst] if the corresponding [param mask] pixel's alpha value is not 0. This image and [param src] image **must** have the same format. [param src] image and [param mask] image **must** have the same size (width and height) but they can have different formats. [param src_rect] with non-positive size is treated as empty. */ blit_rect_mask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): void /** Alpha-blends [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image **must** have the same format. [param src_rect] with non-positive size is treated as empty. */ blend_rect(src: Image, src_rect: Rect2i, dst: Vector2i): void /** Alpha-blends [param src_rect] from [param src] image to this image using [param mask] image at coordinates [param dst], clipped accordingly to both image bounds. Alpha channels are required for both [param src] and [param mask]. [param dst] pixels and [param src] pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and [param src] image **must** have the same format. [param src] image and [param mask] image **must** have the same size (width and height) but they can have different formats. [param src_rect] with non-positive size is treated as empty. */ blend_rect_mask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): void /** Fills the image with [param color]. */ fill(color: Color): void /** Fills [param rect] with [param color]. */ fill_rect(rect: Rect2i, color: Color): void /** Returns a [Rect2i] enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. */ get_used_rect(): Rect2i /** Returns a new [Image] that is a copy of this [Image]'s area specified with [param region]. */ get_region(region: Rect2i): Image /** Copies [param src] image to this image. */ copy_from(src: Image): void /** Returns the color of the pixel at [param point]. * This is the same as [method get_pixel], but with a [Vector2i] argument instead of two integer arguments. */ get_pixelv(point: Vector2i): Color /** Returns the color of the pixel at `(x, y)`. * This is the same as [method get_pixelv], but with two integer arguments instead of a [Vector2i] argument. */ get_pixel(x: int64, y: int64): Color /** Sets the [Color] of the pixel at [param point] to [param color]. * * This is the same as [method set_pixel], but with a [Vector2i] argument instead of two integer arguments. */ set_pixelv(point: Vector2i, color: Color): void /** Sets the [Color] of the pixel at `(x, y)` to [param color]. * * This is the same as [method set_pixelv], but with a two integer arguments instead of a [Vector2i] argument. */ set_pixel(x: int64, y: int64, color: Color): void /** Adjusts this image's [param brightness], [param contrast], and [param saturation] by the given values. Does not work if the image is compressed (see [method is_compressed]). */ adjust_bcs(brightness: float64, contrast: float64, saturation: float64): void /** Loads an image from the binary contents of a PNG file. */ load_png_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the binary contents of a JPEG file. */ load_jpg_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the binary contents of a WebP file. */ load_webp_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the binary contents of a TGA file. * * **Note:** This method is only available in engine builds with the TGA module enabled. By default, the TGA module is enabled, but it can be disabled at build-time using the `module_tga_enabled=no` SCons option. */ load_tga_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the binary contents of a BMP file. * * **Note:** Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported. * * **Note:** This method is only available in engine builds with the BMP module enabled. By default, the BMP module is enabled, but it can be disabled at build-time using the `module_bmp_enabled=no` SCons option. */ load_bmp_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the binary contents of a [url=https://github.com/KhronosGroup/KTX-Software]KTX[/url] file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps. * * **Note:** Godot's libktx implementation only supports 2D images. Cubemaps, texture arrays, and de-padding are not supported. * * **Note:** This method is only available in engine builds with the KTX module enabled. By default, the KTX module is enabled, but it can be disabled at build-time using the `module_ktx_enabled=no` SCons option. */ load_ktx_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): GError /** Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**). * * **Note:** Beware when using compressed SVG files (like **.svgz**), they need to be `decompressed` before loading. * * **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the `module_svg_enabled=no` SCons option. */ load_svg_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer, scale: float64 = 1): GError /** Loads an image from the string contents of an SVG file (**.svg**). * * **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the `module_svg_enabled=no` SCons option. */ load_svg_from_string(svg_str: string, scale: float64 = 1): GError /** Holds all the image's color data in a given format. See [enum Format] constants. */ get data(): GDictionary set data(value: GDictionary) } namespace ImageFormatLoader { enum LoaderFlags { FLAG_NONE = 0, FLAG_FORCE_LINEAR = 1, FLAG_CONVERT_COLORS = 2, } } /** Base class to add support for specific image formats. * * @link https://docs.godotengine.org/en/4.4/classes/class_imageformatloader.html */ class ImageFormatLoader extends RefCounted { constructor(identifier?: any) } /** Base class for creating [ImageFormatLoader] extensions (adding support for extra image formats). * * @link https://docs.godotengine.org/en/4.4/classes/class_imageformatloaderextension.html */ class ImageFormatLoaderExtension extends ImageFormatLoader { constructor(identifier?: any) /** Returns the list of file extensions for this image format. Files with the given extensions will be treated as image file and loaded using this class. */ /* gdvirtual */ _get_recognized_extensions(): PackedStringArray /** Loads the content of [param fileaccess] into the provided [param image]. */ /* gdvirtual */ _load_image(image: Image, fileaccess: FileAccess, flags: ImageFormatLoader.LoaderFlags, scale: float64): GError /** Add this format loader to the engine, allowing it to recognize the file extensions returned by [method _get_recognized_extensions]. */ add_format_loader(): void /** Remove this format loader from the engine. */ remove_format_loader(): void } /** A [Texture2D] based on an [Image]. * * @link https://docs.godotengine.org/en/4.4/classes/class_imagetexture.html */ class ImageTexture extends Texture2D { constructor(identifier?: any) /** Creates a new [ImageTexture] and initializes it by allocating and setting the data from an [Image]. */ static create_from_image(image: Image): ImageTexture /** Returns the format of the texture, one of [enum Image.Format]. */ get_format(): Image.Format /** Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture. * If you want to update the image, but don't need to change its parameters (format, size), use [method update] instead for better performance. */ set_image(image: Image): void /** Replaces the texture's data with a new [Image]. * * **Note:** The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration. * Use this method over [method set_image] if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time. */ update(image: Image): void /** Resizes the texture to the specified dimensions. */ set_size_override(size: Vector2i): void } /** Texture with 3 dimensions. * * @link https://docs.godotengine.org/en/4.4/classes/class_imagetexture3d.html */ class ImageTexture3D extends Texture3D { constructor(identifier?: any) /** Creates the [ImageTexture3D] with specified [param width], [param height], and [param depth]. See [enum Image.Format] for [param format] options. If [param use_mipmaps] is `true`, then generate mipmaps for the [ImageTexture3D]. */ create(format: Image.Format, width: int64, height: int64, depth: int64, use_mipmaps: boolean, data: GArray): GError /** Replaces the texture's existing data with the layers specified in [param data]. The size of [param data] must match the parameters that were used for [method create]. In other words, the texture cannot be resized or have its format changed by calling [method update]. */ update(data: GArray): void get _images(): GArray set _images(value: GArray) } /** Base class for texture types which contain the data of multiple [ImageTexture]s. Each image is of the same size and format. * * @link https://docs.godotengine.org/en/4.4/classes/class_imagetexturelayered.html */ class ImageTextureLayered extends TextureLayered { constructor(identifier?: any) /** Creates an [ImageTextureLayered] from an array of [Image]s. See [method Image.create] for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images *must* have the same width, height, image format and mipmapping setting. * Each [Image] represents one `layer`. * */ create_from_images(images: GArray): GError /** Replaces the existing [Image] data at the given [param layer] with this new image. * The given [Image] must have the same width, height, image format, and mipmapping flag as the rest of the referenced images. * If the image format is unsupported, it will be decompressed and converted to a similar and supported [enum Image.Format]. * The update is immediate: it's synchronized with drawing. */ update_layer(image: Image, layer: int64): void get _images(): GArray set _images(value: GArray) } /** Mesh optimized for creating geometry manually. * * @link https://docs.godotengine.org/en/4.4/classes/class_immediatemesh.html */ class ImmediateMesh extends Mesh { constructor(identifier?: any) /** Begin a new surface. */ surface_begin(primitive: Mesh.PrimitiveType, material: Material = undefined): void /** Set the color attribute that will be pushed with the next vertex. */ surface_set_color(color: Color): void /** Set the normal attribute that will be pushed with the next vertex. */ surface_set_normal(normal: Vector3): void /** Set the tangent attribute that will be pushed with the next vertex. */ surface_set_tangent(tangent: Plane): void /** Set the UV attribute that will be pushed with the next vertex. */ surface_set_uv(uv: Vector2): void /** Set the UV2 attribute that will be pushed with the next vertex. */ surface_set_uv2(uv2: Vector2): void /** Add a 3D vertex using the current attributes previously set. */ surface_add_vertex(vertex: Vector3): void /** Add a 2D vertex using the current attributes previously set. */ surface_add_vertex_2d(vertex: Vector2): void /** End and commit current surface. Note that surface being created will not be visible until this function is called. */ surface_end(): void /** Clear all surfaces. */ clear_surfaces(): void } class ImportDefaultsEditor = Record> extends VBoxContainer { constructor(identifier?: any) } class ImportDefaultsEditorSettings extends Object { constructor(identifier?: any) } class ImportDock = Record> extends VBoxContainer { constructor(identifier?: any) _reimport(): void } class ImportDockParameters extends Object { constructor(identifier?: any) } /** A [Resource] that contains vertex array-based geometry during the import process. * * @link https://docs.godotengine.org/en/4.4/classes/class_importermesh.html */ class ImporterMesh extends Resource { constructor(identifier?: any) /** Adds name for a blend shape that will be added with [method add_surface]. Must be called before surface is added. */ add_blend_shape(name: string): void /** Returns the number of blend shapes that the mesh holds. */ get_blend_shape_count(): int64 /** Returns the name of the blend shape at this index. */ get_blend_shape_name(blend_shape_idx: int64): string /** Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. */ set_blend_shape_mode(mode: Mesh.BlendShapeMode): void /** Returns the blend shape mode for this Mesh. */ get_blend_shape_mode(): Mesh.BlendShapeMode /** Creates a new surface. [method Mesh.get_surface_count] will become the `surf_idx` for this new surface. * Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType]. * The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or `null` if it is not used by the surface. For example, `arrays[0]` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used. * The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are `null`. * The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents an LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used. * The [param flags] argument is the bitwise OR of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by `ARRAY_FORMAT_CUSTOMn_SHIFT` for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY]. * * **Note:** When using indices, it is recommended to only use points, lines, or triangles. */ add_surface(primitive: Mesh.PrimitiveType, arrays: GArray, blend_shapes: GArray = [], lods: GDictionary = new GDictionary(), material: Material = undefined, name: string = '', flags: int64 = 0): void /** Returns the number of surfaces that the mesh holds. */ get_surface_count(): int64 /** Returns the primitive type of the requested surface (see [method add_surface]). */ get_surface_primitive_type(surface_idx: int64): Mesh.PrimitiveType /** Gets the name assigned to this surface. */ get_surface_name(surface_idx: int64): string /** Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See [method add_surface]. */ get_surface_arrays(surface_idx: int64): GArray /** Returns a single set of blend shape arrays for the requested blend shape index for a surface. */ get_surface_blend_shape_arrays(surface_idx: int64, blend_shape_idx: int64): GArray /** Returns the number of lods that the mesh holds on a given surface. */ get_surface_lod_count(surface_idx: int64): int64 /** Returns the screen ratio which activates a lod for a surface. */ get_surface_lod_size(surface_idx: int64, lod_idx: int64): float64 /** Returns the index buffer of a lod for a surface. */ get_surface_lod_indices(surface_idx: int64, lod_idx: int64): PackedInt32Array /** Returns a [Material] in a given surface. Surface is rendered using this material. */ get_surface_material(surface_idx: int64): Material /** Returns the format of the surface that the mesh holds. */ get_surface_format(surface_idx: int64): int64 /** Sets a name for a given surface. */ set_surface_name(surface_idx: int64, name: string): void /** Sets a [Material] for a given surface. Surface will be rendered using this material. */ set_surface_material(surface_idx: int64, material: Material): void /** Generates all lods for this ImporterMesh. * [param normal_merge_angle] is in degrees and used in the same way as the importer settings in `lods`. * [param normal_split_angle] is not used and only remains for compatibility with older versions of the API. * The number of generated lods can be accessed using [method get_surface_lod_count], and each LOD is available in [method get_surface_lod_size] and [method get_surface_lod_indices]. * [param bone_transform_array] is an [Array] which can be either empty or contain [Transform3D]s which, for each of the mesh's bone IDs, will apply mesh skinning when generating the LOD mesh variations. This is usually used to account for discrepancies in scale between the mesh itself and its skinning data. */ generate_lods(normal_merge_angle: float64, normal_split_angle: float64, bone_transform_array: GArray): void /** Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh]. * This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called. * If not yet cached and [param base_mesh] is provided, [param base_mesh] will be used and mutated. */ get_mesh(base_mesh: ArrayMesh = undefined): ArrayMesh /** Removes all surfaces and blend shapes from this [ImporterMesh]. */ clear(): void /** Sets the size hint of this mesh for lightmap-unwrapping in UV-space. */ set_lightmap_size_hint(size: Vector2i): void /** Returns the size hint of this mesh for lightmap-unwrapping in UV-space. */ get_lightmap_size_hint(): Vector2i get _data(): GDictionary set _data(value: GDictionary) } /** @link https://docs.godotengine.org/en/4.4/classes/class_importermeshinstance3d.html */ class ImporterMeshInstance3D = Record> extends Node3D { constructor(identifier?: any) get mesh(): ImporterMesh set mesh(value: ImporterMesh) get skin(): Skin set skin(value: Skin) get skeleton_path(): NodePath set skeleton_path(value: NodePath | string) get layer_mask(): int64 set layer_mask(value: int64) get cast_shadow(): int64 set cast_shadow(value: int64) get visibility_range_begin(): float64 set visibility_range_begin(value: float64) get visibility_range_begin_margin(): float64 set visibility_range_begin_margin(value: float64) get visibility_range_end(): float64 set visibility_range_end(value: float64) get visibility_range_end_margin(): float64 set visibility_range_end_margin(value: float64) get visibility_range_fade_mode(): int64 set visibility_range_fade_mode(value: int64) } /** Abstract base class for input events. * * @link https://docs.godotengine.org/en/4.4/classes/class_inputevent.html */ class InputEvent extends Resource { /** Device ID used for emulated mouse input from a touchscreen, or for emulated touch input from a mouse. This can be used to distinguish emulated mouse input from physical mouse input, or emulated touch input from physical touch input. */ static readonly DEVICE_ID_EMULATION = -1 constructor(identifier?: any) /** Returns `true` if this input event matches a pre-defined action of any type. * If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. */ is_action(action: StringName, exact_match: boolean = false): boolean /** Returns `true` if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [param allow_echo] is `true`). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. * If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. * * **Note:** Due to keyboard ghosting, [method is_action_pressed] may return `false` even if one of the action's keys is pressed. See [url=https://docs.godotengine.org/en/4.4/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. */ is_action_pressed(action: StringName, allow_echo: boolean = false, exact_match: boolean = false): boolean /** Returns `true` if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. * If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. */ is_action_released(action: StringName, exact_match: boolean = false): boolean /** Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. * If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. */ get_action_strength(action: StringName, exact_match: boolean = false): float64 /** Returns `true` if this input event has been canceled. */ is_canceled(): boolean /** Returns `true` if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. * * **Note:** Due to keyboard ghosting, [method is_pressed] may return `false` even if one of the action's keys is pressed. See [url=https://docs.godotengine.org/en/4.4/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. */ is_pressed(): boolean /** Returns `true` if this input event is released. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. */ is_released(): boolean /** Returns `true` if this input event is an echo event (only for events of type [InputEventKey]). An echo event is a repeated key event sent when the user is holding down the key. Any other event type returns `false`. * * **Note:** The rate at which echo events are sent is typically around 20 events per second (after holding down the key for roughly half a second). However, the key repeat delay/speed can be changed by the user or disabled entirely in the operating system settings. To ensure your project works correctly on all configurations, do not assume the user has a specific key repeat configuration in your project's behavior. */ is_echo(): boolean /** Returns a [String] representation of the event. */ as_text(): string /** Returns `true` if the specified [param event] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. * If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. * * **Note:** Only considers the event configuration (such as the keyboard key or joypad axis), not state information like [method is_pressed], [method is_released], [method is_echo], or [method is_canceled]. */ is_match(event: InputEvent, exact_match: boolean = true): boolean /** Returns `true` if this input event's type is one that can be assigned to an input action. */ is_action_type(): boolean /** Returns `true` if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]). * The given input event's position, global position and speed will be copied. The resulting `relative` is a sum of both events. Both events' modifiers have to be identical. */ accumulate(with_event: InputEvent): boolean /** Returns a copy of the given input event which has been offset by [param local_ofs] and transformed by [param xform]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture]. */ xformed_by(xform: Transform2D, local_ofs: Vector2 = Vector2.ZERO): InputEvent /** The event's device ID. * * **Note:** [member device] can be negative for special use cases that don't refer to devices physically present on the system. See [constant DEVICE_ID_EMULATION]. */ get device(): int64 set device(value: int64) } /** An input event type for actions. * * @link https://docs.godotengine.org/en/4.4/classes/class_inputeventaction.html */ class InputEventAction extends InputEvent { constructor(identifier?: any) /** The action's name. Actions are accessed via this [String]. */ get action(): StringName set action(value: StringName) /** If `true`, the action's state is pressed. If `false`, the action's state is released. */ get pressed(): boolean set pressed(value: boolean) /** The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is `false`. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed. */ get strength(): float64 set strength(value: float64) /** The real event index in action this event corresponds to (from events defined for this action in the [InputMap]). If `-1`, a unique ID will be used and actions pressed with this ID will need to be released with another [InputEventAction]. */ get event_index(): int64 set event_index(value: int64) } class InputEventConfigurationDialog = Record> extends ConfirmationDialog { constructor(identifier?: any) } class InputEventEditorPlugin = Record> extends EditorPlugin { constructor(identifier?: any) } /** Abstract base class for [Viewport]-based input events. * * @link https://docs.godotengine.org/en/4.4/classes/class_inputeventfromwindow.html */ class InputEventFromWindow extends InputEvent { constructor(identifier?: any) /** The ID of a [Window] that received this event. */ get window_id(): int64 set window_id(value: int64) } /** Abstract base class for touch gestures. * * @link https://docs.godotengine.org/en/4.4/classes/class_inputeventgesture.html */ class InputEventGesture extends InputEventWithModifiers { constructor(identifier?: any) /** The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture. */ get position(): Vector2 set position(value: Vector2) } }