typescript-to-gdscript 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +229 -103
- package/dist/converter/common/index.d.ts +17 -1
- package/dist/converter/common/index.d.ts.map +1 -1
- package/dist/converter/common/index.js +69 -19
- package/dist/converter/common/index.js.map +1 -1
- package/dist/converter/ts-to-gd/class-members.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/class-members.js +5 -5
- package/dist/converter/ts-to-gd/class-members.js.map +1 -1
- package/dist/converter/ts-to-gd/expressions.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/expressions.js +1 -1
- package/dist/converter/ts-to-gd/expressions.js.map +1 -1
- package/dist/converter/ts-to-gd/file-scope.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/file-scope.js +1 -1
- package/dist/converter/ts-to-gd/file-scope.js.map +1 -1
- package/dist/converter/ts-to-gd/gd-getset.js +2 -2
- package/dist/converter/ts-to-gd/gd-getset.js.map +1 -1
- package/dist/converter/ts-to-gd/index.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/index.js +1 -0
- package/dist/converter/ts-to-gd/index.js.map +1 -1
- package/dist/converter/ts-to-gd/parameters.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/parameters.js +2 -2
- package/dist/converter/ts-to-gd/parameters.js.map +1 -1
- package/dist/converter/ts-to-gd/statements.d.ts.map +1 -1
- package/dist/converter/ts-to-gd/statements.js +1 -1
- package/dist/converter/ts-to-gd/statements.js.map +1 -1
- package/dist/typings/override-system.d.ts.map +1 -1
- package/dist/typings/override-system.js +6 -0
- package/dist/typings/override-system.js.map +1 -1
- package/package.json +6 -1
- package/typings/classes/AnimationNodeBlendSpace1D.d.ts +2 -17
- package/typings/classes/AnimationNodeBlendSpace2D.d.ts +2 -17
- package/typings/classes/Area3D.d.ts +7 -14
- package/typings/classes/ArrayMesh.d.ts +0 -15
- package/typings/classes/AudioEffectAmplify.d.ts +2 -2
- package/typings/classes/AudioEffectBandLimitFilter.d.ts +1 -1
- package/typings/classes/AudioEffectBandPassFilter.d.ts +1 -1
- package/typings/classes/AudioEffectCapture.d.ts +9 -10
- package/typings/classes/AudioEffectChorus.d.ts +28 -57
- package/typings/classes/AudioEffectCompressor.d.ts +9 -11
- package/typings/classes/AudioEffectDelay.d.ts +15 -21
- package/typings/classes/AudioEffectDistortion.d.ts +10 -19
- package/typings/classes/AudioEffectEQ.d.ts +2 -2
- package/typings/classes/AudioEffectEQ10.d.ts +2 -2
- package/typings/classes/AudioEffectEQ21.d.ts +2 -2
- package/typings/classes/AudioEffectEQ6.d.ts +2 -2
- package/typings/classes/AudioEffectFilter.d.ts +9 -25
- package/typings/classes/AudioEffectHardLimiter.d.ts +5 -8
- package/typings/classes/AudioEffectHighPassFilter.d.ts +1 -1
- package/typings/classes/AudioEffectHighShelfFilter.d.ts +1 -1
- package/typings/classes/AudioEffectLimiter.d.ts +4 -9
- package/typings/classes/AudioEffectLowPassFilter.d.ts +1 -1
- package/typings/classes/AudioEffectLowShelfFilter.d.ts +1 -1
- package/typings/classes/AudioEffectNotchFilter.d.ts +1 -1
- package/typings/classes/AudioEffectPanner.d.ts +2 -7
- package/typings/classes/AudioEffectPhaser.d.ts +7 -9
- package/typings/classes/AudioEffectPitchShift.d.ts +3 -3
- package/typings/classes/AudioEffectReverb.d.ts +8 -17
- package/typings/classes/AudioEffectSpectrumAnalyzer.d.ts +5 -4
- package/typings/classes/AudioEffectStereoEnhance.d.ts +4 -7
- package/typings/classes/AudioServer.d.ts +2 -2
- package/typings/classes/AudioStreamPlaybackResampled.d.ts +0 -8
- package/typings/classes/BaseButton.d.ts +1 -1
- package/typings/classes/Basis.d.ts +0 -4
- package/typings/classes/Camera3D.d.ts +1 -1
- package/typings/classes/CameraAttributes.d.ts +0 -1
- package/typings/classes/CameraFeed.d.ts +0 -4
- package/typings/classes/CanvasItem.d.ts +1 -1
- package/typings/classes/CodeEdit.d.ts +0 -4
- package/typings/classes/CollisionObject2D.d.ts +0 -6
- package/typings/classes/CollisionPolygon2D.d.ts +0 -5
- package/typings/classes/CollisionShape2D.d.ts +0 -5
- package/typings/classes/Container.d.ts +0 -6
- package/typings/classes/Control.d.ts +0 -59
- package/typings/classes/DPITexture.d.ts +0 -14
- package/typings/classes/Decal.d.ts +0 -1
- package/typings/classes/Dictionary.d.ts +0 -1
- package/typings/classes/DisplayServer.d.ts +1 -128
- package/typings/classes/EditorDock.d.ts +2 -8
- package/typings/classes/EditorExportPlugin.d.ts +0 -5
- package/typings/classes/EditorFileSystem.d.ts +0 -2
- package/typings/classes/EditorInterface.d.ts +2 -4
- package/typings/classes/EditorSettings.d.ts +133 -197
- package/typings/classes/EditorSpinSlider.d.ts +0 -6
- package/typings/classes/Environment.d.ts +2 -7
- package/typings/classes/FileAccess.d.ts +1 -1
- package/typings/classes/FileDialog.d.ts +1 -1
- package/typings/classes/FoldableContainer.d.ts +1 -1
- package/typings/classes/Font.d.ts +2 -2
- package/typings/classes/GPUParticles3D.d.ts +0 -4
- package/typings/classes/GeometryInstance3D.d.ts +1 -1
- package/typings/classes/GradientTexture2D.d.ts +0 -2
- package/typings/classes/Image.d.ts +0 -1
- package/typings/classes/ImageTexture.d.ts +2 -0
- package/typings/classes/ImporterMesh.d.ts +0 -6
- package/typings/classes/Input.d.ts +13 -148
- package/typings/classes/InputEvent.d.ts +0 -8
- package/typings/classes/InputEventGesture.d.ts +3 -2
- package/typings/classes/InputEventMouse.d.ts +3 -2
- package/typings/classes/InputEventWithModifiers.d.ts +3 -2
- package/typings/classes/InputMap.d.ts +0 -3
- package/typings/classes/ItemList.d.ts +2 -9
- package/typings/classes/Joint3D.d.ts +0 -1
- package/typings/classes/LookAtModifier3D.d.ts +1 -2
- package/typings/classes/MainLoop.d.ts +0 -4
- package/typings/classes/NativeMenu.d.ts +3 -10
- package/typings/classes/Node.d.ts +5 -9
- package/typings/classes/OS.d.ts +2 -2
- package/typings/classes/Object.d.ts +2 -5
- package/typings/classes/OptionButton.d.ts +0 -6
- package/typings/classes/PCKPacker.d.ts +0 -4
- package/typings/classes/ParticleProcessMaterial.d.ts +0 -5
- package/typings/classes/PhysicsDirectBodyState2D.d.ts +1 -2
- package/typings/classes/PhysicsDirectBodyState3D.d.ts +1 -2
- package/typings/classes/PhysicsServer2D.d.ts +2 -2
- package/typings/classes/PhysicsServer2DExtension.d.ts +1 -1
- package/typings/classes/PhysicsServer3D.d.ts +42 -145
- package/typings/classes/PopupMenu.d.ts +8 -22
- package/typings/classes/PopupPanel.d.ts +0 -2
- package/typings/classes/PortableCompressedTexture2D.d.ts +2 -0
- package/typings/classes/ProjectSettings.d.ts +60 -44
- package/typings/classes/RDShaderSPIRV.d.ts +0 -30
- package/typings/classes/RDShaderSource.d.ts +0 -10
- package/typings/classes/RenderingDevice.d.ts +0 -104
- package/typings/classes/RenderingServer.d.ts +11 -213
- package/typings/classes/Resource.d.ts +2 -2
- package/typings/classes/ResourceImporterDynamicFont.d.ts +1 -3
- package/typings/classes/ResourceImporterSVG.d.ts +0 -10
- package/typings/classes/ResourceImporterTexture.d.ts +2 -2
- package/typings/classes/SceneTree.d.ts +29 -5
- package/typings/classes/ScriptEditor.d.ts +0 -6
- package/typings/classes/Shader.d.ts +0 -2
- package/typings/classes/Shape3D.d.ts +0 -1
- package/typings/classes/SplitContainer.d.ts +0 -6
- package/typings/classes/String.d.ts +1 -1
- package/typings/classes/SubViewport.d.ts +0 -4
- package/typings/classes/TextEdit.d.ts +0 -3
- package/typings/classes/TextServer.d.ts +0 -2
- package/typings/classes/TextServerExtension.d.ts +0 -2
- package/typings/classes/Texture2D.d.ts +0 -14
- package/typings/classes/TextureRect.d.ts +1 -4
- package/typings/classes/Tree.d.ts +2 -9
- package/typings/classes/TreeItem.d.ts +0 -8
- package/typings/classes/Tween.d.ts +0 -13
- package/typings/classes/Viewport.d.ts +0 -10
- package/typings/classes/VisualShader.d.ts +0 -2
- package/typings/classes/VisualShaderNodeColorFunc.d.ts +2 -2
- package/typings/classes/VoxelGIData.d.ts +0 -10
- package/typings/classes/Window.d.ts +0 -23
- package/typings/classes/XRCamera3D.d.ts +1 -1
- package/typings/classes/XRServer.d.ts +0 -2
- package/typings/classes/_globals.d.ts +86 -45
- package/typings/classes/index.d.ts +0 -5
- package/typings/godot-class-registry.json +108 -1254
- package/typings/classes/AccessibilityServer.d.ts +0 -405
- package/typings/classes/AwaitTweener.d.ts +0 -10
- package/typings/classes/BlitMaterial.d.ts +0 -22
- package/typings/classes/DrawableTexture2D.d.ts +0 -47
- package/typings/classes/VirtualJoystick.d.ts +0 -94
|
@@ -3,13 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
/** Base class for all GUI containers. */
|
|
5
5
|
declare class Container extends Control {
|
|
6
|
-
/**
|
|
7
|
-
* If `true`, this container is marked as a region for accessibility. Use {@link Control.accessibility_name} to give the region a descriptive name. Screen readers can navigate between regions using landmark navigation.
|
|
8
|
-
*/
|
|
9
|
-
accessibility_region: boolean;
|
|
10
6
|
mouse_filter: int;
|
|
11
|
-
set_accessibility_region(value: boolean): void;
|
|
12
|
-
is_accessibility_region(): boolean;
|
|
13
7
|
|
|
14
8
|
/**
|
|
15
9
|
* Implement to return a list of allowed horizontal {@link Control.SizeFlags} for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock.
|
|
@@ -139,49 +139,6 @@ declare class Control extends CanvasItem {
|
|
|
139
139
|
* Offsets are often controlled by one or multiple parent {@link Container} nodes, so you should not modify them manually if your node is a direct child of a {@link Container}. Offsets update automatically when you move or resize the node.
|
|
140
140
|
*/
|
|
141
141
|
offset_top: float;
|
|
142
|
-
/**
|
|
143
|
-
* If `true`, applies all offset transform properties. Otherwise, no offset transform is applied and the properties have no effect.
|
|
144
|
-
*/
|
|
145
|
-
offset_transform_enabled: boolean;
|
|
146
|
-
/**
|
|
147
|
-
* Pivot used by {@link offset_transform_rotation} and {@link offset_transform_scale} in absolute units.
|
|
148
|
-
* The final pivot position is the combined value of this property and {@link offset_transform_pivot_ratio}.
|
|
149
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
150
|
-
*/
|
|
151
|
-
offset_transform_pivot: Vector2;
|
|
152
|
-
/**
|
|
153
|
-
* Same as {@link offset_transform_pivot} but expressed in units relative to the {@link Control} {@link size} where `Vector2(0, 0)` is the top-left corner of this control, and `Vector2(1, 1)` is its bottom-right corner.
|
|
154
|
-
* The final pivot position is the combined value of this property and {@link offset_transform_pivot}.
|
|
155
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
156
|
-
*/
|
|
157
|
-
offset_transform_pivot_ratio: Vector2;
|
|
158
|
-
/**
|
|
159
|
-
* Position offset in absolute units. The final offset is the combined value of this property and {@link offset_transform_position_ratio}.
|
|
160
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
161
|
-
*/
|
|
162
|
-
offset_transform_position: Vector2;
|
|
163
|
-
/**
|
|
164
|
-
* Same as {@link offset_transform_position} but expressed in units relative to the {@link Control} {@link size} where `Vector2(0, 0)` is the top-left corner of this control, and `Vector2(1, 1)` is its bottom-right corner.
|
|
165
|
-
* The final offset is the combined value of this property and {@link offset_transform_position}.
|
|
166
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
167
|
-
*/
|
|
168
|
-
offset_transform_position_ratio: Vector2;
|
|
169
|
-
/**
|
|
170
|
-
* Rotation offset. The rotation pivot is defined by {@link offset_transform_pivot} and {@link offset_transform_pivot_ratio}.
|
|
171
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
172
|
-
*/
|
|
173
|
-
offset_transform_rotation: float;
|
|
174
|
-
/**
|
|
175
|
-
* Scale offset. The scale pivot is defined by {@link offset_transform_pivot} and {@link offset_transform_pivot_ratio}.
|
|
176
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
177
|
-
*/
|
|
178
|
-
offset_transform_scale: Vector2;
|
|
179
|
-
/**
|
|
180
|
-
* If `true`, the offset transforms is only applied visually and does not affect input. In other words, this Control will still receive input events at its original location before the offset transform is applied.
|
|
181
|
-
* If `false`, the entire transform of this Control is affected and input events will register where the Control is visually.
|
|
182
|
-
* Has no effect unless {@link offset_transform_enabled} is `true`.
|
|
183
|
-
*/
|
|
184
|
-
offset_transform_visual_only: boolean;
|
|
185
142
|
/**
|
|
186
143
|
* <member name="pivot_offset" type="Vector2" setter="set_pivot_offset" getter="get_pivot_offset" default="Vector2(0, 0)">
|
|
187
144
|
* By default, the node's pivot is its top-left corner. When you change its {@link rotation} or {@link scale}, it will rotate or scale around this pivot.
|
|
@@ -304,22 +261,6 @@ declare class Control extends CanvasItem {
|
|
|
304
261
|
get_mouse_filter(): int;
|
|
305
262
|
set_force_pass_scroll_events(value: boolean): void;
|
|
306
263
|
is_force_pass_scroll_events(): boolean;
|
|
307
|
-
set_offset_transform_enabled(value: boolean): void;
|
|
308
|
-
is_offset_transform_enabled(): boolean;
|
|
309
|
-
set_offset_transform_pivot(value: Vector2 | Vector2i): void;
|
|
310
|
-
get_offset_transform_pivot(): Vector2;
|
|
311
|
-
set_offset_transform_pivot_ratio(value: Vector2 | Vector2i): void;
|
|
312
|
-
get_offset_transform_pivot_ratio(): Vector2;
|
|
313
|
-
set_offset_transform_position(value: Vector2 | Vector2i): void;
|
|
314
|
-
get_offset_transform_position(): Vector2;
|
|
315
|
-
set_offset_transform_position_ratio(value: Vector2 | Vector2i): void;
|
|
316
|
-
get_offset_transform_position_ratio(): Vector2;
|
|
317
|
-
set_offset_transform_rotation(value: float): void;
|
|
318
|
-
get_offset_transform_rotation(): float;
|
|
319
|
-
set_offset_transform_scale(value: Vector2 | Vector2i): void;
|
|
320
|
-
get_offset_transform_scale(): Vector2;
|
|
321
|
-
set_offset_transform_visual_only(value: boolean): void;
|
|
322
|
-
is_offset_transform_visual_only(): boolean;
|
|
323
264
|
set_pivot_offset_ratio(value: Vector2 | Vector2i): void;
|
|
324
265
|
get_pivot_offset_ratio(): Vector2;
|
|
325
266
|
_set_position(value: Vector2 | Vector2i): void;
|
|
@@ -7,16 +7,6 @@ declare class DPITexture extends Texture2D {
|
|
|
7
7
|
base_scale: float;
|
|
8
8
|
/** If set, remaps texture colors according to {@link Color}-{@link Color} map. */
|
|
9
9
|
color_map: Dictionary;
|
|
10
|
-
/**
|
|
11
|
-
* If `true`, puts pixels of the same surrounding color in transition from transparent to opaque areas. For textures displayed with bilinear filtering, this helps to reduce the outline effect when exporting images from an image editor.
|
|
12
|
-
*/
|
|
13
|
-
fix_alpha_border: boolean;
|
|
14
|
-
/**
|
|
15
|
-
* An alternative to fixing darkened borders with {@link fix_alpha_border} is to use premultiplied alpha. By enabling this option, the texture will be converted to this format. A premultiplied alpha texture requires specific materials to be displayed correctly:
|
|
16
|
-
* - In 2D, a {@link CanvasItemMaterial} will need to be created and configured to use the {@link CanvasItemMaterial.BLEND_MODE_PREMULT_ALPHA} blend mode on {@link CanvasItem}s that use this texture. In custom `canvas_item` shaders, `render_mode blend_premul_alpha;` should be used.
|
|
17
|
-
* - In 3D, a {@link BaseMaterial3D} will need to be created and configured to use the {@link BaseMaterial3D.BLEND_MODE_PREMULT_ALPHA} blend mode on materials that use this texture. In custom `spatial` shaders, `render_mode blend_premul_alpha;` should be used.
|
|
18
|
-
*/
|
|
19
|
-
premult_alpha: boolean;
|
|
20
10
|
/**
|
|
21
11
|
* <member name="saturation" type="float" setter="set_saturation" getter="get_saturation" default="1.0">
|
|
22
12
|
* Overrides texture saturation.
|
|
@@ -26,10 +16,6 @@ declare class DPITexture extends Texture2D {
|
|
|
26
16
|
get_base_scale(): float;
|
|
27
17
|
set_color_map(value: Dictionary): void;
|
|
28
18
|
get_color_map(): Dictionary;
|
|
29
|
-
set_fix_alpha_border(value: boolean): void;
|
|
30
|
-
get_fix_alpha_border(): boolean;
|
|
31
|
-
set_premult_alpha(value: boolean): void;
|
|
32
|
-
get_premult_alpha(): boolean;
|
|
33
19
|
|
|
34
20
|
/**
|
|
35
21
|
* Creates a new {@link DPITexture} and initializes it by allocating and setting the SVG data to `source`.
|
|
@@ -63,7 +63,6 @@ declare class Decal extends VisualInstance3D {
|
|
|
63
63
|
* {@link Texture2D} storing ambient occlusion, roughness, and metallic for the decal. Use this to add extra detail to decals.
|
|
64
64
|
* **Note:** Unlike {@link BaseMaterial3D} whose filter mode can be adjusted on a per-material basis, the filter mode for {@link Decal} textures is set globally with {@link ProjectSettings.rendering/textures/decals/filter}.
|
|
65
65
|
* **Note:** Setting this texture alone will not result in a visible decal, as {@link texture_albedo} must also be set. To create an ORM-only decal, load an albedo texture into {@link texture_albedo} and set {@link albedo_mix} to `0.0`. The albedo texture's alpha channel will be used to determine where the underlying surface's ORM map should be overridden (and its intensity).
|
|
66
|
-
* **Note:** Due to technical limitations, modifying the underlying surface's roughness using {@link texture_orm} does *not* affect screen-space reflections ({@link Environment.ssr_enabled}), reflections from {@link VoxelGI}, and reflections from SDFGI ({@link Environment.sdfgi_enabled}). Only reflections from {@link ReflectionProbe}s are affected.
|
|
67
66
|
*/
|
|
68
67
|
texture_orm: Texture2D | null;
|
|
69
68
|
/**
|
|
@@ -32,7 +32,6 @@ declare interface Object {
|
|
|
32
32
|
find_key(value: unknown): unknown;
|
|
33
33
|
/**
|
|
34
34
|
* Returns the corresponding value for the given `key` in the dictionary. If the `key` does not exist, returns `default`, or `null` if the parameter is omitted.
|
|
35
|
-
* **Note:** If the `default` argument is computationally expensive or has unwanted side effects, consider using the {@link has} method instead:
|
|
36
35
|
*/
|
|
37
36
|
get(key: unknown, default_?: unknown): unknown;
|
|
38
37
|
/**
|
|
@@ -271,7 +271,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
271
271
|
* Displays OS native dialog for selecting files or directories in the file system.
|
|
272
272
|
* Each filter string in the `filters` 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. It is recommended to set both file extension and MIME type. See also {@link FileDialog.filters}.
|
|
273
273
|
* Callbacks have the following arguments: `status: bool, selected_paths: PackedStringArray, selected_filter_index: int`. **On Android,** the third callback argument (`selected_filter_index`) is always `0`.
|
|
274
|
-
* **Note:** This method is implemented if the display server has the {@link FEATURE_NATIVE_DIALOG_FILE} feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.
|
|
274
|
+
* **Note:** This method is implemented if the display server has the {@link FEATURE_NATIVE_DIALOG_FILE} feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android (API level 29+).
|
|
275
275
|
* **Note:** `current_directory` might be ignored.
|
|
276
276
|
* **Note:** Embedded file dialogs and Windows file dialogs support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
|
|
277
277
|
* **Note:** On Android and Linux, `show_hidden` is ignored.
|
|
@@ -771,11 +771,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
771
771
|
* **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
|
|
772
772
|
*/
|
|
773
773
|
is_dark_mode_supported(): boolean;
|
|
774
|
-
/**
|
|
775
|
-
* Returns `true` if the application is in picture-in-picture mode.
|
|
776
|
-
* **Note:** This method is implemented on Android.
|
|
777
|
-
*/
|
|
778
|
-
is_in_pip_mode(window_id?: int): boolean;
|
|
779
774
|
/**
|
|
780
775
|
* Returns `true` if touch events are available (Android or iOS), the capability is detected on the Web platform or if {@link ProjectSettings.input_devices/pointing/emulate_touch_from_mouse} is `true`.
|
|
781
776
|
*/
|
|
@@ -829,21 +824,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
829
824
|
mouse_get_position(): Vector2i;
|
|
830
825
|
/** Sets the current mouse mode. See also {@link mouse_get_mode}. */
|
|
831
826
|
mouse_set_mode(mouse_mode: int): void;
|
|
832
|
-
/**
|
|
833
|
-
* Enters picture-in-picture mode.
|
|
834
|
-
* **Note:** This method is implemented on Android.
|
|
835
|
-
*/
|
|
836
|
-
pip_mode_enter(window_id?: int): void;
|
|
837
|
-
/**
|
|
838
|
-
* Specifies the aspect ratio for picture-in-picture mode.
|
|
839
|
-
* **Note:** This method is implemented on Android.
|
|
840
|
-
*/
|
|
841
|
-
pip_mode_set_aspect_ratio(numerator: int, denominator: int, window_id?: int): void;
|
|
842
|
-
/**
|
|
843
|
-
* Specifies whether picture-in-picture mode should be entered automatically when the application goes in the background.
|
|
844
|
-
* **Note:** This method is implemented on Android.
|
|
845
|
-
*/
|
|
846
|
-
pip_mode_set_auto_enter_on_background(auto_enter_on_background: boolean, window_id?: int): void;
|
|
847
827
|
/**
|
|
848
828
|
* Perform window manager processing, including input flushing. See also {@link force_process_and_drop_events}, {@link Input.flush_buffered_events} and {@link Input.use_accumulated_input}.
|
|
849
829
|
*/
|
|
@@ -1133,24 +1113,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1133
1113
|
window_get_current_screen(window_id?: int): int;
|
|
1134
1114
|
/** Returns the current value of the given window's `flag`. */
|
|
1135
1115
|
window_get_flag(flag: int, window_id?: int): boolean;
|
|
1136
|
-
/**
|
|
1137
|
-
* When {@link window_is_hdr_output_enabled} returns `true`, this returns the current maximum luminance in nits (cd/m²) for HDR output by the window specified by `window_id`. If the maximum luminance is being automatically adjusted based on the screen's capabilities, this method will return that value. Otherwise, it will return the value set by {@link window_set_hdr_output_max_luminance}. This maximum luminance value is used when calculating {@link window_get_output_max_linear_value}.
|
|
1138
|
-
* **Note:** This maximum luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to {@link window_get_hdr_output_current_reference_luminance}.
|
|
1139
|
-
*/
|
|
1140
|
-
window_get_hdr_output_current_max_luminance(window_id?: int): float;
|
|
1141
|
-
/**
|
|
1142
|
-
* When {@link window_is_hdr_output_enabled} returns `true`, this returns the current reference white luminance in nits (cd/m²) for HDR output by the window specified by `window_id`. If the reference luminance is being automatically adjusted to match the operating system brightness, this will return that value. Otherwise, it will return the value set by {@link window_set_hdr_output_reference_luminance}. This reference luminance value is used when calculating {@link window_get_output_max_linear_value}.
|
|
1143
|
-
* **Note:** This reference white luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to {@link window_get_hdr_output_current_max_luminance}.
|
|
1144
|
-
*/
|
|
1145
|
-
window_get_hdr_output_current_reference_luminance(window_id?: int): float;
|
|
1146
|
-
/**
|
|
1147
|
-
* Returns the maximum luminance in nits (cd/m²) set for HDR output by the window specified by `window_id`. Negative values indicate that the value is being automatically adjusted based on the screen's capabilities. See also {@link window_get_hdr_output_current_max_luminance}.
|
|
1148
|
-
*/
|
|
1149
|
-
window_get_hdr_output_max_luminance(window_id?: int): float;
|
|
1150
|
-
/**
|
|
1151
|
-
* Returns the reference white luminance in nits (cd/m²) set for HDR output by the window specified by `window_id`. Negative values indicate that the value is being automatically adjusted to match the operating system brightness. See also {@link window_get_hdr_output_current_reference_luminance}.
|
|
1152
|
-
*/
|
|
1153
|
-
window_get_hdr_output_reference_luminance(window_id?: int): float;
|
|
1154
1116
|
/** Returns the window's maximum size (in pixels). See also {@link window_set_max_size}. */
|
|
1155
1117
|
window_get_max_size(window_id?: int): Vector2i;
|
|
1156
1118
|
/** Returns the window's minimum size (in pixels). See also {@link window_set_min_size}. */
|
|
@@ -1162,10 +1124,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1162
1124
|
* **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
|
|
1163
1125
|
*/
|
|
1164
1126
|
window_get_native_handle(handle_type: int, window_id?: int): int;
|
|
1165
|
-
/**
|
|
1166
|
-
* Returns the maximum value for linear color components that can be displayed for the window specified by `window_id`, regardless of SDR or HDR output. Returns `1.0` if HDR is not enabled or not supported. When HDR output is enabled, this is calculated based on {@link window_get_hdr_output_current_reference_luminance} and {@link window_get_hdr_output_current_max_luminance}. This value is used by tonemapping and other {@link Environment} effects to ensure that bright colors are presented in the range that can be displayed by this window. Corresponds to {@link Window.get_output_max_linear_value}.
|
|
1167
|
-
*/
|
|
1168
|
-
window_get_output_max_linear_value(window_id?: int): float;
|
|
1169
1127
|
/**
|
|
1170
1128
|
* Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
|
|
1171
1129
|
*/
|
|
@@ -1197,18 +1155,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1197
1155
|
window_get_vsync_mode(window_id?: int): int;
|
|
1198
1156
|
/** Returns `true` if the window specified by `window_id` is focused. */
|
|
1199
1157
|
window_is_focused(window_id?: int): boolean;
|
|
1200
|
-
/**
|
|
1201
|
-
* Returns `true` if HDR output is currently enabled for the window specified by `window_id`. The returned value may change dynamically based on system settings, screen capabilities, and which screen the window is currently on.
|
|
1202
|
-
*/
|
|
1203
|
-
window_is_hdr_output_enabled(window_id?: int): boolean;
|
|
1204
|
-
/**
|
|
1205
|
-
* Returns `true` if HDR output is requested for the window specified by `window_id`. Corresponds to {@link Window.hdr_output_requested}.
|
|
1206
|
-
*/
|
|
1207
|
-
window_is_hdr_output_requested(window_id?: int): boolean;
|
|
1208
|
-
/**
|
|
1209
|
-
* Returns `true` if the window specified by `window_id` supports HDR output. This depends on the platform, screen capabilities, system settings, and the screen the window is currently on.
|
|
1210
|
-
*/
|
|
1211
|
-
window_is_hdr_output_supported(window_id?: int): boolean;
|
|
1212
1158
|
/** Returns `true` if the given window can be maximized (the maximize button is enabled). */
|
|
1213
1159
|
window_is_maximize_allowed(window_id?: int): boolean;
|
|
1214
1160
|
/**
|
|
@@ -1229,10 +1175,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1229
1175
|
* Makes the window specified by `window_id` request attention, which is materialized by the window title and taskbar entry blinking until the window is focused. This usually has no visible effect if the window is currently focused. The exact behavior varies depending on the operating system.
|
|
1230
1176
|
*/
|
|
1231
1177
|
window_request_attention(window_id?: int): void;
|
|
1232
|
-
/**
|
|
1233
|
-
* If `enable` is `true`, HDR output is requested for the window specified by `window_id`. The window will automatically switch between HDR and SDR if it is moved between screens, screen capabilities change, or system settings are modified. This will internally force {@link Viewport.use_hdr_2d} to be enabled on the main {@link Viewport}. All other {@link SubViewport} of the {@link Window} must have their {@link Viewport.use_hdr_2d} property enabled to produce HDR output. Corresponds to {@link Window.hdr_output_requested}.
|
|
1234
|
-
*/
|
|
1235
|
-
window_request_hdr_output(enable: boolean, window_id?: int): void;
|
|
1236
1178
|
/**
|
|
1237
1179
|
* Sets the background color of the root window.
|
|
1238
1180
|
* **Note:** This method is implemented only on Android.
|
|
@@ -1258,14 +1200,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1258
1200
|
window_set_exclusive(window_id: int, exclusive: boolean): void;
|
|
1259
1201
|
/** Enables or disables the given window's given `flag`. */
|
|
1260
1202
|
window_set_flag(flag: int, enabled: boolean, window_id?: int): void;
|
|
1261
|
-
/**
|
|
1262
|
-
* Sets the maximum luminance in nits (cd/m²) for HDR output by the window specified by `window_id`. If `max_luminance` is negative, the window uses the screen's maximum luminance that is reported by the operating system. By default, this luminance is set to `-1.0` for every window. Typically this property should be left at this default value, but may optionally be exposed through in-game settings to allow the player to correct an inaccurate maximum luminance reported by the operating system. See also {@link window_get_hdr_output_current_max_luminance} and {@link window_get_hdr_output_max_luminance}.
|
|
1263
|
-
*/
|
|
1264
|
-
window_set_hdr_output_max_luminance(max_luminance: float, window_id?: int): void;
|
|
1265
|
-
/**
|
|
1266
|
-
* Sets the reference white luminance in nits (cd/m²) for HDR output by the window specified by `window_id`. If `reference_luminance` is negative, the window automatically adjusts to the brightness set by the operating system. By default, this luminance is set to `-1.0` for every window. Typically this property should be left at this default value, but may optionally be exposed as an "HDR Brightness" in-game setting to allow the player to adjust the brightness of their game, independently of their device settings. See also {@link window_get_hdr_output_current_reference_luminance} and {@link window_get_hdr_output_reference_luminance}.
|
|
1267
|
-
*/
|
|
1268
|
-
window_set_hdr_output_reference_luminance(reference_luminance: float, window_id?: int): void;
|
|
1269
1203
|
/**
|
|
1270
1204
|
* Sets whether Input Method Editor (https://en.wikipedia.org/wiki/Input_method) should be enabled for the window specified by `window_id`. See also {@link window_set_ime_position}.
|
|
1271
1205
|
*/
|
|
@@ -1339,19 +1273,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1339
1273
|
* **Note:** It's recommended to change this value using {@link Window.size} instead.
|
|
1340
1274
|
*/
|
|
1341
1275
|
window_set_size(size: Vector2i | Vector2, window_id?: int): void;
|
|
1342
|
-
/**
|
|
1343
|
-
* Sets the type and state of the progress bar on the taskbar/dock icon of the window specified by `window_id`. See {@link ProgressState} for possible values and how each mode behaves.
|
|
1344
|
-
* **Note:** This method is implemented only on Windows and macOS.
|
|
1345
|
-
* **Note:** On macOS, the progress bar is displayed only for the main window.
|
|
1346
|
-
*/
|
|
1347
|
-
window_set_taskbar_progress_state(state: int, window_id?: int): void;
|
|
1348
|
-
/**
|
|
1349
|
-
* Creates a progress bar on the taskbar/dock icon of the window specified by `window_id` if it does not exist, sets the progress of the icon.
|
|
1350
|
-
* `value` acts as a relative percentage value, ranges from `0.0` (lowest) to `1.0` (highest).
|
|
1351
|
-
* **Note:** This method is implemented only on Windows and macOS.
|
|
1352
|
-
* **Note:** On macOS, the progress bar is displayed only for the main window.
|
|
1353
|
-
*/
|
|
1354
|
-
window_set_taskbar_progress_value(value: float, window_id?: int): void;
|
|
1355
1276
|
/**
|
|
1356
1277
|
* Sets the title of the given window to `title`.
|
|
1357
1278
|
* **Note:** It's recommended to change this value using {@link Window.title} instead.
|
|
@@ -1391,13 +1312,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1391
1312
|
*/
|
|
1392
1313
|
window_start_resize(edge: int, window_id?: int): void;
|
|
1393
1314
|
|
|
1394
|
-
/**
|
|
1395
|
-
* Emitted when the device orientation changes. `orientation` is the new orientation.
|
|
1396
|
-
* Returns `1` for portrait, `2` for landscape, and `0` if the orientation is undefined.
|
|
1397
|
-
* **Note:** This method is implemented on Android and iOS.
|
|
1398
|
-
*/
|
|
1399
|
-
orientation_changed: Signal<[int]>;
|
|
1400
|
-
|
|
1401
1315
|
// enum Feature
|
|
1402
1316
|
/**
|
|
1403
1317
|
* Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. **macOS**
|
|
@@ -1514,10 +1428,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1514
1428
|
* Display server supports interaction with screen reader or Braille display. **Linux (X11/Wayland), macOS, Windows**
|
|
1515
1429
|
*/
|
|
1516
1430
|
readonly FEATURE_ACCESSIBILITY_SCREEN_READER: int;
|
|
1517
|
-
/** Display server supports HDR output. **macOS, iOS, visionOS, Windows** */
|
|
1518
|
-
readonly FEATURE_HDR_OUTPUT: int;
|
|
1519
|
-
/** Display server supports putting the application in picture-in-picture mode. **Android** */
|
|
1520
|
-
readonly FEATURE_PIP_MODE: int;
|
|
1521
1431
|
// enum AccessibilityRole
|
|
1522
1432
|
/** Unknown or custom role. */
|
|
1523
1433
|
readonly ROLE_UNKNOWN: int;
|
|
@@ -1613,13 +1523,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1613
1523
|
readonly ROLE_DIALOG: int;
|
|
1614
1524
|
/** Tooltip element. */
|
|
1615
1525
|
readonly ROLE_TOOLTIP: int;
|
|
1616
|
-
/** Region/landmark element. Screen readers can navigate between regions using landmark navigation. */
|
|
1617
|
-
readonly ROLE_REGION: int;
|
|
1618
|
-
/**
|
|
1619
|
-
* Unifor text run.
|
|
1620
|
-
* Note: This role is used for internal text elements, and should not be assigned to nodes.
|
|
1621
|
-
*/
|
|
1622
|
-
readonly ROLE_TEXT_RUN: int;
|
|
1623
1526
|
// enum AccessibilityPopupType
|
|
1624
1527
|
/** Popup menu. */
|
|
1625
1528
|
readonly POPUP_MENU: int;
|
|
@@ -1900,26 +1803,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1900
1803
|
* **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports multiple resolutions ($DOCS_URL/tutorials/rendering/multiple_resolutions.html) when enabling full screen mode.
|
|
1901
1804
|
*/
|
|
1902
1805
|
readonly WINDOW_MODE_EXCLUSIVE_FULLSCREEN: int;
|
|
1903
|
-
// enum ProgressState
|
|
1904
|
-
/** Stops displaying progress and returns the button to its normal state. */
|
|
1905
|
-
readonly PROGRESS_STATE_NOPROGRESS: int;
|
|
1906
|
-
/**
|
|
1907
|
-
* The progress indicator shows an indeterminate progress.
|
|
1908
|
-
* On Windows, the progress indicator does not grow in size, but cycles repeatedly along the length of the taskbar button by default.
|
|
1909
|
-
*/
|
|
1910
|
-
readonly PROGRESS_STATE_INDETERMINATE: int;
|
|
1911
|
-
/** The progress indicator shows progress normally. */
|
|
1912
|
-
readonly PROGRESS_STATE_NORMAL: int;
|
|
1913
|
-
/**
|
|
1914
|
-
* The progress indicator shows that an error has occurred.
|
|
1915
|
-
* On Windows, the progress indicator turns red by default to show that an error has occurred in one of the windows that is broadcasting progress.
|
|
1916
|
-
*/
|
|
1917
|
-
readonly PROGRESS_STATE_ERROR: int;
|
|
1918
|
-
/**
|
|
1919
|
-
* The progress indicator shows it was paused.
|
|
1920
|
-
* On Windows, the progress indicator turns yellow by default to show that progress is currently stopped in one of the windows but can be resumed by the user.
|
|
1921
|
-
*/
|
|
1922
|
-
readonly PROGRESS_STATE_PAUSED: int;
|
|
1923
1806
|
// enum WindowFlags
|
|
1924
1807
|
/**
|
|
1925
1808
|
* The window can't be resized by dragging its resize grip. It's still possible to resize the window using {@link window_set_size}. This flag is ignored for full screen windows.
|
|
@@ -2094,16 +1977,6 @@ declare interface DisplayServer extends GodotObject {
|
|
|
2094
1977
|
* - Linux (Wayland): `EGLConfig` for the window.
|
|
2095
1978
|
*/
|
|
2096
1979
|
readonly EGL_CONFIG: int;
|
|
2097
|
-
/**
|
|
2098
|
-
* The GLX `VisualID` for the window.
|
|
2099
|
-
* **Note:** Only available on Linux when using X11.
|
|
2100
|
-
*/
|
|
2101
|
-
readonly GLX_VISUALID: int;
|
|
2102
|
-
/**
|
|
2103
|
-
* The `GLXFBConfig` for the window.
|
|
2104
|
-
* **Note:** Only available on Linux when using X11.
|
|
2105
|
-
*/
|
|
2106
|
-
readonly GLX_FBCONFIG: int;
|
|
2107
1980
|
// enum TTSUtteranceEvent
|
|
2108
1981
|
/** Utterance has begun to be spoken. */
|
|
2109
1982
|
readonly TTS_UTTERANCE_STARTED: int;
|
|
@@ -21,7 +21,7 @@ declare class EditorDock extends MarginContainer {
|
|
|
21
21
|
/** The shortcut used to open the dock. */
|
|
22
22
|
dock_shortcut: Shortcut | null;
|
|
23
23
|
/**
|
|
24
|
-
* If `true`, the dock will always display an icon, regardless of {@link EditorSettings.interface/editor/
|
|
24
|
+
* 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}.
|
|
25
25
|
*/
|
|
26
26
|
force_show_icon: boolean;
|
|
27
27
|
/**
|
|
@@ -99,13 +99,11 @@ declare class EditorDock extends MarginContainer {
|
|
|
99
99
|
* Emitted when the dock is closed with the Close button in the context popup, before it's removed from its parent. See {@link closable}.
|
|
100
100
|
*/
|
|
101
101
|
closed: Signal<[]>;
|
|
102
|
-
/** Emitted when the dock is opened via the Editor > Editor Docks menu, before it's made visible. */
|
|
103
|
-
opened: Signal<[]>;
|
|
104
102
|
|
|
105
103
|
// enum DockLayout
|
|
106
104
|
/** Allows placing the dock in the vertical dock slots on either side of the editor. */
|
|
107
105
|
static readonly DOCK_LAYOUT_VERTICAL: int;
|
|
108
|
-
/** Allows placing the dock in the
|
|
106
|
+
/** Allows placing the dock in the editor's bottom panel. */
|
|
109
107
|
static readonly DOCK_LAYOUT_HORIZONTAL: int;
|
|
110
108
|
/** Allows making the dock floating (opened as a separate window). */
|
|
111
109
|
static readonly DOCK_LAYOUT_FLOATING: int;
|
|
@@ -132,10 +130,6 @@ declare class EditorDock extends MarginContainer {
|
|
|
132
130
|
static readonly DOCK_SLOT_RIGHT_BR: int;
|
|
133
131
|
/** Bottom panel. */
|
|
134
132
|
static readonly DOCK_SLOT_BOTTOM: int;
|
|
135
|
-
/** Dock slot at the bottom, below bottom panel, on the left side. */
|
|
136
|
-
static readonly DOCK_SLOT_BOTTOM_L: int;
|
|
137
|
-
/** Dock slot at the bottom, below bottom panel, on the right side. */
|
|
138
|
-
static readonly DOCK_SLOT_BOTTOM_R: int;
|
|
139
133
|
/** Represents the size of the {@link DockSlot} enum. */
|
|
140
134
|
static readonly DOCK_SLOT_MAX: int;
|
|
141
135
|
}
|
|
@@ -36,11 +36,6 @@ declare class EditorExportPlugin extends RefCounted {
|
|
|
36
36
|
_end_customize_resources(): void;
|
|
37
37
|
/** This is called when the customization process for scenes ends. */
|
|
38
38
|
_end_customize_scenes(): void;
|
|
39
|
-
/**
|
|
40
|
-
* This is called after Xcode project generation, but before it is built.
|
|
41
|
-
* **Note:** Only supported on iOS and visionOS.
|
|
42
|
-
*/
|
|
43
|
-
_end_generate_apple_embedded_project(path: string | NodePath, will_build_archive: boolean): void;
|
|
44
39
|
/**
|
|
45
40
|
* 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.
|
|
46
41
|
*/
|
|
@@ -13,8 +13,6 @@ declare class EditorFileSystem extends Node {
|
|
|
13
13
|
get_filesystem_path(path: string | NodePath): EditorFileSystemDirectory | null;
|
|
14
14
|
/** Returns the scan progress for 0 to 1 if the FS is being scanned. */
|
|
15
15
|
get_scanning_progress(): float;
|
|
16
|
-
/** Returns `true` if resources are currently being imported. */
|
|
17
|
-
is_importing(): boolean;
|
|
18
16
|
/** Returns `true` if the filesystem is being scanned. */
|
|
19
17
|
is_scanning(): boolean;
|
|
20
18
|
/**
|
|
@@ -70,7 +70,7 @@ declare interface EditorInterface extends GodotObject {
|
|
|
70
70
|
get_editor_paths(): EditorPaths;
|
|
71
71
|
/**
|
|
72
72
|
* 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.
|
|
73
|
-
* **Note:** This value is set via the {@link EditorSettings.interface/editor/
|
|
73
|
+
* **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.
|
|
74
74
|
*/
|
|
75
75
|
get_editor_scale(): float;
|
|
76
76
|
/** Returns the editor's {@link EditorSettings} instance. */
|
|
@@ -131,8 +131,6 @@ declare interface EditorInterface extends GodotObject {
|
|
|
131
131
|
get_selected_paths(): PackedStringArray;
|
|
132
132
|
/** Returns the editor's {@link EditorSelection} instance. */
|
|
133
133
|
get_selection(): EditorSelection;
|
|
134
|
-
/** Returns an array of file paths of currently unsaved scenes. */
|
|
135
|
-
get_unsaved_scenes(): PackedStringArray;
|
|
136
134
|
/**
|
|
137
135
|
* 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
136
|
*/
|
|
@@ -140,7 +138,7 @@ declare interface EditorInterface extends GodotObject {
|
|
|
140
138
|
/**
|
|
141
139
|
* Returns `true` if multiple window support is enabled in the editor. Multiple window support is enabled if *all* of these statements are true:
|
|
142
140
|
* - {@link EditorSettings.interface/multi_window/enable} is `true`.
|
|
143
|
-
* - {@link EditorSettings.interface/editor/
|
|
141
|
+
* - {@link EditorSettings.interface/editor/single_window_mode} is `false`.
|
|
144
142
|
* - {@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.
|
|
145
143
|
*/
|
|
146
144
|
is_multi_window_enabled(): boolean;
|