typescript-to-gdscript 0.1.0 → 0.1.2
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 +232 -104
- package/dist/cli/convert.d.ts.map +1 -1
- package/dist/cli/convert.js +15 -5
- package/dist/cli/convert.js.map +1 -1
- 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/access-rewrite.d.ts +40 -0
- package/dist/converter/ts-to-gd/access-rewrite.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/access-rewrite.js +124 -0
- package/dist/converter/ts-to-gd/access-rewrite.js.map +1 -0
- 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 +32 -8
- 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/dist/watcher/check.d.ts +87 -0
- package/dist/watcher/check.d.ts.map +1 -0
- package/dist/watcher/check.js +209 -0
- package/dist/watcher/check.js.map +1 -0
- package/dist/watcher/heal.d.ts +66 -0
- package/dist/watcher/heal.d.ts.map +1 -0
- package/dist/watcher/heal.js +132 -0
- package/dist/watcher/heal.js.map +1 -0
- package/dist/watcher/index.d.ts +1 -0
- package/dist/watcher/index.d.ts.map +1 -1
- package/dist/watcher/index.js +48 -52
- package/dist/watcher/index.js.map +1 -1
- package/package.json +6 -1
- package/typings/classes/AccessibilityServer.d.ts +1 -1
- package/typings/classes/AnimationLibrary.d.ts +4 -4
- package/typings/classes/AnimationNodeBlendSpace1D.d.ts +28 -2
- package/typings/classes/AnimationNodeBlendSpace2D.d.ts +28 -2
- package/typings/classes/AreaLight3D.d.ts +37 -0
- package/typings/classes/AudioEffectInstance.d.ts +1 -1
- package/typings/classes/AudioStreamRandomizer.d.ts +10 -0
- package/typings/classes/Basis.d.ts +2 -2
- package/typings/classes/CPUParticles2D.d.ts +2 -2
- package/typings/classes/CPUParticles3D.d.ts +2 -2
- package/typings/classes/CanvasItem.d.ts +15 -0
- package/typings/classes/CodeEdit.d.ts +2 -0
- package/typings/classes/CollisionObject2D.d.ts +2 -2
- package/typings/classes/Container.d.ts +1 -0
- package/typings/classes/Control.d.ts +68 -9
- package/typings/classes/Curve.d.ts +26 -1
- package/typings/classes/Curve2D.d.ts +15 -0
- package/typings/classes/Curve3D.d.ts +20 -0
- package/typings/classes/DirAccess.d.ts +6 -1
- package/typings/classes/DisplayServer.d.ts +35 -10
- package/typings/classes/DrawableTexture2D.d.ts +0 -4
- package/typings/classes/EditorCommandPalette.d.ts +0 -2
- package/typings/classes/EditorContextMenuPlugin.d.ts +4 -0
- package/typings/classes/EditorDock.d.ts +2 -3
- package/typings/classes/EditorExportPlatform.d.ts +4 -2
- package/typings/classes/EditorExportPlugin.d.ts +2 -0
- package/typings/classes/EditorFeatureProfile.d.ts +1 -1
- package/typings/classes/EditorInspector.d.ts +10 -0
- package/typings/classes/EditorInterface.d.ts +2 -2
- package/typings/classes/EditorNode3DGizmoPlugin.d.ts +4 -0
- package/typings/classes/EditorPlugin.d.ts +4 -4
- package/typings/classes/EditorResourcePicker.d.ts +2 -1
- package/typings/classes/EditorSceneFormatImporter.d.ts +23 -0
- package/typings/classes/EditorSettings.d.ts +44 -7
- package/typings/classes/EditorTranslationParserPlugin.d.ts +4 -0
- package/typings/classes/EditorVCSInterface.d.ts +6 -2
- package/typings/classes/FileDialog.d.ts +15 -0
- package/typings/classes/Font.d.ts +13 -1
- package/typings/classes/FontVariation.d.ts +10 -0
- package/typings/classes/GDScript.d.ts +8 -0
- package/typings/classes/GDScriptLanguageProtocol.d.ts +25 -0
- package/typings/classes/GDScriptSyntaxHighlighter.d.ts +6 -0
- package/typings/classes/GDScriptTextDocument.d.ts +27 -0
- package/typings/classes/GDScriptWorkspace.d.ts +17 -0
- package/typings/classes/GPUParticles2D.d.ts +2 -2
- package/typings/classes/GPUParticles3D.d.ts +15 -2
- package/typings/classes/Geometry2D.d.ts +2 -2
- package/typings/classes/Image.d.ts +6 -4
- package/typings/classes/ImageFormatLoader.d.ts +5 -0
- package/typings/classes/Input.d.ts +11 -2
- package/typings/classes/InputEventMouseMotion.d.ts +2 -2
- package/typings/classes/ItemList.d.ts +20 -0
- package/typings/classes/IterateIK3D.d.ts +6 -3
- package/typings/classes/JavaClassWrapper.d.ts +13 -0
- package/typings/classes/JavaScriptBridge.d.ts +1 -1
- package/typings/classes/Label.d.ts +1 -0
- package/typings/classes/LabelSettings.d.ts +25 -0
- package/typings/classes/Light3D.d.ts +1 -1
- package/typings/classes/Logger.d.ts +1 -1
- package/typings/classes/LookAtModifier3D.d.ts +1 -1
- package/typings/classes/MenuButton.d.ts +35 -0
- package/typings/classes/MeshLibrary.d.ts +2 -0
- package/typings/classes/MovieWriter.d.ts +2 -0
- package/typings/classes/MultiplayerPeerExtension.d.ts +9 -9
- package/typings/classes/Node.d.ts +6 -0
- package/typings/classes/Node3D.d.ts +6 -4
- package/typings/classes/OS.d.ts +1 -1
- package/typings/classes/Object.d.ts +11 -8
- package/typings/classes/OptimizedTranslation.d.ts +2 -2
- package/typings/classes/OptionButton.d.ts +51 -7
- package/typings/classes/PacketPeerExtension.d.ts +1 -1
- package/typings/classes/ParticleProcessMaterial.d.ts +58 -0
- package/typings/classes/PhysicsDirectSpaceState2DExtension.d.ts +6 -6
- package/typings/classes/PhysicsDirectSpaceState3DExtension.d.ts +6 -6
- package/typings/classes/PhysicsServer2DExtension.d.ts +5 -5
- package/typings/classes/PhysicsServer3DExtension.d.ts +1 -1
- package/typings/classes/PopupMenu.d.ts +58 -6
- package/typings/classes/ProjectSettings.d.ts +89 -21
- package/typings/classes/Quaternion.d.ts +2 -2
- package/typings/classes/RDAccelerationStructureGeometry.d.ts +42 -0
- package/typings/classes/RDAccelerationStructureInstance.d.ts +34 -0
- package/typings/classes/RDHitGroup.d.ts +20 -0
- package/typings/classes/RDPipelineShader.d.ts +14 -0
- package/typings/classes/RandomNumberGenerator.d.ts +4 -2
- package/typings/classes/RenderSceneBuffersConfiguration.d.ts +4 -1
- package/typings/classes/RenderingDevice.d.ts +93 -23
- package/typings/classes/RenderingServer.d.ts +51 -3
- package/typings/classes/Resource.d.ts +2 -0
- package/typings/classes/ResourceImporterOBJ.d.ts +1 -1
- package/typings/classes/ResourceImporterScene.d.ts +11 -3
- package/typings/classes/RichTextLabel.d.ts +14 -6
- package/typings/classes/SceneTree.d.ts +29 -5
- package/typings/classes/Script.d.ts +2 -0
- package/typings/classes/ScriptEditor.d.ts +7 -0
- package/typings/classes/ScriptLanguageExtension.d.ts +7 -0
- package/typings/classes/ScrollContainer.d.ts +17 -5
- package/typings/classes/SkeletonModification2DJiggle.d.ts +4 -0
- package/typings/classes/SpringBoneSimulator3D.d.ts +4 -2
- package/typings/classes/SpriteFrames.d.ts +20 -4
- package/typings/classes/StreamPeerExtension.d.ts +2 -2
- package/typings/classes/TabBar.d.ts +20 -0
- package/typings/classes/TabContainer.d.ts +21 -3
- package/typings/classes/TextEdit.d.ts +2 -2
- package/typings/classes/TextServer.d.ts +23 -1
- package/typings/classes/TextServerExtension.d.ts +23 -1
- package/typings/classes/TileSet.d.ts +3 -1
- package/typings/classes/Tree.d.ts +16 -7
- package/typings/classes/TreeItem.d.ts +9 -2
- package/typings/classes/UndoRedo.d.ts +2 -2
- package/typings/classes/Vector2.d.ts +4 -2
- package/typings/classes/Vector2i.d.ts +4 -2
- package/typings/classes/Vector3.d.ts +4 -2
- package/typings/classes/Vector3i.d.ts +4 -2
- package/typings/classes/Vector4.d.ts +4 -2
- package/typings/classes/Vector4i.d.ts +4 -2
- package/typings/classes/Viewport.d.ts +17 -1
- package/typings/classes/Window.d.ts +20 -6
- package/typings/classes/_globals.d.ts +104 -26
- package/typings/classes/index.d.ts +10 -112
- package/typings/godot-class-registry.json +885 -3604
- package/typings/classes/VisualShader.d.ts +0 -112
- package/typings/classes/VisualShaderNode.d.ts +0 -63
- package/typings/classes/VisualShaderNodeBillboard.d.ts +0 -28
- package/typings/classes/VisualShaderNodeBooleanConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeBooleanParameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeClamp.d.ts +0 -26
- package/typings/classes/VisualShaderNodeColorConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeColorFunc.d.ts +0 -32
- package/typings/classes/VisualShaderNodeColorOp.d.ts +0 -32
- package/typings/classes/VisualShaderNodeColorParameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeComment.d.ts +0 -12
- package/typings/classes/VisualShaderNodeCompare.d.ts +0 -68
- package/typings/classes/VisualShaderNodeConstant.d.ts +0 -6
- package/typings/classes/VisualShaderNodeCubemap.d.ts +0 -43
- package/typings/classes/VisualShaderNodeCubemapParameter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeCurveTexture.d.ts +0 -10
- package/typings/classes/VisualShaderNodeCurveXYZTexture.d.ts +0 -10
- package/typings/classes/VisualShaderNodeCustom.d.ts +0 -122
- package/typings/classes/VisualShaderNodeDerivativeFunc.d.ts +0 -56
- package/typings/classes/VisualShaderNodeDeterminant.d.ts +0 -6
- package/typings/classes/VisualShaderNodeDistanceFade.d.ts +0 -6
- package/typings/classes/VisualShaderNodeDotProduct.d.ts +0 -6
- package/typings/classes/VisualShaderNodeExpression.d.ts +0 -12
- package/typings/classes/VisualShaderNodeFaceForward.d.ts +0 -8
- package/typings/classes/VisualShaderNodeFloatConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeFloatFunc.d.ts +0 -108
- package/typings/classes/VisualShaderNodeFloatOp.d.ts +0 -36
- package/typings/classes/VisualShaderNodeFloatParameter.d.ts +0 -52
- package/typings/classes/VisualShaderNodeFrame.d.ts +0 -35
- package/typings/classes/VisualShaderNodeFresnel.d.ts +0 -6
- package/typings/classes/VisualShaderNodeGlobalExpression.d.ts +0 -6
- package/typings/classes/VisualShaderNodeGroupBase.d.ts +0 -60
- package/typings/classes/VisualShaderNodeIf.d.ts +0 -8
- package/typings/classes/VisualShaderNodeInput.d.ts +0 -20
- package/typings/classes/VisualShaderNodeIntConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeIntFunc.d.ts +0 -24
- package/typings/classes/VisualShaderNodeIntOp.d.ts +0 -48
- package/typings/classes/VisualShaderNodeIntParameter.d.ts +0 -58
- package/typings/classes/VisualShaderNodeIs.d.ts +0 -18
- package/typings/classes/VisualShaderNodeLinearSceneDepth.d.ts +0 -6
- package/typings/classes/VisualShaderNodeMix.d.ts +0 -28
- package/typings/classes/VisualShaderNodeMultiplyAdd.d.ts +0 -22
- package/typings/classes/VisualShaderNodeOuterProduct.d.ts +0 -6
- package/typings/classes/VisualShaderNodeOutput.d.ts +0 -6
- package/typings/classes/VisualShaderNodeParameter.d.ts +0 -32
- package/typings/classes/VisualShaderNodeParameterRef.d.ts +0 -10
- package/typings/classes/VisualShaderNodeParticleAccelerator.d.ts +0 -20
- package/typings/classes/VisualShaderNodeParticleBoxEmitter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeParticleConeVelocity.d.ts +0 -6
- package/typings/classes/VisualShaderNodeParticleEmit.d.ts +0 -22
- package/typings/classes/VisualShaderNodeParticleEmitter.d.ts +0 -12
- package/typings/classes/VisualShaderNodeParticleMeshEmitter.d.ts +0 -20
- package/typings/classes/VisualShaderNodeParticleMultiplyByAxisAngle.d.ts +0 -10
- package/typings/classes/VisualShaderNodeParticleOutput.d.ts +0 -6
- package/typings/classes/VisualShaderNodeParticleRandomness.d.ts +0 -22
- package/typings/classes/VisualShaderNodeParticleRingEmitter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeParticleSphereEmitter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeProximityFade.d.ts +0 -6
- package/typings/classes/VisualShaderNodeRandomRange.d.ts +0 -6
- package/typings/classes/VisualShaderNodeRemap.d.ts +0 -33
- package/typings/classes/VisualShaderNodeReroute.d.ts +0 -8
- package/typings/classes/VisualShaderNodeResizableBase.d.ts +0 -10
- package/typings/classes/VisualShaderNodeRotationByAxis.d.ts +0 -6
- package/typings/classes/VisualShaderNodeSDFRaymarch.d.ts +0 -6
- package/typings/classes/VisualShaderNodeSDFToScreenUV.d.ts +0 -8
- package/typings/classes/VisualShaderNodeSample3D.d.ts +0 -18
- package/typings/classes/VisualShaderNodeScreenNormalWorldSpace.d.ts +0 -6
- package/typings/classes/VisualShaderNodeScreenUVToSDF.d.ts +0 -8
- package/typings/classes/VisualShaderNodeSmoothStep.d.ts +0 -28
- package/typings/classes/VisualShaderNodeStep.d.ts +0 -28
- package/typings/classes/VisualShaderNodeSwitch.d.ts +0 -30
- package/typings/classes/VisualShaderNodeTexture.d.ts +0 -57
- package/typings/classes/VisualShaderNodeTexture2DArray.d.ts +0 -12
- package/typings/classes/VisualShaderNodeTexture2DArrayParameter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTexture2DParameter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTexture3D.d.ts +0 -12
- package/typings/classes/VisualShaderNodeTexture3DParameter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTextureParameter.d.ts +0 -104
- package/typings/classes/VisualShaderNodeTextureParameterTriplanar.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTextureSDF.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTextureSDFNormal.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTransformCompose.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTransformConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeTransformDecompose.d.ts +0 -6
- package/typings/classes/VisualShaderNodeTransformFunc.d.ts +0 -18
- package/typings/classes/VisualShaderNodeTransformOp.d.ts +0 -32
- package/typings/classes/VisualShaderNodeTransformParameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeTransformVecMult.d.ts +0 -22
- package/typings/classes/VisualShaderNodeUIntConstant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeUIntFunc.d.ts +0 -20
- package/typings/classes/VisualShaderNodeUIntOp.d.ts +0 -48
- package/typings/classes/VisualShaderNodeUIntParameter.d.ts +0 -16
- package/typings/classes/VisualShaderNodeUVFunc.d.ts +0 -22
- package/typings/classes/VisualShaderNodeUVPolarCoord.d.ts +0 -6
- package/typings/classes/VisualShaderNodeVarying.d.ts +0 -14
- package/typings/classes/VisualShaderNodeVaryingGetter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeVaryingSetter.d.ts +0 -6
- package/typings/classes/VisualShaderNodeVec2Constant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeVec2Parameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeVec3Constant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeVec3Parameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeVec4Constant.d.ts +0 -10
- package/typings/classes/VisualShaderNodeVec4Parameter.d.ts +0 -14
- package/typings/classes/VisualShaderNodeVectorBase.d.ts +0 -20
- package/typings/classes/VisualShaderNodeVectorCompose.d.ts +0 -8
- package/typings/classes/VisualShaderNodeVectorDecompose.d.ts +0 -8
- package/typings/classes/VisualShaderNodeVectorDistance.d.ts +0 -6
- package/typings/classes/VisualShaderNodeVectorFunc.d.ts +0 -84
- package/typings/classes/VisualShaderNodeVectorLen.d.ts +0 -6
- package/typings/classes/VisualShaderNodeVectorOp.d.ts +0 -42
- package/typings/classes/VisualShaderNodeVectorRefract.d.ts +0 -8
- package/typings/classes/VisualShaderNodeWorldPositionFromDepth.d.ts +0 -8
|
@@ -43,8 +43,17 @@ declare class Control extends CanvasItem {
|
|
|
43
43
|
* Enables whether rendering of {@link CanvasItem} based children should be clipped to this control's rectangle. If `true`, parts of a child which would be visibly outside of this control's rectangle will not be rendered and won't receive input.
|
|
44
44
|
*/
|
|
45
45
|
clip_contents: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* The maximum size of this Control's bounding rectangle. If set to a value greater than or equal to `(0, 0)`, the node's bounding rectangle will never exceed this size. A value below `(0, 0)` means there is no maximum size.
|
|
48
|
+
* **Note:** The final effective maximum size may be subject to parent Container sizing and propagated maximum sizes. See also: {@link get_combined_maximum_size}.
|
|
49
|
+
* **Note:** Not all {@link Control} subtypes handle a custom maximum size gracefully, which may lead to unexpected behavior if the control's contents exceed this size.
|
|
50
|
+
* **Note:** This value has priority over {@link custom_minimum_size}. For example, if you set {@link custom_maximum_size} to `(100, 100)` and {@link custom_minimum_size} to `(200, 200)`, the resulting size will be `(100, 100)`.
|
|
51
|
+
* **Note:** It is recommended to use {@link get_bound_minimum_size} instead of {@link get_combined_minimum_size} when using this property, as the former respects maximum size limits when calculating the minimum size, while the latter does not.
|
|
52
|
+
*/
|
|
53
|
+
custom_maximum_size: Vector2;
|
|
46
54
|
/**
|
|
47
55
|
* The minimum size of the node's bounding rectangle. If you set it to a value greater than `(0, 0)`, the node's bounding rectangle will always have at least this size. Note that {@link Control} nodes have their internal minimum size returned by {@link get_minimum_size}. It depends on the control's contents, like text, textures, or style boxes. The actual minimum size is the maximum value of this property and the internal minimum size (see {@link get_combined_minimum_size}).
|
|
56
|
+
* **Note:** {@link custom_maximum_size} has priority over this property. For example, if you set {@link custom_minimum_size} to `(200, 200)` and {@link custom_maximum_size} to `(100, 100)`, the resulting size will be `(100, 100)`.
|
|
48
57
|
*/
|
|
49
58
|
custom_minimum_size: Vector2;
|
|
50
59
|
/**
|
|
@@ -197,6 +206,10 @@ declare class Control extends CanvasItem {
|
|
|
197
206
|
* The node's position, relative to its containing node. It corresponds to the rectangle's top-left corner. The property is not affected by {@link pivot_offset}.
|
|
198
207
|
*/
|
|
199
208
|
position: Vector2;
|
|
209
|
+
/**
|
|
210
|
+
* If `true`, this Control's children will use the value returned by {@link get_combined_maximum_size} in their own size calculations.
|
|
211
|
+
*/
|
|
212
|
+
propagate_maximum_size: boolean;
|
|
200
213
|
/**
|
|
201
214
|
* The node's rotation around its pivot, in radians. See {@link pivot_offset} to change the pivot's position.
|
|
202
215
|
* **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use {@link rotation_degrees}.
|
|
@@ -254,6 +267,10 @@ declare class Control extends CanvasItem {
|
|
|
254
267
|
* The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding {@link _make_custom_tooltip}. The default tooltip includes a {@link PopupPanel} and {@link Label} whose theme properties can be customized using {@link Theme} methods with the `"TooltipPanel"` and `"TooltipLabel"` respectively. For example:
|
|
255
268
|
*/
|
|
256
269
|
tooltip_text: string;
|
|
270
|
+
/**
|
|
271
|
+
* The translation context used when translating this control's displayed text, if it has any. Also used when generating translation templates.
|
|
272
|
+
*/
|
|
273
|
+
translation_context: string;
|
|
257
274
|
set_accessibility_controls_nodes(value: Array<NodePath>): void;
|
|
258
275
|
get_accessibility_controls_nodes(): Array<NodePath>;
|
|
259
276
|
set_accessibility_described_by_nodes(value: Array<NodePath>): void;
|
|
@@ -276,6 +293,8 @@ declare class Control extends CanvasItem {
|
|
|
276
293
|
is_auto_translating(): boolean;
|
|
277
294
|
set_clip_contents(value: boolean): void;
|
|
278
295
|
is_clipping_contents(): boolean;
|
|
296
|
+
set_custom_maximum_size(value: Vector2 | Vector2i): void;
|
|
297
|
+
get_custom_maximum_size(): Vector2;
|
|
279
298
|
set_custom_minimum_size(value: Vector2 | Vector2i): void;
|
|
280
299
|
get_custom_minimum_size(): Vector2;
|
|
281
300
|
set_focus_behavior_recursive(value: int): void;
|
|
@@ -324,6 +343,8 @@ declare class Control extends CanvasItem {
|
|
|
324
343
|
get_pivot_offset_ratio(): Vector2;
|
|
325
344
|
_set_position(value: Vector2 | Vector2i): void;
|
|
326
345
|
get_position(): Vector2;
|
|
346
|
+
set_propagate_maximum_size(value: boolean): void;
|
|
347
|
+
is_propagating_maximum_size(): boolean;
|
|
327
348
|
set_rotation(value: float): void;
|
|
328
349
|
get_rotation(): float;
|
|
329
350
|
set_rotation_degrees(value: float): void;
|
|
@@ -348,6 +369,8 @@ declare class Control extends CanvasItem {
|
|
|
348
369
|
get_tooltip_auto_translate_mode(): int;
|
|
349
370
|
set_tooltip_text(value: string | NodePath): void;
|
|
350
371
|
get_tooltip_text(): string;
|
|
372
|
+
set_translation_context(value: string): void;
|
|
373
|
+
get_translation_context(): string;
|
|
351
374
|
|
|
352
375
|
/** Return the description of the keyboard shortcuts and other contextual help for this control. */
|
|
353
376
|
_accessibility_get_contextual_info(): string;
|
|
@@ -366,12 +389,24 @@ declare class Control extends CanvasItem {
|
|
|
366
389
|
* Override this method to return a human-readable description of the position of the child `node` in the custom container, added to the {@link accessibility_name}.
|
|
367
390
|
*/
|
|
368
391
|
_get_accessibility_container_name(node: Node): string;
|
|
392
|
+
/**
|
|
393
|
+
* Virtual method to be implemented by the user. Returns the cursor shape for the position `at_position` in the control's local coordinates, which will typically be used while hovering over this control. See {@link get_cursor_shape}.
|
|
394
|
+
* If not overridden, defaults to {@link mouse_default_cursor_shape}.
|
|
395
|
+
*/
|
|
396
|
+
_get_cursor_shape(at_position: Vector2 | Vector2i): int;
|
|
369
397
|
/**
|
|
370
398
|
* Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns `null` if there is no data to drag. Controls that want to receive drop data should implement {@link _can_drop_data} and {@link _drop_data}. `at_position` is local to this control. Drag may be forced with {@link force_drag}.
|
|
371
399
|
* A preview that will follow the mouse that should represent the data can be set with {@link set_drag_preview}. A good time to set the preview is in this method.
|
|
372
400
|
* **Note:** If the drag was initiated by a keyboard shortcut or {@link accessibility_drag}, `at_position` is set to {@link Vector2.INF}, and the currently selected item/text position should be used as the drag position.
|
|
373
401
|
*/
|
|
374
402
|
_get_drag_data(at_position: Vector2 | Vector2i): unknown;
|
|
403
|
+
/**
|
|
404
|
+
* Virtual method to be implemented by the user. Returns the maximum size for this control. Alternative to {@link custom_maximum_size} for controlling maximum size via code. The actual maximum size will be the max value of these two (in each axis separately).
|
|
405
|
+
* If not overridden, defaults to {@link Vector2.ZERO}.
|
|
406
|
+
* **Note:** This method will not be called when the script is attached to a {@link Control} node that already overrides its maximum size (e.g. {@link ScrollContainer}).
|
|
407
|
+
* **Note:** It is recommended to use {@link get_bound_minimum_size} instead of {@link get_combined_minimum_size} when implementing this method, as the former respects maximum size limits when calculating the minimum size, while the latter does not.
|
|
408
|
+
*/
|
|
409
|
+
_get_maximum_size(): Vector2;
|
|
375
410
|
/**
|
|
376
411
|
* Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to {@link custom_minimum_size} for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately).
|
|
377
412
|
* If not overridden, defaults to {@link Vector2.ZERO}.
|
|
@@ -379,10 +414,14 @@ declare class Control extends CanvasItem {
|
|
|
379
414
|
*/
|
|
380
415
|
_get_minimum_size(): Vector2;
|
|
381
416
|
/**
|
|
382
|
-
* Virtual method to be implemented by the user. Returns the tooltip text for the position `at_position` in control's local coordinates, which will typically appear when the cursor is resting over this control. See {@link get_tooltip}.
|
|
417
|
+
* Virtual method to be implemented by the user. Returns the tooltip text for the position `at_position` in the control's local coordinates, which will typically appear when the cursor is resting over this control. See {@link get_tooltip}.
|
|
383
418
|
* **Note:** If this method returns an empty {@link String} and {@link _make_custom_tooltip} is not overridden, no tooltip is displayed.
|
|
384
419
|
*/
|
|
385
420
|
_get_tooltip(at_position: Vector2 | Vector2i): string;
|
|
421
|
+
/**
|
|
422
|
+
* Return the auto-translation mode at the given `at_position`. If not implemented, the {@link tooltip_auto_translate_mode} property will be used instead.
|
|
423
|
+
*/
|
|
424
|
+
_get_tooltip_auto_translate_mode_at(at_position: Vector2 | Vector2i): int;
|
|
386
425
|
/**
|
|
387
426
|
* Virtual method to be implemented by the user. Override this method to handle and accept inputs on UI elements. See also {@link accept_event}.
|
|
388
427
|
* **Example:** Click on the control to print a message:
|
|
@@ -397,7 +436,7 @@ declare class Control extends CanvasItem {
|
|
|
397
436
|
_gui_input(event: InputEvent): void;
|
|
398
437
|
/**
|
|
399
438
|
* Virtual method to be implemented by the user. Returns whether the given `point` is inside this control.
|
|
400
|
-
* If not overridden, default behavior is checking if the point is within control's Rect.
|
|
439
|
+
* If not overridden, default behavior is checking if the point is within the control's Rect.
|
|
401
440
|
* **Note:** If you want to check if a point is inside the control, you can use `Rect2(Vector2.ZERO, size).has_point(point)`.
|
|
402
441
|
*/
|
|
403
442
|
_has_point(point: Vector2 | Vector2i): boolean;
|
|
@@ -484,16 +523,27 @@ declare class Control extends CanvasItem {
|
|
|
484
523
|
get_anchor(side: int): float;
|
|
485
524
|
/** Returns {@link offset_left} and {@link offset_top}. See also {@link position}. */
|
|
486
525
|
get_begin(): Vector2;
|
|
487
|
-
/**
|
|
526
|
+
/**
|
|
527
|
+
* Returns the bound value of {@link get_combined_minimum_size} by {@link get_combined_maximum_size}.
|
|
528
|
+
* This value is the true minimum size of the container, as the maximum size has priority over the minimum size.
|
|
529
|
+
* For example, if the combined minimum size is (100, 100) and the combined maximum size is (50, 150), the bound minimum size will be (50, 100).
|
|
530
|
+
*/
|
|
531
|
+
get_bound_minimum_size(): Vector2;
|
|
532
|
+
/**
|
|
533
|
+
* Returns the combined maximum size from {@link custom_maximum_size} and {@link get_maximum_size}, as well as the {@link custom_maximum_size} of this node's parent if it is a Control node with {@link propagate_maximum_size} set to `true`.
|
|
534
|
+
*/
|
|
535
|
+
get_combined_maximum_size(): Vector2;
|
|
536
|
+
/** Returns the combined minimum size from {@link custom_minimum_size} and {@link get_minimum_size}. */
|
|
488
537
|
get_combined_minimum_size(): Vector2;
|
|
489
538
|
/**
|
|
490
539
|
* Returns the combined value of {@link pivot_offset} and {@link pivot_offset_ratio}, in pixels. The ratio is multiplied by the control's size.
|
|
491
540
|
*/
|
|
492
541
|
get_combined_pivot_offset(): Vector2;
|
|
493
542
|
/**
|
|
494
|
-
* Returns the mouse cursor shape for this control when hovered over `
|
|
543
|
+
* Returns the mouse cursor shape for this control when hovered over `at_position` in local coordinates. For most controls, this is the same as {@link mouse_default_cursor_shape}, but some built-in controls implement more complex logic.
|
|
544
|
+
* You can override {@link _get_cursor_shape} to implement custom behavior for this method.
|
|
495
545
|
*/
|
|
496
|
-
get_cursor_shape(
|
|
546
|
+
get_cursor_shape(at_position?: Vector2 | Vector2i): int;
|
|
497
547
|
/** Returns {@link offset_right} and {@link offset_bottom}. */
|
|
498
548
|
get_end(): Vector2;
|
|
499
549
|
/**
|
|
@@ -511,6 +561,8 @@ declare class Control extends CanvasItem {
|
|
|
511
561
|
* **Note:** Setting {@link Viewport.gui_snap_controls_to_pixels} to `true` can lead to rounding inaccuracies between the displayed control and the returned {@link Rect2}.
|
|
512
562
|
*/
|
|
513
563
|
get_global_rect(): Rect2;
|
|
564
|
+
/** Returns the maximum size for this control. See {@link custom_maximum_size}. */
|
|
565
|
+
get_maximum_size(): Vector2;
|
|
514
566
|
/** Returns the minimum size for this control. See {@link custom_minimum_size}. */
|
|
515
567
|
get_minimum_size(): Vector2;
|
|
516
568
|
/**
|
|
@@ -583,8 +635,8 @@ declare class Control extends CanvasItem {
|
|
|
583
635
|
*/
|
|
584
636
|
get_theme_stylebox(name: string, theme_type?: string): StyleBox | null;
|
|
585
637
|
/**
|
|
586
|
-
* Returns the tooltip text for the position `at_position` in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns {@link tooltip_text}.
|
|
587
|
-
*
|
|
638
|
+
* Returns the tooltip text for the position `at_position` in the control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns {@link tooltip_text}.
|
|
639
|
+
* You can override {@link _get_tooltip} to implement custom behavior for this method.
|
|
588
640
|
* **Note:** If this method returns an empty {@link String} and {@link _make_custom_tooltip} is not overridden, no tooltip is displayed.
|
|
589
641
|
*/
|
|
590
642
|
get_tooltip(at_position?: Vector2 | Vector2i): string;
|
|
@@ -594,7 +646,7 @@ declare class Control extends CanvasItem {
|
|
|
594
646
|
grab_click_focus(): void;
|
|
595
647
|
/**
|
|
596
648
|
* Steal the focus from another control and become the focused control (see {@link focus_mode}).
|
|
597
|
-
* If `hide_focus` is `true`, the control will not visually show its focused state. Has no effect for {@link LineEdit} and {@link TextEdit} when {@link ProjectSettings.gui/common/show_focus_state_on_pointer_event} is set to `
|
|
649
|
+
* If `hide_focus` is `true`, the control will not visually show its focused state. Has no effect for {@link LineEdit} and {@link TextEdit} when {@link ProjectSettings.gui/common/show_focus_state_on_pointer_event} is set to `Text Input Controls`, or for any control when it is set to `Always`.
|
|
598
650
|
* **Note:** Using this method together with {@link Callable.call_deferred} makes it more reliable, especially when called inside {@link Node._ready}.
|
|
599
651
|
*/
|
|
600
652
|
grab_focus(hide_focus?: boolean): void;
|
|
@@ -767,7 +819,12 @@ declare class Control extends CanvasItem {
|
|
|
767
819
|
*/
|
|
768
820
|
set_size(size: Vector2 | Vector2i, keep_offsets?: boolean): void;
|
|
769
821
|
/**
|
|
770
|
-
* Invalidates the size cache in this node and in parent nodes up to top level. Intended to be used with {@link
|
|
822
|
+
* Invalidates the maximum size cache in this node and in parent nodes up to top level. Intended to be used with {@link get_maximum_size} when the return value is changed. Setting {@link custom_maximum_size} directly calls this method automatically.
|
|
823
|
+
* **Note:** Calling this method also calls {@link update_minimum_size} since the combined minimum size may be affected by the maximum size change.
|
|
824
|
+
*/
|
|
825
|
+
update_maximum_size(): void;
|
|
826
|
+
/**
|
|
827
|
+
* Invalidates the minimum size cache in this node and in parent nodes up to top level. Intended to be used with {@link get_minimum_size} when the return value is changed. Setting {@link custom_minimum_size} directly calls this method automatically.
|
|
771
828
|
*/
|
|
772
829
|
update_minimum_size(): void;
|
|
773
830
|
/**
|
|
@@ -782,6 +839,8 @@ declare class Control extends CanvasItem {
|
|
|
782
839
|
focus_exited: Signal<[]>;
|
|
783
840
|
/** Emitted when the node receives an {@link InputEvent}. */
|
|
784
841
|
gui_input: Signal<[InputEvent]>;
|
|
842
|
+
/** Emitted when the node's maximum size changes. */
|
|
843
|
+
maximum_size_changed: Signal<[]>;
|
|
785
844
|
/** Emitted when the node's minimum size changes. */
|
|
786
845
|
minimum_size_changed: Signal<[]>;
|
|
787
846
|
/**
|
|
@@ -19,6 +19,31 @@ declare class Curve extends Resource {
|
|
|
19
19
|
min_value: float;
|
|
20
20
|
/** The number of points describing the curve. */
|
|
21
21
|
point_count: int;
|
|
22
|
+
/**
|
|
23
|
+
* The left {@link TangentMode} for the point at `index`.
|
|
24
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
25
|
+
*/
|
|
26
|
+
'point_{index}/left_mode': int;
|
|
27
|
+
/**
|
|
28
|
+
* The left tangent angle (in degrees) for the point at `index`.
|
|
29
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
30
|
+
*/
|
|
31
|
+
'point_{index}/left_tangent': float;
|
|
32
|
+
/**
|
|
33
|
+
* The position of the point at `index`.
|
|
34
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
35
|
+
*/
|
|
36
|
+
'point_{index}/position': Vector2;
|
|
37
|
+
/**
|
|
38
|
+
* The right {@link TangentMode} for the point at `index`.
|
|
39
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
40
|
+
*/
|
|
41
|
+
'point_{index}/right_mode': int;
|
|
42
|
+
/**
|
|
43
|
+
* The right tangent angle (in degrees) for the point at `index`.
|
|
44
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
45
|
+
*/
|
|
46
|
+
'point_{index}/right_tangent': float;
|
|
22
47
|
set_bake_resolution(value: int): void;
|
|
23
48
|
get_bake_resolution(): int;
|
|
24
49
|
set_max_domain(value: float): void;
|
|
@@ -70,7 +95,7 @@ declare class Curve extends Resource {
|
|
|
70
95
|
set_point_left_mode(index: int, mode: int): void;
|
|
71
96
|
/** Sets the left tangent angle for the point at `index` to `tangent`. */
|
|
72
97
|
set_point_left_tangent(index: int, tangent: float): void;
|
|
73
|
-
/**
|
|
98
|
+
/** Assigns the horizontal position `offset` to the point at `index`. */
|
|
74
99
|
set_point_offset(index: int, offset: float): int;
|
|
75
100
|
/** Sets the right {@link TangentMode} for the point at `index` to `mode`. */
|
|
76
101
|
set_point_right_mode(index: int, mode: int): void;
|
|
@@ -9,6 +9,21 @@ declare class Curve2D extends Resource {
|
|
|
9
9
|
bake_interval: float;
|
|
10
10
|
/** The number of points describing the curve. */
|
|
11
11
|
point_count: int;
|
|
12
|
+
/**
|
|
13
|
+
* The position of the control point leading to the vertex at `index`.
|
|
14
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
15
|
+
*/
|
|
16
|
+
'point_{index}/in': Vector2;
|
|
17
|
+
/**
|
|
18
|
+
* The position of the control point leading out of the vertex at `index`.
|
|
19
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
20
|
+
*/
|
|
21
|
+
'point_{index}/out': Vector2;
|
|
22
|
+
/**
|
|
23
|
+
* The position of for the vertex at `index`.
|
|
24
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
25
|
+
*/
|
|
26
|
+
'point_{index}/position': Vector2;
|
|
12
27
|
set_bake_interval(value: float): void;
|
|
13
28
|
get_bake_interval(): float;
|
|
14
29
|
set_point_count(value: int): void;
|
|
@@ -13,6 +13,26 @@ declare class Curve3D extends Resource {
|
|
|
13
13
|
closed: boolean;
|
|
14
14
|
/** The number of points describing the curve. */
|
|
15
15
|
point_count: int;
|
|
16
|
+
/**
|
|
17
|
+
* The position of the control point leading to the vertex at `index`.
|
|
18
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
19
|
+
*/
|
|
20
|
+
'point_{index}/in': Vector3;
|
|
21
|
+
/**
|
|
22
|
+
* The position of the control point leading out of the vertex at `index`.
|
|
23
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
24
|
+
*/
|
|
25
|
+
'point_{index}/out': Vector3;
|
|
26
|
+
/**
|
|
27
|
+
* The position of for the vertex at `index`.
|
|
28
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
29
|
+
*/
|
|
30
|
+
'point_{index}/position': Vector3;
|
|
31
|
+
/**
|
|
32
|
+
* The tilt angle in radians for the point at `index`.
|
|
33
|
+
* **Note:** `index` is a value in the `0 .. point_count - 1` range.
|
|
34
|
+
*/
|
|
35
|
+
'point_{index}/tilt': float;
|
|
16
36
|
/**
|
|
17
37
|
* If `true`, the curve will bake up vectors used for orientation. This is used when {@link PathFollow3D.rotation_mode} is set to {@link PathFollow3D.ROTATION_ORIENTED}. Changing it forces the cache to be recomputed.
|
|
18
38
|
*/
|
|
@@ -92,12 +92,17 @@ declare class DirAccess extends RefCounted {
|
|
|
92
92
|
* On other platforms, the method returns 0.
|
|
93
93
|
*/
|
|
94
94
|
static get_drive_count(): int;
|
|
95
|
+
/**
|
|
96
|
+
* On Windows, returns the label of the drive (partition) passed as an argument.
|
|
97
|
+
* On other platforms, or if the requested drive does not exist, returns an empty String.
|
|
98
|
+
*/
|
|
99
|
+
static get_drive_label(idx: int): string;
|
|
95
100
|
/**
|
|
96
101
|
* On Windows, returns the name of the drive (partition) passed as an argument (e.g. `C:`).
|
|
97
102
|
* On macOS, returns the path to the mounted volume passed as an argument.
|
|
98
103
|
* On Linux, returns the path to the mounted volume or GTK 3 bookmark passed as an argument.
|
|
99
104
|
* On Android (API level 30+), returns the path to the mounted volume as an argument.
|
|
100
|
-
* On other platforms, or if the requested drive does not exist,
|
|
105
|
+
* On other platforms, or if the requested drive does not exist, returns an empty String.
|
|
101
106
|
*/
|
|
102
107
|
static get_drive_name(idx: int): string;
|
|
103
108
|
/**
|
|
@@ -95,7 +95,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
95
95
|
/** Sets element background color. */
|
|
96
96
|
accessibility_update_set_background_color(id: RID, color: Color): void;
|
|
97
97
|
/** Sets element bounding box, relative to the node position. */
|
|
98
|
-
accessibility_update_set_bounds(id: RID,
|
|
98
|
+
accessibility_update_set_bounds(id: RID, rect: Rect2 | Rect2i): void;
|
|
99
99
|
/** Sets element checked state. */
|
|
100
100
|
accessibility_update_set_checked(id: RID, checekd: boolean): void;
|
|
101
101
|
/** Sets element class name. */
|
|
@@ -961,7 +961,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
961
961
|
*/
|
|
962
962
|
set_hardware_keyboard_connection_change_callback(callable: Callable): void;
|
|
963
963
|
/**
|
|
964
|
-
* Sets the
|
|
964
|
+
* Sets the application icon and icons of all windows with an {@link Image}. To use icons in the operating system's native format, use {@link set_native_icon} instead.
|
|
965
965
|
* **Note:** Requires support for {@link FEATURE_ICON}.
|
|
966
966
|
*/
|
|
967
967
|
set_icon(image: Image): void;
|
|
@@ -1163,7 +1163,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1163
1163
|
*/
|
|
1164
1164
|
window_get_native_handle(handle_type: int, window_id?: int): int;
|
|
1165
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}.
|
|
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}. The {@link Window.output_max_linear_value_changed} signal will be emitted whenever this value changes. 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
1167
|
*/
|
|
1168
1168
|
window_get_output_max_linear_value(window_id?: int): float;
|
|
1169
1169
|
/**
|
|
@@ -1260,12 +1260,19 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1260
1260
|
window_set_flag(flag: int, enabled: boolean, window_id?: int): void;
|
|
1261
1261
|
/**
|
|
1262
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
|
+
* **Note:** This method is only implemented on macOS and Windows. Other platforms will always use the screen's maximum luminance that is reported by the operating system.
|
|
1263
1264
|
*/
|
|
1264
1265
|
window_set_hdr_output_max_luminance(max_luminance: float, window_id?: int): void;
|
|
1265
1266
|
/**
|
|
1266
1267
|
* 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}.
|
|
1268
|
+
* **Note:** This method is only implemented on Windows. Other platforms will always use the reference luminance that is reported by the operating system.
|
|
1267
1269
|
*/
|
|
1268
1270
|
window_set_hdr_output_reference_luminance(reference_luminance: float, window_id?: int): void;
|
|
1271
|
+
/**
|
|
1272
|
+
* Sets the window icon (usually displayed in the top-left corner) for the window specified by `window_id`.
|
|
1273
|
+
* **Note:** This method is implemented on Linux and Windows.
|
|
1274
|
+
*/
|
|
1275
|
+
window_set_icon(icon: Image, window_id?: int): void;
|
|
1269
1276
|
/**
|
|
1270
1277
|
* 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
1278
|
*/
|
|
@@ -1407,7 +1414,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1407
1414
|
* Display server supports multiple windows that can be moved outside of the main window. **Windows, macOS, Linux (X11)**
|
|
1408
1415
|
*/
|
|
1409
1416
|
readonly FEATURE_SUBWINDOWS: int;
|
|
1410
|
-
/** Display server supports touchscreen input. **Windows, Linux (X11), Android, iOS, Web** */
|
|
1417
|
+
/** Display server supports touchscreen input. **Windows, Linux (X11/Wayland), Android, iOS, Web** */
|
|
1411
1418
|
readonly FEATURE_TOUCHSCREEN: int;
|
|
1412
1419
|
/** Display server supports mouse input. **Windows, macOS, Linux (X11/Wayland), Android, Web** */
|
|
1413
1420
|
readonly FEATURE_MOUSE: int;
|
|
@@ -1514,7 +1521,7 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1514
1521
|
* Display server supports interaction with screen reader or Braille display. **Linux (X11/Wayland), macOS, Windows**
|
|
1515
1522
|
*/
|
|
1516
1523
|
readonly FEATURE_ACCESSIBILITY_SCREEN_READER: int;
|
|
1517
|
-
/** Display server supports HDR output. **macOS, iOS, visionOS, Windows** */
|
|
1524
|
+
/** Display server supports HDR output. **Linux (Wayland), macOS, iOS, visionOS, Windows** */
|
|
1518
1525
|
readonly FEATURE_HDR_OUTPUT: int;
|
|
1519
1526
|
/** Display server supports putting the application in picture-in-picture mode. **Android** */
|
|
1520
1527
|
readonly FEATURE_PIP_MODE: int;
|
|
@@ -1923,13 +1930,18 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1923
1930
|
// enum WindowFlags
|
|
1924
1931
|
/**
|
|
1925
1932
|
* 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.
|
|
1933
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1926
1934
|
*/
|
|
1927
1935
|
readonly WINDOW_FLAG_RESIZE_DISABLED: int;
|
|
1928
1936
|
/**
|
|
1929
1937
|
* The window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
|
|
1938
|
+
* **Note:** This flag is implemented on Linux (X11/Wayland), macOS, and Windows.
|
|
1930
1939
|
*/
|
|
1931
1940
|
readonly WINDOW_FLAG_BORDERLESS: int;
|
|
1932
|
-
/**
|
|
1941
|
+
/**
|
|
1942
|
+
* The window is floating on top of all other windows. This flag is ignored for full-screen windows.
|
|
1943
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1944
|
+
*/
|
|
1933
1945
|
readonly WINDOW_FLAG_ALWAYS_ON_TOP: int;
|
|
1934
1946
|
/**
|
|
1935
1947
|
* The window background can be transparent.
|
|
@@ -1938,10 +1950,14 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1938
1950
|
* **Note:** Transparency support is implemented on Android, but can only be enabled via {@link ProjectSettings.display/window/per_pixel_transparency/allowed}. This flag has no effect on Android.
|
|
1939
1951
|
*/
|
|
1940
1952
|
readonly WINDOW_FLAG_TRANSPARENT: int;
|
|
1941
|
-
/**
|
|
1953
|
+
/**
|
|
1954
|
+
* The window can't be focused. No-focus window will ignore all input, except mouse clicks.
|
|
1955
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1956
|
+
*/
|
|
1942
1957
|
readonly WINDOW_FLAG_NO_FOCUS: int;
|
|
1943
1958
|
/**
|
|
1944
1959
|
* Window is part of menu or {@link OptionButton} dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see {@link window_set_transient}).
|
|
1960
|
+
* **Note:** This flag is implemented on Linux (X11/Wayland), macOS, and Windows.
|
|
1945
1961
|
*/
|
|
1946
1962
|
readonly WINDOW_FLAG_POPUP: int;
|
|
1947
1963
|
/**
|
|
@@ -1951,7 +1967,10 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1951
1967
|
* **Note:** This flag is implemented only on macOS.
|
|
1952
1968
|
*/
|
|
1953
1969
|
readonly WINDOW_FLAG_EXTEND_TO_TITLE: int;
|
|
1954
|
-
/**
|
|
1970
|
+
/**
|
|
1971
|
+
* All mouse events are passed to the underlying window of the same application.
|
|
1972
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1973
|
+
*/
|
|
1955
1974
|
readonly WINDOW_FLAG_MOUSE_PASSTHROUGH: int;
|
|
1956
1975
|
/**
|
|
1957
1976
|
* Window style is overridden, forcing sharp corners.
|
|
@@ -1966,16 +1985,17 @@ declare interface DisplayServer extends GodotObject {
|
|
|
1966
1985
|
readonly WINDOW_FLAG_EXCLUDE_FROM_CAPTURE: int;
|
|
1967
1986
|
/**
|
|
1968
1987
|
* Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window).
|
|
1988
|
+
* **Note:** This flag is implemented on Linux (Wayland).
|
|
1969
1989
|
*/
|
|
1970
1990
|
readonly WINDOW_FLAG_POPUP_WM_HINT: int;
|
|
1971
1991
|
/**
|
|
1972
1992
|
* Window minimize button is disabled.
|
|
1973
|
-
* **Note:** This flag is implemented on macOS and Windows.
|
|
1993
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1974
1994
|
*/
|
|
1975
1995
|
readonly WINDOW_FLAG_MINIMIZE_DISABLED: int;
|
|
1976
1996
|
/**
|
|
1977
1997
|
* Window maximize button is disabled.
|
|
1978
|
-
* **Note:** This flag is implemented on macOS and Windows.
|
|
1998
|
+
* **Note:** This flag is implemented on Linux (X11), macOS, and Windows.
|
|
1979
1999
|
*/
|
|
1980
2000
|
readonly WINDOW_FLAG_MAXIMIZE_DISABLED: int;
|
|
1981
2001
|
/** Represents the size of the {@link WindowFlags} enum. */
|
|
@@ -2011,6 +2031,11 @@ declare interface DisplayServer extends GodotObject {
|
|
|
2011
2031
|
* **Note:** This flag is implemented only on Linux (Wayland).
|
|
2012
2032
|
*/
|
|
2013
2033
|
readonly WINDOW_EVENT_FORCE_CLOSE: int;
|
|
2034
|
+
/**
|
|
2035
|
+
* Sent when the output max linear value returned by {@link Window.get_output_max_linear_value} has changed.
|
|
2036
|
+
* This occurs when HDR output is enabled or disabled and when any HDR output luminance values of the window have changed, such as when the player adjusts their screen brightness setting or moves the window to a different screen.
|
|
2037
|
+
*/
|
|
2038
|
+
readonly WINDOW_EVENT_OUTPUT_MAX_LINEAR_VALUE_CHANGED: int;
|
|
2014
2039
|
// enum WindowResizeEdge
|
|
2015
2040
|
/** Top-left edge of a window. */
|
|
2016
2041
|
readonly WINDOW_EDGE_TOP_LEFT: int;
|
|
@@ -19,12 +19,8 @@ declare class DrawableTexture2D extends Texture2D {
|
|
|
19
19
|
get_use_mipmaps(): boolean;
|
|
20
20
|
/** Sets the format of this DrawableTexture. */
|
|
21
21
|
set_format(format: int): void;
|
|
22
|
-
/** Sets the height of this DrawableTexture. */
|
|
23
|
-
set_height(height: int): void;
|
|
24
22
|
/** Sets if mipmaps should be used on this DrawableTexture. */
|
|
25
23
|
set_use_mipmaps(mipmaps: boolean): void;
|
|
26
|
-
/** Sets the width of this DrawableTexture. */
|
|
27
|
-
set_width(width: int): void;
|
|
28
24
|
/** Initializes the DrawableTexture to a White texture of the given `width`, `height`, and `format`. */
|
|
29
25
|
setup(width: int, height: int, format: int, color?: Color, use_mipmaps?: boolean): void;
|
|
30
26
|
|
|
@@ -3,8 +3,6 @@
|
|
|
3
3
|
|
|
4
4
|
/** Godot editor's command palette. */
|
|
5
5
|
declare class EditorCommandPalette extends ConfirmationDialog {
|
|
6
|
-
dialog_hide_on_ok: boolean;
|
|
7
|
-
|
|
8
6
|
/**
|
|
9
7
|
* Adds a custom command to EditorCommandPalette.
|
|
10
8
|
* - `command_name`: {@link String} (Name of the **Command**. This is displayed to the user.)
|
|
@@ -56,4 +56,8 @@ declare class EditorContextMenuPlugin extends RefCounted {
|
|
|
56
56
|
* The paths array is empty if there weren't any nodes under cursor. The option callback will receive a typed array of {@link CanvasItem} nodes.
|
|
57
57
|
*/
|
|
58
58
|
static readonly CONTEXT_SLOT_2D_EDITOR: int;
|
|
59
|
+
/**
|
|
60
|
+
* Context menu of the inspectors right-click menu. {@link _popup_menu} will be called with an array of two items: The first will be the object's ID, the second will be the property name. An object can be retrieved from it's ID via {@link @GlobalScope.instance_from_id} after converting it to an int. The option callback will receive the EditorProperty directly.
|
|
61
|
+
*/
|
|
62
|
+
static readonly CONTEXT_SLOT_INSPECTOR_PROPERTY: int;
|
|
59
63
|
}
|
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
/** Dockable container for the editor. */
|
|
5
5
|
declare class EditorDock extends MarginContainer {
|
|
6
6
|
/**
|
|
7
|
+
* <member name="available_layouts" type="int" setter="set_available_layouts" getter="get_available_layouts" enum="EditorDock.DockLayout" is_bitfield="true" default="5">
|
|
7
8
|
* The available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts.
|
|
8
9
|
*/
|
|
9
|
-
|
|
10
|
+
accessibility_region: boolean;
|
|
10
11
|
/**
|
|
11
12
|
* If `true`, the dock can be closed with the Close button in the context popup. Docks with {@link global} enabled are always closable.
|
|
12
13
|
*/
|
|
@@ -46,8 +47,6 @@ declare class EditorDock extends MarginContainer {
|
|
|
46
47
|
* 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.
|
|
47
48
|
*/
|
|
48
49
|
transient: boolean;
|
|
49
|
-
set_available_layouts(value: int): void;
|
|
50
|
-
get_available_layouts(): int;
|
|
51
50
|
set_closable(value: boolean): void;
|
|
52
51
|
is_closable(): boolean;
|
|
53
52
|
set_default_slot(value: int): void;
|
|
@@ -18,8 +18,10 @@ declare class EditorExportPlatform extends RefCounted {
|
|
|
18
18
|
* **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.
|
|
19
19
|
*/
|
|
20
20
|
export_pack_patch(preset: EditorExportPreset, debug: boolean, path: string | NodePath, patches?: PackedStringArray | Array<unknown>, flags?: int): int;
|
|
21
|
-
/**
|
|
22
|
-
|
|
21
|
+
/**
|
|
22
|
+
* 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.
|
|
23
|
+
*/
|
|
24
|
+
export_project(preset: EditorExportPreset, debug: boolean, path: string | NodePath, flags: int, notify?: boolean): int;
|
|
23
25
|
/**
|
|
24
26
|
* 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.
|
|
25
27
|
* `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`.
|
|
@@ -30,6 +30,7 @@ declare class EditorExportPlugin extends RefCounted {
|
|
|
30
30
|
/**
|
|
31
31
|
* 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.
|
|
32
32
|
* Implementing this method is required if {@link _begin_customize_scenes} returns `true`.
|
|
33
|
+
* **Note:** To change a variable in your scene, use the `@export` annotation when declaring it.
|
|
33
34
|
*/
|
|
34
35
|
_customize_scene(scene: Node, path: string | NodePath): Node | null;
|
|
35
36
|
/** This is called when the customization process for resources ends. */
|
|
@@ -89,6 +90,7 @@ declare class EditorExportPlugin extends RefCounted {
|
|
|
89
90
|
/**
|
|
90
91
|
* Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.
|
|
91
92
|
* Implementing this method is required if {@link _begin_customize_resources} returns `true`.
|
|
93
|
+
* **Note:** {@link _customize_resource} and {@link _customize_scene} will not be called when the {@link EditorExportPlugin} script is modified unless this hash changes too.
|
|
92
94
|
*/
|
|
93
95
|
_get_customization_configuration_hash(): int;
|
|
94
96
|
/**
|
|
@@ -57,7 +57,7 @@ declare class EditorFeatureProfile extends RefCounted {
|
|
|
57
57
|
* The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won't display.
|
|
58
58
|
*/
|
|
59
59
|
static readonly FEATURE_SCRIPT: int;
|
|
60
|
-
/** The
|
|
60
|
+
/** The Asset Store tab. If this feature is disabled, the Asset Store tab won't display. */
|
|
61
61
|
static readonly FEATURE_ASSET_LIB: int;
|
|
62
62
|
/**
|
|
63
63
|
* Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only.
|
|
@@ -10,11 +10,21 @@ declare class EditorInspector extends ScrollContainer {
|
|
|
10
10
|
set_draw_focus_border(value: boolean): void;
|
|
11
11
|
get_draw_focus_border(): boolean;
|
|
12
12
|
|
|
13
|
+
/** Collapses all foldable sections. */
|
|
14
|
+
collapse_all_folding(): void;
|
|
15
|
+
/**
|
|
16
|
+
* 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.
|
|
17
|
+
*/
|
|
18
|
+
static create_default_inspector(filter_line_edit?: LineEdit): EditorInspector | null;
|
|
13
19
|
/**
|
|
14
20
|
* Shows the properties of the given `object` in this inspector for editing. To clear the inspector, call this method with `null`.
|
|
15
21
|
* **Note:** If you want to edit an object in the editor's main inspector, use the `edit_*` methods in {@link EditorInterface} instead.
|
|
16
22
|
*/
|
|
17
23
|
edit(object: GodotObject): void;
|
|
24
|
+
/** Expands all foldable sections. */
|
|
25
|
+
expand_all_folding(): void;
|
|
26
|
+
/** Expands only the foldable sections that contain a revertable (i.e. non-default) property. */
|
|
27
|
+
expand_revertable(): void;
|
|
18
28
|
/** Returns the object currently selected in this inspector. */
|
|
19
29
|
get_edited_object(): GodotObject | null;
|
|
20
30
|
/** Gets the path of the currently selected property. */
|
|
@@ -215,7 +215,7 @@ declare interface EditorInterface extends GodotObject {
|
|
|
215
215
|
* 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.
|
|
216
216
|
*/
|
|
217
217
|
popup_quick_open(callback: Callable, base_types?: Array<string>): void;
|
|
218
|
-
/** Reloads the scene at the given path. */
|
|
218
|
+
/** Reloads the scene at the given path. Fails if the scene is not open. */
|
|
219
219
|
reload_scene_from_path(scene_filepath: string | NodePath): void;
|
|
220
220
|
/**
|
|
221
221
|
* Restarts the editor. This closes the editor and then opens the same project. If `save` is `true`, the project will be saved before restarting.
|
|
@@ -236,7 +236,7 @@ declare interface EditorInterface extends GodotObject {
|
|
|
236
236
|
*/
|
|
237
237
|
set_current_feature_profile(profile_name: string | NodePath): void;
|
|
238
238
|
/**
|
|
239
|
-
* 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 `
|
|
239
|
+
* 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).
|
|
240
240
|
*/
|
|
241
241
|
set_main_screen_editor(name: string | NodePath): void;
|
|
242
242
|
/**
|
|
@@ -8,6 +8,10 @@ declare class EditorNode3DGizmoPlugin extends Resource {
|
|
|
8
8
|
* Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns `true` if not overridden.
|
|
9
9
|
*/
|
|
10
10
|
_can_be_hidden(): boolean;
|
|
11
|
+
/**
|
|
12
|
+
* 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.
|
|
13
|
+
*/
|
|
14
|
+
_can_commit_handle_on_click(): boolean;
|
|
11
15
|
/**
|
|
12
16
|
* 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".
|
|
13
17
|
* If the `cancel` argument is `true`, the `restore` value should be directly set, without any {@link UndoRedo} action.
|