typescript-to-gdscript 0.1.1 → 0.1.3

package/typings/classes/EditorDock.d.ts

@@ -4,9 +4,10 @@
 /** Dockable container for the editor. */
 declare class EditorDock extends MarginContainer {
   /**
+   * <member name="available_layouts" type="int" setter="set_available_layouts" getter="get_available_layouts" enum="EditorDock.DockLayout" is_bitfield="true" default="5">
    * The available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts.
    */
-  available_layouts: int;
+  accessibility_region: boolean;
   /**
    * If `true`, the dock can be closed with the Close button in the context popup. Docks with {@link global} enabled are always closable.
    */
@@ -21,7 +22,7 @@ declare class EditorDock extends MarginContainer {
   /** The shortcut used to open the dock. */
   dock_shortcut: Shortcut | null;
   /**
-   * If `true`, the dock will always display an icon, regardless of {@link EditorSettings.interface/editor/dock_tab_style} or {@link EditorSettings.interface/editor/bottom_dock_tab_style}.
+   * If `true`, the dock will always display an icon, regardless of {@link EditorSettings.interface/editor/docks/dock_tab_style} or {@link EditorSettings.interface/editor/docks/bottom_dock_tab_style}.
    */
   force_show_icon: boolean;
   /**
@@ -46,8 +47,6 @@ declare class EditorDock extends MarginContainer {
    * If `true`, the dock is not automatically opened or closed when loading an editor layout, only moved. It also can't be opened using a shortcut. This is meant for docks that are opened and closed in specific cases, such as when selecting a {@link TileMap} or {@link AnimationTree} node.
    */
   transient: boolean;
-  set_available_layouts(value: int): void;
-  get_available_layouts(): int;
   set_closable(value: boolean): void;
   is_closable(): boolean;
   set_default_slot(value: int): void;
@@ -99,11 +98,13 @@ declare class EditorDock extends MarginContainer {
    * Emitted when the dock is closed with the Close button in the context popup, before it's removed from its parent. See {@link closable}.
    */
   closed: Signal<[]>;
+  /** Emitted when the dock is opened via the Editor > Editor Docks menu, before it's made visible. */
+  opened: Signal<[]>;
 
   // enum DockLayout
   /** Allows placing the dock in the vertical dock slots on either side of the editor. */
   static readonly DOCK_LAYOUT_VERTICAL: int;
-  /** Allows placing the dock in the editor's bottom panel. */
+  /** Allows placing the dock in the horizontal dock slots at the bottom. */
   static readonly DOCK_LAYOUT_HORIZONTAL: int;
   /** Allows making the dock floating (opened as a separate window). */
   static readonly DOCK_LAYOUT_FLOATING: int;
@@ -130,6 +131,10 @@ declare class EditorDock extends MarginContainer {
   static readonly DOCK_SLOT_RIGHT_BR: int;
   /** Bottom panel. */
   static readonly DOCK_SLOT_BOTTOM: int;
+  /** Dock slot at the bottom, below bottom panel, on the left side. */
+  static readonly DOCK_SLOT_BOTTOM_L: int;
+  /** Dock slot at the bottom, below bottom panel, on the right side. */
+  static readonly DOCK_SLOT_BOTTOM_R: int;
   /** Represents the size of the {@link DockSlot} enum. */
   static readonly DOCK_SLOT_MAX: int;
 }

package/typings/classes/EditorExportPlatform.d.ts

@@ -18,8 +18,10 @@ declare class EditorExportPlatform extends RefCounted {
    * **Note:** `patches` is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.
    */
   export_pack_patch(preset: EditorExportPreset, debug: boolean, path: string | NodePath, patches?: PackedStringArray | Array<unknown>, flags?: int): int;
-  /** Creates a full project at `path` for the specified `preset`. */
-  export_project(preset: EditorExportPreset, debug: boolean, path: string | NodePath, flags: int): int;
+  /**
+   * Creates a full project at `path` for the specified `preset`. If `notify` is `true`, plugins using {@link EditorExportPlugin._export_begin} will be called during the process.
+   */
+  export_project(preset: EditorExportPreset, debug: boolean, path: string | NodePath, flags: int, notify?: boolean): int;
   /**
    * Exports project files for the specified preset. This method can be used to implement custom export format, other than PCK and ZIP. One of the callbacks is called for each exported file.
    * `save_cb` is called for all exported files and have the following arguments: `file_path: String`, `file_data: PackedByteArray`, `file_index: int`, `file_count: int`, `encryption_include_filters: PackedStringArray`, `encryption_exclude_filters: PackedStringArray`, `encryption_key: PackedByteArray`.

package/typings/classes/EditorExportPlugin.d.ts

@@ -30,12 +30,18 @@ declare class EditorExportPlugin extends RefCounted {
   /**
    * Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return `null`. If a new scene is returned, it is up to you to dispose of the old one.
    * Implementing this method is required if {@link _begin_customize_scenes} returns `true`.
+   * **Note:** To change a variable in your scene, use the `@export` annotation when declaring it.
    */
   _customize_scene(scene: Node, path: string | NodePath): Node | null;
   /** This is called when the customization process for resources ends. */
   _end_customize_resources(): void;
   /** This is called when the customization process for scenes ends. */
   _end_customize_scenes(): void;
+  /**
+   * This is called after Xcode project generation, but before it is built.
+   * **Note:** Only supported on iOS and visionOS.
+   */
+  _end_generate_apple_embedded_project(path: string | NodePath, will_build_archive: boolean): void;
   /**
    * Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. `features` is the list of features for the export, `is_debug` is `true` for debug builds, `path` is the target path for the exported project. `flags` is only used when running a runnable profile, e.g. when using native run on Android.
    */
@@ -84,6 +90,7 @@ declare class EditorExportPlugin extends RefCounted {
   /**
    * Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.
    * Implementing this method is required if {@link _begin_customize_resources} returns `true`.
+   * **Note:** {@link _customize_resource} and {@link _customize_scene} will not be called when the {@link EditorExportPlugin} script is modified unless this hash changes too.
    */
   _get_customization_configuration_hash(): int;
   /**

package/typings/classes/EditorFeatureProfile.d.ts

@@ -57,7 +57,7 @@ declare class EditorFeatureProfile extends RefCounted {
    * The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won't display.
    */
   static readonly FEATURE_SCRIPT: int;
-  /** The AssetLib tab. If this feature is disabled, the AssetLib tab won't display. */
+  /** The Asset Store tab. If this feature is disabled, the Asset Store tab won't display. */
   static readonly FEATURE_ASSET_LIB: int;
   /**
    * Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only.

package/typings/classes/EditorFileSystem.d.ts

@@ -13,6 +13,8 @@ declare class EditorFileSystem extends Node {
   get_filesystem_path(path: string | NodePath): EditorFileSystemDirectory | null;
   /** Returns the scan progress for 0 to 1 if the FS is being scanned. */
   get_scanning_progress(): float;
+  /** Returns `true` if resources are currently being imported. */
+  is_importing(): boolean;
   /** Returns `true` if the filesystem is being scanned. */
   is_scanning(): boolean;
   /**

package/typings/classes/EditorInspector.d.ts

@@ -10,11 +10,21 @@ declare class EditorInspector extends ScrollContainer {
   set_draw_focus_border(value: boolean): void;
   get_draw_focus_border(): boolean;
 
+  /** Collapses all foldable sections. */
+  collapse_all_folding(): void;
+  /**
+   * Creates an inspector with the same configuration as the one used in the editor's Inspector dock. When passing a {@link LineEdit} into `filter_line_edit`, the inspector will filter its properties based on {@link LineEdit.text} whenever {@link LineEdit.text_changed} is emitted.
+   */
+  static create_default_inspector(filter_line_edit?: LineEdit): EditorInspector | null;
   /**
    * Shows the properties of the given `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 {@link EditorInterface} instead.
    */
   edit(object: GodotObject): void;
+  /** Expands all foldable sections. */
+  expand_all_folding(): void;
+  /** Expands only the foldable sections that contain a revertable (i.e. non-default) property. */
+  expand_revertable(): void;
   /** Returns the object currently selected in this inspector. */
   get_edited_object(): GodotObject | null;
   /** Gets the path of the currently selected property. */

package/typings/classes/EditorInterface.d.ts

@@ -70,7 +70,7 @@ declare interface EditorInterface extends GodotObject {
   get_editor_paths(): EditorPaths;
   /**
    * Returns the actual scale of the editor UI (`1.0` being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.
-   * **Note:** This value is set via the {@link EditorSettings.interface/editor/display_scale} and {@link EditorSettings.interface/editor/custom_display_scale} settings. The editor must be restarted for changes to be properly applied.
+   * **Note:** This value is set via the {@link EditorSettings.interface/editor/appearance/display_scale} and {@link EditorSettings.interface/editor/appearance/custom_display_scale} settings. The editor must be restarted for changes to be properly applied.
    */
   get_editor_scale(): float;
   /** Returns the editor's {@link EditorSettings} instance. */
@@ -131,6 +131,8 @@ declare interface EditorInterface extends GodotObject {
   get_selected_paths(): PackedStringArray;
   /** Returns the editor's {@link EditorSelection} instance. */
   get_selection(): EditorSelection;
+  /** Returns an array of file paths of currently unsaved scenes. */
+  get_unsaved_scenes(): PackedStringArray;
   /**
    * Shows the given property on the given `object` in the editor's Inspector dock. If `inspector_only` is `true`, plugins will not attempt to edit `object`.
    */
@@ -138,7 +140,7 @@ declare interface EditorInterface extends GodotObject {
   /**
    * Returns `true` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true:
    * - {@link EditorSettings.interface/multi_window/enable} is `true`.
-   * - {@link EditorSettings.interface/editor/single_window_mode} is `false`.
+   * - {@link EditorSettings.interface/editor/display/single_window_mode} is `false`.
    * - {@link Viewport.gui_embed_subwindows} is `false`. This is forced to `true` on platforms that don't support multiple windows such as Web, or when the `--single-window` command line argument ($DOCS_URL/tutorials/editor/command_line_tutorial.html) is used.
    */
   is_multi_window_enabled(): boolean;
@@ -213,7 +215,7 @@ declare interface EditorInterface extends GodotObject {
    * Pops up an editor dialog for quick selecting a resource file. The `callback` must take a single argument of type {@link String} which will contain the path of the selected resource or be empty if the dialog is canceled. If `base_types` is provided, the dialog will only show resources that match these types. Only types deriving from {@link Resource} are supported.
    */
   popup_quick_open(callback: Callable, base_types?: Array<string>): void;
-  /** Reloads the scene at the given path. */
+  /** Reloads the scene at the given path. Fails if the scene is not open. */
   reload_scene_from_path(scene_filepath: string | NodePath): void;
   /**
    * Restarts the editor. This closes the editor and then opens the same project. If `save` is `true`, the project will be saved before restarting.
@@ -234,7 +236,7 @@ declare interface EditorInterface extends GodotObject {
    */
   set_current_feature_profile(profile_name: string | NodePath): void;
   /**
-   * Sets the editor's current main screen to the one specified in `name`. `name` must match the title of the tab in question exactly (e.g. `2D`, `3D`, [code skip-lint]Script[/code], `Game`, or `AssetLib` for default tabs).
+   * Sets the editor's current main screen to the one specified in `name`. `name` must match the title of the tab in question exactly (e.g. `2D`, `3D`, [code skip-lint]Script[/code], `Game`, or `Asset Store` for default tabs).
    */
   set_main_screen_editor(name: string | NodePath): void;
   /**

package/typings/classes/EditorNode3DGizmoPlugin.d.ts

@@ -8,6 +8,10 @@ declare class EditorNode3DGizmoPlugin extends Resource {
    * Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns `true` if not overridden.
    */
   _can_be_hidden(): boolean;
+  /**
+   * Override this method to define whether the gizmos should commit when the final handle position is the same as the initial one. Returns `false` if not overridden.
+   */
+  _can_commit_handle_on_click(): boolean;
   /**
    * Override this method to commit a handle being edited (handles must have been previously added by {@link EditorNode3DGizmo.add_handles} during {@link _redraw}). This usually means creating an {@link UndoRedo} action for the change, using the current handle value as "do" and the `restore` argument as "undo".
    * If the `cancel` argument is `true`, the `restore` value should be directly set, without any {@link UndoRedo} action.

package/typings/classes/EditorPlugin.d.ts

@@ -64,13 +64,13 @@ declare class EditorPlugin extends Node {
   _get_breakpoints(): PackedStringArray;
   /**
    * Override this method in your plugin to return a {@link 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", "Game", and "AssetLib" buttons.
+   * For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", "Game", and "Asset Store" buttons.
    * Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size.
    */
   _get_plugin_icon(): Texture2D | null;
   /**
    * 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", "Game", and "AssetLib" buttons.
+   * For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", "Game", and "Asset Store" buttons.
    */
   _get_plugin_name(): string;
   /**
@@ -98,7 +98,7 @@ declare class EditorPlugin extends Node {
    */
   _handles(object: GodotObject): boolean;
   /**
-   * Returns `true` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script**, **Game**, and **AssetLib**).
+   * Returns `true` if this is a main screen editor plugin (it goes in the workspace selector together with **2D**, **3D**, **Script**, **Game**, and **Asset Store**).
    * 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 {@link EditorInterface.get_editor_main_screen} and made visible inside {@link _make_visible}.
    * Use {@link _get_plugin_name} and {@link _get_plugin_icon} to customize the plugin button's appearance.
    */
@@ -308,7 +308,7 @@ declare class EditorPlugin extends Node {
   update_overlays(): int;
 
   /**
-   * Emitted when user changes the workspace (**2D**, **3D**, **Script**, **Game**, **AssetLib**). Also works with custom screens defined by plugins.
+   * Emitted when user changes the workspace (**2D**, **3D**, **Script**, **Game**, **Asset Store**). Also works with custom screens defined by plugins.
    */
   main_screen_changed: Signal<[string]>;
   /** Emitted when the given `resource` was saved on disc. See also {@link scene_saved}. */

package/typings/classes/EditorResourcePicker.d.ts

@@ -27,8 +27,9 @@ declare class EditorResourcePicker extends HBoxContainer {
    */
   _handle_menu_selected(id: int): boolean;
   /**
-   * This virtual method is called when updating the context menu of {@link EditorResourcePicker}. Implement this method to override the "New ..." items with your own options. `menu_node` is a reference to the {@link PopupMenu} node.
+   * This virtual method is called when updating the context menu of an {@link editable} {@link EditorResourcePicker}. Implement this method to override the "New" items section with your own options. `menu_node` is a reference to the {@link PopupMenu} node.
    * **Note:** Implement {@link _handle_menu_selected} to handle these custom items.
+   * **Note:** Relevant built-in options ("Load", "Copy", "Paste", etc.) are automatically added to the `menu_node` afterwards, using their hard-coded IDs starting from `0`. Custom options need to use non-colliding IDs to be handled properly. Using `id = 100 + custom_option_index` is safe (this is what the default items in the "New" section use).
    */
   _set_create_options(menu_node: GodotObject): void;
   /**

package/typings/classes/EditorSceneFormatImporter.d.ts

@@ -26,11 +26,34 @@ declare class EditorSceneFormatImporter extends RefCounted {
   /** Add a specific import option. This function can only be called from {@link _get_import_options}. */
   add_import_option_advanced(type_: int, name: string | NodePath, default_value: unknown, hint: int, hint_string?: string | NodePath, usage_flags?: int): void;
 
+  // enum ImportFlags
+  /** Unused flag (this has no effect when enabled). */
   static readonly IMPORT_SCENE: int;
+  /**
+   * Import animations from the 3D scene. When importing a scene as an {@link AnimationLibrary}, this flag is always enabled.
+   */
   static readonly IMPORT_ANIMATION: int;
+  /** Unused flag (this has no effect when enabled). */
   static readonly IMPORT_FAIL_ON_MISSING_DEPENDENCIES: int;
+  /**
+   * If `true`, generate vertex tangents using Mikktspace (http://www.mikktspace.com/) if the input meshes don't have tangent data. When possible, it's recommended to let the 3D modeling software generate tangents on export instead of relying on this option. Tangents are required for correct display of normal and height maps, along with any material/shader features that require tangents.
+   * If you don't need material features that require tangents, disabling this can reduce output file size and speed up importing if the source 3D file doesn't contain tangents.
+   */
   static readonly IMPORT_GENERATE_TANGENT_ARRAYS: int;
+  /**
+   * If checked, use named {@link Skin}s for animation. The {@link MeshInstance3D} node contains 3 properties of relevance here: a skeleton {@link NodePath} pointing to the {@link Skeleton3D} node (usually `..`), a mesh, and a skin:
+   * - The {@link Skeleton3D} node contains a list of bones with names, their pose and rest, a name, and a parent bone.
+   * - The mesh is all of the raw vertex data needed to display a mesh. In terms of the mesh, it knows how vertices are weight-painted and uses some internal numbering often imported from 3D modeling software.
+   * - The skin contains the information necessary to bind this mesh onto this Skeleton3D. For each of the internal bone IDs chosen by the 3D modeling software, it contains two things. Firstly, a matrix known as the Bind Pose Matrix, Inverse Bind Matrix, or IBM for short. Secondly, the {@link Skin} contains each bone's name (if this flag is enabled), or the bone's index within the {@link Skeleton3D} list (if this flag is disabled).
+   * Together, this information is enough to tell Godot how to use the bone poses in the {@link Skeleton3D} node to render the mesh from each {@link MeshInstance3D}. Note that each {@link MeshInstance3D} may share binds, as is common in models exported from Blender, or each {@link MeshInstance3D} may use a separate {@link Skin} object, as is common in models exported from other tools such as Maya.
+   */
   static readonly IMPORT_USE_NAMED_SKIN_BINDS: int;
+  /**
+   * Ignore meshes and materials on import. When importing a scene as an {@link AnimationLibrary}, this flag is always enabled.
+   */
   static readonly IMPORT_DISCARD_MESHES_AND_MATERIALS: int;
+  /**
+   * If `true`, mesh compression will not be used. Consider enabling if you notice blocky artifacts in your mesh normals or UVs, or if you have meshes that are larger than a few thousand meters in each direction.
+   */
   static readonly IMPORT_FORCE_DISABLE_MESH_COMPRESSION: int;
 }