@ringozz/godot 0.1.0
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/gen/classes/AESContext.ts +99 -0
- package/gen/classes/AStar2D.ts +222 -0
- package/gen/classes/AStar3D.ts +247 -0
- package/gen/classes/AStarGrid2D.ts +284 -0
- package/gen/classes/AcceptDialog.ts +104 -0
- package/gen/classes/AccessibilityServer.ts +824 -0
- package/gen/classes/AimModifier3D.ts +75 -0
- package/gen/classes/AnimatableBody2D.ts +21 -0
- package/gen/classes/AnimatableBody3D.ts +21 -0
- package/gen/classes/AnimatedSprite2D.ts +160 -0
- package/gen/classes/AnimatedSprite3D.ts +134 -0
- package/gen/classes/AnimatedTexture.ts +74 -0
- package/gen/classes/Animation.ts +596 -0
- package/gen/classes/AnimationLibrary.ts +77 -0
- package/gen/classes/AnimationMixer.ts +450 -0
- package/gen/classes/AnimationNode.ts +159 -0
- package/gen/classes/AnimationNodeAdd2.ts +16 -0
- package/gen/classes/AnimationNodeAdd3.ts +20 -0
- package/gen/classes/AnimationNodeAnimation.ts +84 -0
- package/gen/classes/AnimationNodeBlend2.ts +15 -0
- package/gen/classes/AnimationNodeBlend3.ts +19 -0
- package/gen/classes/AnimationNodeBlendSpace1D.ts +162 -0
- package/gen/classes/AnimationNodeBlendSpace2D.ts +204 -0
- package/gen/classes/AnimationNodeBlendTree.ts +110 -0
- package/gen/classes/AnimationNodeExtension.ts +25 -0
- package/gen/classes/AnimationNodeOneShot.ts +144 -0
- package/gen/classes/AnimationNodeOutput.ts +14 -0
- package/gen/classes/AnimationNodeStateMachine.ts +163 -0
- package/gen/classes/AnimationNodeStateMachinePlayback.ts +111 -0
- package/gen/classes/AnimationNodeStateMachineTransition.ts +120 -0
- package/gen/classes/AnimationNodeSub2.ts +17 -0
- package/gen/classes/AnimationNodeSync.ts +21 -0
- package/gen/classes/AnimationNodeTimeScale.ts +14 -0
- package/gen/classes/AnimationNodeTimeSeek.ts +36 -0
- package/gen/classes/AnimationNodeTransition.ts +92 -0
- package/gen/classes/AnimationPlayer.ts +319 -0
- package/gen/classes/AnimationRootNode.ts +15 -0
- package/gen/classes/AnimationTree.ts +60 -0
- package/gen/classes/Area2D.ts +252 -0
- package/gen/classes/Area3D.ts +305 -0
- package/gen/classes/AreaLight3D.ts +56 -0
- package/gen/classes/ArrayMesh.ts +177 -0
- package/gen/classes/ArrayOccluder3D.ts +35 -0
- package/gen/classes/AspectRatioContainer.ts +78 -0
- package/gen/classes/AtlasTexture.ts +42 -0
- package/gen/classes/AudioBusLayout.ts +14 -0
- package/gen/classes/AudioEffect.ts +16 -0
- package/gen/classes/AudioEffectAmplify.ts +27 -0
- package/gen/classes/AudioEffectBandLimitFilter.ts +15 -0
- package/gen/classes/AudioEffectBandPassFilter.ts +15 -0
- package/gen/classes/AudioEffectCapture.ts +62 -0
- package/gen/classes/AudioEffectChorus.ts +95 -0
- package/gen/classes/AudioEffectCompressor.ts +62 -0
- package/gen/classes/AudioEffectDelay.ts +93 -0
- package/gen/classes/AudioEffectDistortion.ts +75 -0
- package/gen/classes/AudioEffectEQ.ts +30 -0
- package/gen/classes/AudioEffectEQ10.ts +25 -0
- package/gen/classes/AudioEffectEQ21.ts +36 -0
- package/gen/classes/AudioEffectEQ6.ts +21 -0
- package/gen/classes/AudioEffectFilter.ts +68 -0
- package/gen/classes/AudioEffectHardLimiter.ts +34 -0
- package/gen/classes/AudioEffectHighPassFilter.ts +15 -0
- package/gen/classes/AudioEffectHighShelfFilter.ts +15 -0
- package/gen/classes/AudioEffectInstance.ts +14 -0
- package/gen/classes/AudioEffectLimiter.ts +40 -0
- package/gen/classes/AudioEffectLowPassFilter.ts +15 -0
- package/gen/classes/AudioEffectLowShelfFilter.ts +15 -0
- package/gen/classes/AudioEffectNotchFilter.ts +15 -0
- package/gen/classes/AudioEffectPanner.ts +21 -0
- package/gen/classes/AudioEffectPhaser.ts +45 -0
- package/gen/classes/AudioEffectPitchShift.ts +62 -0
- package/gen/classes/AudioEffectRecord.ts +39 -0
- package/gen/classes/AudioEffectReverb.ts +63 -0
- package/gen/classes/AudioEffectSpectrumAnalyzer.ts +57 -0
- package/gen/classes/AudioEffectSpectrumAnalyzerInstance.ts +35 -0
- package/gen/classes/AudioEffectStereoEnhance.ts +32 -0
- package/gen/classes/AudioListener2D.ts +31 -0
- package/gen/classes/AudioListener3D.ts +61 -0
- package/gen/classes/AudioSample.ts +14 -0
- package/gen/classes/AudioSamplePlayback.ts +14 -0
- package/gen/classes/AudioServer.ts +360 -0
- package/gen/classes/AudioStream.ts +53 -0
- package/gen/classes/AudioStreamGenerator.ts +88 -0
- package/gen/classes/AudioStreamGeneratorPlayback.ts +45 -0
- package/gen/classes/AudioStreamInteractive.ts +216 -0
- package/gen/classes/AudioStreamMP3.ts +74 -0
- package/gen/classes/AudioStreamMicrophone.ts +15 -0
- package/gen/classes/AudioStreamOggVorbis.ts +71 -0
- package/gen/classes/AudioStreamPlayback.ts +63 -0
- package/gen/classes/AudioStreamPlaybackInteractive.ts +37 -0
- package/gen/classes/AudioStreamPlaybackOggVorbis.ts +14 -0
- package/gen/classes/AudioStreamPlaybackPlaylist.ts +13 -0
- package/gen/classes/AudioStreamPlaybackPolyphonic.ts +49 -0
- package/gen/classes/AudioStreamPlaybackResampled.ts +19 -0
- package/gen/classes/AudioStreamPlaybackSynchronized.ts +13 -0
- package/gen/classes/AudioStreamPlayer.ts +146 -0
- package/gen/classes/AudioStreamPlayer2D.ts +143 -0
- package/gen/classes/AudioStreamPlayer3D.ts +233 -0
- package/gen/classes/AudioStreamPlaylist.ts +240 -0
- package/gen/classes/AudioStreamPolyphonic.ts +21 -0
- package/gen/classes/AudioStreamRandomizer.ts +99 -0
- package/gen/classes/AudioStreamSynchronized.ts +45 -0
- package/gen/classes/AudioStreamWAV.ts +151 -0
- package/gen/classes/AwaitTweener.ts +20 -0
- package/gen/classes/BackBufferCopy.ts +46 -0
- package/gen/classes/BaseButton.ts +164 -0
- package/gen/classes/BaseMaterial3D.ts +1477 -0
- package/gen/classes/BitMap.ts +94 -0
- package/gen/classes/BlitMaterial.ts +46 -0
- package/gen/classes/Bone2D.ts +71 -0
- package/gen/classes/BoneAttachment3D.ts +57 -0
- package/gen/classes/BoneConstraint3D.ts +122 -0
- package/gen/classes/BoneMap.ts +53 -0
- package/gen/classes/BoneTwistDisperser3D.ts +209 -0
- package/gen/classes/BoxContainer.ts +51 -0
- package/gen/classes/BoxMesh.ts +41 -0
- package/gen/classes/BoxOccluder3D.ts +22 -0
- package/gen/classes/BoxShape3D.ts +22 -0
- package/gen/classes/Button.ts +117 -0
- package/gen/classes/ButtonGroup.ts +39 -0
- package/gen/classes/CCDIK3D.ts +16 -0
- package/gen/classes/CPUParticles2D.ts +590 -0
- package/gen/classes/CPUParticles3D.ts +650 -0
- package/gen/classes/CSGBox3D.ts +29 -0
- package/gen/classes/CSGCombiner3D.ts +15 -0
- package/gen/classes/CSGCylinder3D.ts +52 -0
- package/gen/classes/CSGMesh3D.ts +32 -0
- package/gen/classes/CSGPolygon3D.ts +170 -0
- package/gen/classes/CSGPrimitive3D.ts +20 -0
- package/gen/classes/CSGShape3D.ts +140 -0
- package/gen/classes/CSGSphere3D.ts +46 -0
- package/gen/classes/CSGTorus3D.ts +52 -0
- package/gen/classes/CallbackTweener.ts +29 -0
- package/gen/classes/Camera2D.ts +266 -0
- package/gen/classes/Camera3D.ts +275 -0
- package/gen/classes/CameraAttributes.ts +50 -0
- package/gen/classes/CameraAttributesPhysical.ts +73 -0
- package/gen/classes/CameraAttributesPractical.ts +75 -0
- package/gen/classes/CameraFeed.ts +155 -0
- package/gen/classes/CameraServer.ts +105 -0
- package/gen/classes/CameraTexture.ts +34 -0
- package/gen/classes/CanvasGroup.ts +54 -0
- package/gen/classes/CanvasItem.ts +698 -0
- package/gen/classes/CanvasItemMaterial.ts +97 -0
- package/gen/classes/CanvasLayer.ts +103 -0
- package/gen/classes/CanvasModulate.ts +21 -0
- package/gen/classes/CanvasTexture.ts +60 -0
- package/gen/classes/CapsuleMesh.ts +40 -0
- package/gen/classes/CapsuleShape2D.ts +35 -0
- package/gen/classes/CapsuleShape3D.ts +35 -0
- package/gen/classes/CenterContainer.ts +20 -0
- package/gen/classes/ChainIK3D.ts +102 -0
- package/gen/classes/CharFXTransform.ts +108 -0
- package/gen/classes/CharacterBody2D.ts +252 -0
- package/gen/classes/CharacterBody3D.ts +246 -0
- package/gen/classes/CheckBox.ts +16 -0
- package/gen/classes/CheckButton.ts +15 -0
- package/gen/classes/CircleShape2D.ts +21 -0
- package/gen/classes/ClassDB.ts +197 -0
- package/gen/classes/CodeEdit.ts +619 -0
- package/gen/classes/CodeHighlighter.ts +132 -0
- package/gen/classes/CollisionObject2D.ts +235 -0
- package/gen/classes/CollisionObject3D.ts +199 -0
- package/gen/classes/CollisionPolygon2D.ts +70 -0
- package/gen/classes/CollisionPolygon3D.ts +54 -0
- package/gen/classes/CollisionShape2D.ts +55 -0
- package/gen/classes/CollisionShape3D.ts +53 -0
- package/gen/classes/ColorPalette.ts +21 -0
- package/gen/classes/ColorPicker.ts +197 -0
- package/gen/classes/ColorPickerButton.ts +68 -0
- package/gen/classes/ColorRect.ts +21 -0
- package/gen/classes/Compositor.ts +22 -0
- package/gen/classes/CompositorEffect.ts +134 -0
- package/gen/classes/CompressedCubemap.ts +22 -0
- package/gen/classes/CompressedCubemapArray.ts +22 -0
- package/gen/classes/CompressedTexture2D.ts +27 -0
- package/gen/classes/CompressedTexture2DArray.ts +22 -0
- package/gen/classes/CompressedTexture3D.ts +22 -0
- package/gen/classes/CompressedTextureLayered.ts +19 -0
- package/gen/classes/ConcavePolygonShape2D.ts +25 -0
- package/gen/classes/ConcavePolygonShape3D.ts +28 -0
- package/gen/classes/ConeTwistJoint3D.ts +84 -0
- package/gen/classes/ConfigFile.ts +170 -0
- package/gen/classes/ConfirmationDialog.ts +39 -0
- package/gen/classes/Container.ts +54 -0
- package/gen/classes/Control.ts +1499 -0
- package/gen/classes/ConvertTransformModifier3D.ts +153 -0
- package/gen/classes/ConvexPolygonShape2D.ts +30 -0
- package/gen/classes/ConvexPolygonShape3D.ts +24 -0
- package/gen/classes/CopyTransformModifier3D.ts +220 -0
- package/gen/classes/Crypto.ts +114 -0
- package/gen/classes/CryptoKey.ts +43 -0
- package/gen/classes/Cubemap.ts +47 -0
- package/gen/classes/CubemapArray.ts +30 -0
- package/gen/classes/Curve.ts +183 -0
- package/gen/classes/Curve2D.ts +145 -0
- package/gen/classes/Curve3D.ts +173 -0
- package/gen/classes/CurveTexture.ts +48 -0
- package/gen/classes/CurveXYZTexture.ts +40 -0
- package/gen/classes/CylinderMesh.ts +58 -0
- package/gen/classes/CylinderShape3D.ts +28 -0
- package/gen/classes/DPITexture.ts +73 -0
- package/gen/classes/DTLSServer.ts +93 -0
- package/gen/classes/DampedSpringJoint2D.ts +38 -0
- package/gen/classes/Decal.ts +146 -0
- package/gen/classes/DirAccess.ts +300 -0
- package/gen/classes/DirectionalLight2D.ts +28 -0
- package/gen/classes/DirectionalLight3D.ts +104 -0
- package/gen/classes/DisplayServer.ts +3119 -0
- package/gen/classes/DrawableTexture2D.ts +75 -0
- package/gen/classes/ENetConnection.ts +192 -0
- package/gen/classes/ENetMultiplayerPeer.ts +54 -0
- package/gen/classes/ENetPacketPeer.ts +234 -0
- package/gen/classes/EncodedObjectAsID.ts +21 -0
- package/gen/classes/Engine.ts +322 -0
- package/gen/classes/EngineDebugger.ts +136 -0
- package/gen/classes/EngineProfiler.ts +16 -0
- package/gen/classes/Environment.ts +786 -0
- package/gen/classes/Expression.ts +60 -0
- package/gen/classes/ExternalTexture.ts +35 -0
- package/gen/classes/FABRIK3D.ts +16 -0
- package/gen/classes/FBXDocument.ts +15 -0
- package/gen/classes/FBXState.ts +20 -0
- package/gen/classes/FastNoiseLite.ts +284 -0
- package/gen/classes/FileAccess.ts +596 -0
- package/gen/classes/FileDialog.ts +428 -0
- package/gen/classes/FlowContainer.ts +84 -0
- package/gen/classes/FogMaterial.ts +54 -0
- package/gen/classes/FogVolume.ts +39 -0
- package/gen/classes/FoldableContainer.ts +110 -0
- package/gen/classes/FoldableGroup.ts +38 -0
- package/gen/classes/Font.ts +242 -0
- package/gen/classes/FontFile.ts +514 -0
- package/gen/classes/FontVariation.ts +123 -0
- package/gen/classes/FramebufferCacheRD.ts +21 -0
- package/gen/classes/GDExtension.ts +47 -0
- package/gen/classes/GDExtensionManager.ts +101 -0
- package/gen/classes/GDScript.ts +30 -0
- package/gen/classes/GLTFAccessor.ts +203 -0
- package/gen/classes/GLTFAnimation.ts +33 -0
- package/gen/classes/GLTFBufferView.ts +68 -0
- package/gen/classes/GLTFCamera.ts +66 -0
- package/gen/classes/GLTFDocument.ts +202 -0
- package/gen/classes/GLTFDocumentExtension.ts +26 -0
- package/gen/classes/GLTFDocumentExtensionConvertImporterMesh.ts +11 -0
- package/gen/classes/GLTFLight.ts +80 -0
- package/gen/classes/GLTFMesh.ts +53 -0
- package/gen/classes/GLTFNode.ts +125 -0
- package/gen/classes/GLTFObjectModelProperty.ts +136 -0
- package/gen/classes/GLTFPhysicsBody.ts +89 -0
- package/gen/classes/GLTFPhysicsShape.ts +92 -0
- package/gen/classes/GLTFSkeleton.ts +32 -0
- package/gen/classes/GLTFSkin.ts +44 -0
- package/gen/classes/GLTFSpecGloss.ts +46 -0
- package/gen/classes/GLTFState.ts +250 -0
- package/gen/classes/GLTFTexture.ts +23 -0
- package/gen/classes/GLTFTextureSampler.ts +38 -0
- package/gen/classes/GPUParticles2D.ts +270 -0
- package/gen/classes/GPUParticles3D.ts +339 -0
- package/gen/classes/GPUParticlesAttractor3D.ts +43 -0
- package/gen/classes/GPUParticlesAttractorBox3D.ts +23 -0
- package/gen/classes/GPUParticlesAttractorSphere3D.ts +23 -0
- package/gen/classes/GPUParticlesAttractorVectorField3D.ts +32 -0
- package/gen/classes/GPUParticlesCollision3D.ts +26 -0
- package/gen/classes/GPUParticlesCollisionBox3D.ts +24 -0
- package/gen/classes/GPUParticlesCollisionHeightField3D.ts +109 -0
- package/gen/classes/GPUParticlesCollisionSDF3D.ts +95 -0
- package/gen/classes/GPUParticlesCollisionSphere3D.ts +23 -0
- package/gen/classes/Generic6DOFJoint3D.ts +146 -0
- package/gen/classes/Geometry2D.ts +249 -0
- package/gen/classes/Geometry3D.ts +94 -0
- package/gen/classes/GeometryInstance3D.ts +223 -0
- package/gen/classes/GodotInstance.ts +48 -0
- package/gen/classes/Gradient.ts +125 -0
- package/gen/classes/GradientTexture1D.ts +33 -0
- package/gen/classes/GradientTexture2D.ts +104 -0
- package/gen/classes/GraphEdit.ts +535 -0
- package/gen/classes/GraphElement.ts +101 -0
- package/gen/classes/GraphFrame.ts +66 -0
- package/gen/classes/GraphNode.ts +241 -0
- package/gen/classes/GridContainer.ts +21 -0
- package/gen/classes/GridMap.ts +294 -0
- package/gen/classes/GrooveJoint2D.ts +26 -0
- package/gen/classes/HBoxContainer.ts +14 -0
- package/gen/classes/HFlowContainer.ts +14 -0
- package/gen/classes/HMACContext.ts +54 -0
- package/gen/classes/HScrollBar.ts +14 -0
- package/gen/classes/HSeparator.ts +14 -0
- package/gen/classes/HSlider.ts +14 -0
- package/gen/classes/HSplitContainer.ts +14 -0
- package/gen/classes/HTTPClient.ts +525 -0
- package/gen/classes/HTTPRequest.ts +264 -0
- package/gen/classes/HashingContext.ts +75 -0
- package/gen/classes/HeightMapShape3D.ts +73 -0
- package/gen/classes/HingeJoint3D.ts +90 -0
- package/gen/classes/IKModifier3D.ts +40 -0
- package/gen/classes/IP.ts +132 -0
- package/gen/classes/Image.ts +835 -0
- package/gen/classes/ImageFormatLoader.ts +31 -0
- package/gen/classes/ImageFormatLoaderExtension.ts +30 -0
- package/gen/classes/ImageTexture.ts +73 -0
- package/gen/classes/ImageTexture3D.ts +29 -0
- package/gen/classes/ImageTextureLayered.ts +66 -0
- package/gen/classes/ImmediateMesh.ts +85 -0
- package/gen/classes/ImporterMesh.ts +159 -0
- package/gen/classes/ImporterMeshInstance3D.ts +45 -0
- package/gen/classes/Input.ts +743 -0
- package/gen/classes/InputEvent.ts +112 -0
- package/gen/classes/InputEventAction.ts +40 -0
- package/gen/classes/InputEventFromWindow.ts +19 -0
- package/gen/classes/InputEventGesture.ts +20 -0
- package/gen/classes/InputEventJoypadButton.ts +30 -0
- package/gen/classes/InputEventJoypadMotion.ts +27 -0
- package/gen/classes/InputEventKey.ts +133 -0
- package/gen/classes/InputEventMIDI.ts +108 -0
- package/gen/classes/InputEventMagnifyGesture.ts +21 -0
- package/gen/classes/InputEventMouse.ts +35 -0
- package/gen/classes/InputEventMouseButton.ts +46 -0
- package/gen/classes/InputEventMouseMotion.ts +67 -0
- package/gen/classes/InputEventPanGesture.ts +22 -0
- package/gen/classes/InputEventScreenDrag.ts +71 -0
- package/gen/classes/InputEventScreenTouch.ts +45 -0
- package/gen/classes/InputEventShortcut.ts +21 -0
- package/gen/classes/InputEventWithModifiers.ts +56 -0
- package/gen/classes/InputMap.ts +97 -0
- package/gen/classes/InstancePlaceholder.ts +33 -0
- package/gen/classes/IntervalTweener.ts +15 -0
- package/gen/classes/ItemList.ts +482 -0
- package/gen/classes/IterateIK3D.ts +136 -0
- package/gen/classes/JNISingleton.ts +20 -0
- package/gen/classes/JSON.ts +163 -0
- package/gen/classes/JSONRPC.ts +87 -0
- package/gen/classes/JacobianIK3D.ts +16 -0
- package/gen/classes/JavaClass.ts +37 -0
- package/gen/classes/JavaClassWrapper.ts +94 -0
- package/gen/classes/JavaObject.ts +28 -0
- package/gen/classes/JavaScriptBridge.ts +85 -0
- package/gen/classes/JavaScriptObject.ts +45 -0
- package/gen/classes/Joint2D.ts +44 -0
- package/gen/classes/Joint3D.ts +46 -0
- package/gen/classes/JointLimitation3D.ts +14 -0
- package/gen/classes/JointLimitationCone3D.ts +21 -0
- package/gen/classes/KinematicCollision2D.ts +83 -0
- package/gen/classes/KinematicCollision3D.ts +88 -0
- package/gen/classes/Label.ts +184 -0
- package/gen/classes/Label3D.ts +280 -0
- package/gen/classes/LabelSettings.ts +168 -0
- package/gen/classes/Light2D.ts +150 -0
- package/gen/classes/Light3D.ts +310 -0
- package/gen/classes/LightOccluder2D.ts +33 -0
- package/gen/classes/LightmapGI.ts +291 -0
- package/gen/classes/LightmapGIData.ts +85 -0
- package/gen/classes/LightmapProbe.ts +16 -0
- package/gen/classes/Lightmapper.ts +14 -0
- package/gen/classes/LightmapperRD.ts +15 -0
- package/gen/classes/LimitAngularVelocityModifier3D.ts +91 -0
- package/gen/classes/Line2D.ts +191 -0
- package/gen/classes/LineEdit.ts +663 -0
- package/gen/classes/LinkButton.ts +99 -0
- package/gen/classes/Logger.ts +38 -0
- package/gen/classes/LookAtModifier3D.ts +245 -0
- package/gen/classes/MainLoop.ts +115 -0
- package/gen/classes/MarginContainer.ts +27 -0
- package/gen/classes/Marker2D.ts +20 -0
- package/gen/classes/Marker3D.ts +20 -0
- package/gen/classes/Marshalls.ts +50 -0
- package/gen/classes/Material.ts +53 -0
- package/gen/classes/MenuBar.ts +114 -0
- package/gen/classes/MenuButton.ts +51 -0
- package/gen/classes/Mesh.ts +348 -0
- package/gen/classes/MeshConvexDecompositionSettings.ts +106 -0
- package/gen/classes/MeshDataTool.ts +251 -0
- package/gen/classes/MeshInstance2D.ts +37 -0
- package/gen/classes/MeshInstance3D.ts +122 -0
- package/gen/classes/MeshLibrary.ts +149 -0
- package/gen/classes/MeshTexture.ts +34 -0
- package/gen/classes/MethodTweener.ts +32 -0
- package/gen/classes/MissingNode.ts +39 -0
- package/gen/classes/MissingResource.ts +27 -0
- package/gen/classes/MobileVRInterface.ts +89 -0
- package/gen/classes/ModifierBoneTarget3D.ts +27 -0
- package/gen/classes/MovieWriter.ts +34 -0
- package/gen/classes/MultiMesh.ts +197 -0
- package/gen/classes/MultiMeshInstance2D.ts +36 -0
- package/gen/classes/MultiMeshInstance3D.ts +22 -0
- package/gen/classes/MultiplayerAPI.ts +139 -0
- package/gen/classes/MultiplayerAPIExtension.ts +99 -0
- package/gen/classes/MultiplayerPeer.ts +148 -0
- package/gen/classes/MultiplayerPeerExtension.ts +17 -0
- package/gen/classes/MultiplayerSpawner.ts +75 -0
- package/gen/classes/MultiplayerSynchronizer.ts +119 -0
- package/gen/classes/Mutex.ts +37 -0
- package/gen/classes/NativeMenu.ts +567 -0
- package/gen/classes/NavigationAgent2D.ts +361 -0
- package/gen/classes/NavigationAgent3D.ts +380 -0
- package/gen/classes/NavigationLink2D.ts +107 -0
- package/gen/classes/NavigationLink3D.ts +107 -0
- package/gen/classes/NavigationMesh.ts +283 -0
- package/gen/classes/NavigationMeshGenerator.ts +46 -0
- package/gen/classes/NavigationMeshSourceGeometryData2D.ts +75 -0
- package/gen/classes/NavigationMeshSourceGeometryData3D.ts +76 -0
- package/gen/classes/NavigationObstacle2D.ts +87 -0
- package/gen/classes/NavigationObstacle3D.ts +100 -0
- package/gen/classes/NavigationPathQueryParameters2D.ts +162 -0
- package/gen/classes/NavigationPathQueryParameters3D.ts +162 -0
- package/gen/classes/NavigationPathQueryResult2D.ts +64 -0
- package/gen/classes/NavigationPathQueryResult3D.ts +64 -0
- package/gen/classes/NavigationPolygon.ts +259 -0
- package/gen/classes/NavigationRegion2D.ts +116 -0
- package/gen/classes/NavigationRegion3D.ts +116 -0
- package/gen/classes/NavigationServer2D.ts +799 -0
- package/gen/classes/NavigationServer2DManager.ts +28 -0
- package/gen/classes/NavigationServer3D.ts +888 -0
- package/gen/classes/NavigationServer3DManager.ts +28 -0
- package/gen/classes/NinePatchRect.ts +95 -0
- package/gen/classes/Node.ts +1336 -0
- package/gen/classes/Node2D.ts +150 -0
- package/gen/classes/Node3D.ts +404 -0
- package/gen/classes/Node3DGizmo.ts +14 -0
- package/gen/classes/Noise.ts +67 -0
- package/gen/classes/NoiseTexture2D.ts +104 -0
- package/gen/classes/NoiseTexture3D.ts +84 -0
- package/gen/classes/ORMMaterial3D.ts +14 -0
- package/gen/classes/OS.ts +848 -0
- package/gen/classes/Object.ts +583 -0
- package/gen/classes/Occluder3D.ts +25 -0
- package/gen/classes/OccluderInstance3D.ts +54 -0
- package/gen/classes/OccluderPolygon2D.ts +51 -0
- package/gen/classes/OfflineMultiplayerPeer.ts +15 -0
- package/gen/classes/OggPacketSequence.ts +38 -0
- package/gen/classes/OggPacketSequencePlayback.ts +11 -0
- package/gen/classes/OmniLight3D.ts +49 -0
- package/gen/classes/OpenXRAPIExtension.ts +303 -0
- package/gen/classes/OpenXRAction.ts +55 -0
- package/gen/classes/OpenXRActionBindingModifier.ts +14 -0
- package/gen/classes/OpenXRActionMap.ts +86 -0
- package/gen/classes/OpenXRActionSet.ts +50 -0
- package/gen/classes/OpenXRAnalogThresholdModifier.ts +40 -0
- package/gen/classes/OpenXRAnchorTracker.ts +32 -0
- package/gen/classes/OpenXRAndroidThreadSettingsExtension.ts +43 -0
- package/gen/classes/OpenXRBindingModifier.ts +14 -0
- package/gen/classes/OpenXRCompositionLayer.ts +275 -0
- package/gen/classes/OpenXRCompositionLayerCylinder.ts +38 -0
- package/gen/classes/OpenXRCompositionLayerEquirect.ts +44 -0
- package/gen/classes/OpenXRCompositionLayerQuad.ts +21 -0
- package/gen/classes/OpenXRDpadBindingModifier.ts +73 -0
- package/gen/classes/OpenXRExtensionWrapper.ts +33 -0
- package/gen/classes/OpenXRExtensionWrapperExtension.ts +14 -0
- package/gen/classes/OpenXRFrameSynthesisExtension.ts +36 -0
- package/gen/classes/OpenXRFutureExtension.ts +43 -0
- package/gen/classes/OpenXRFutureResult.ts +64 -0
- package/gen/classes/OpenXRHand.ts +117 -0
- package/gen/classes/OpenXRHapticBase.ts +13 -0
- package/gen/classes/OpenXRHapticVibration.ts +32 -0
- package/gen/classes/OpenXRIPBinding.ts +72 -0
- package/gen/classes/OpenXRIPBindingModifier.ts +14 -0
- package/gen/classes/OpenXRInteractionProfile.ts +56 -0
- package/gen/classes/OpenXRInteractionProfileMetadata.ts +43 -0
- package/gen/classes/OpenXRInterface.ts +550 -0
- package/gen/classes/OpenXRMarkerTracker.ts +46 -0
- package/gen/classes/OpenXRPlaneTracker.ts +68 -0
- package/gen/classes/OpenXRRenderModel.ts +33 -0
- package/gen/classes/OpenXRRenderModelExtension.ts +105 -0
- package/gen/classes/OpenXRRenderModelManager.ts +63 -0
- package/gen/classes/OpenXRSpatialAnchorCapability.ts +114 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationAnchor.ts +21 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationAprilTag.ts +50 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationAruco.ts +98 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationBaseHeader.ts +25 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationMicroQrCode.ts +21 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationPlaneTracking.ts +36 -0
- package/gen/classes/OpenXRSpatialCapabilityConfigurationQrCode.ts +21 -0
- package/gen/classes/OpenXRSpatialComponentAnchorList.ts +20 -0
- package/gen/classes/OpenXRSpatialComponentBounded2DList.ts +25 -0
- package/gen/classes/OpenXRSpatialComponentBounded3DList.ts +25 -0
- package/gen/classes/OpenXRSpatialComponentData.ts +24 -0
- package/gen/classes/OpenXRSpatialComponentMarkerList.ts +60 -0
- package/gen/classes/OpenXRSpatialComponentMesh2DList.ts +31 -0
- package/gen/classes/OpenXRSpatialComponentMesh3DList.ts +26 -0
- package/gen/classes/OpenXRSpatialComponentParentList.ts +20 -0
- package/gen/classes/OpenXRSpatialComponentPersistenceList.ts +24 -0
- package/gen/classes/OpenXRSpatialComponentPlaneAlignmentList.ts +41 -0
- package/gen/classes/OpenXRSpatialComponentPlaneSemanticLabelList.ts +45 -0
- package/gen/classes/OpenXRSpatialComponentPolygon2DList.ts +26 -0
- package/gen/classes/OpenXRSpatialContextPersistenceConfig.ts +30 -0
- package/gen/classes/OpenXRSpatialEntityExtension.ts +241 -0
- package/gen/classes/OpenXRSpatialEntityTracker.ts +82 -0
- package/gen/classes/OpenXRSpatialMarkerTrackingCapability.ts +56 -0
- package/gen/classes/OpenXRSpatialPlaneTrackingCapability.ts +33 -0
- package/gen/classes/OpenXRSpatialQueryResultData.ts +30 -0
- package/gen/classes/OpenXRStructureBase.ts +25 -0
- package/gen/classes/OpenXRVisibilityMask.ts +15 -0
- package/gen/classes/OptimizedTranslation.ts +22 -0
- package/gen/classes/OptionButton.ts +236 -0
- package/gen/classes/PCKPacker.ts +57 -0
- package/gen/classes/PackedDataContainer.ts +58 -0
- package/gen/classes/PackedDataContainerRef.ts +47 -0
- package/gen/classes/PackedScene.ts +104 -0
- package/gen/classes/PacketPeer.ts +56 -0
- package/gen/classes/PacketPeerDTLS.ts +65 -0
- package/gen/classes/PacketPeerExtension.ts +12 -0
- package/gen/classes/PacketPeerStream.ts +28 -0
- package/gen/classes/PacketPeerUDP.ts +139 -0
- package/gen/classes/Panel.ts +14 -0
- package/gen/classes/PanelContainer.ts +14 -0
- package/gen/classes/PanoramaSkyMaterial.ts +35 -0
- package/gen/classes/Parallax2D.ts +78 -0
- package/gen/classes/ParallaxBackground.ts +52 -0
- package/gen/classes/ParallaxLayer.ts +38 -0
- package/gen/classes/ParticleProcessMaterial.ts +949 -0
- package/gen/classes/Path2D.ts +22 -0
- package/gen/classes/Path3D.ts +42 -0
- package/gen/classes/PathFollow2D.ts +60 -0
- package/gen/classes/PathFollow3D.ts +104 -0
- package/gen/classes/Performance.ts +370 -0
- package/gen/classes/PhysicalBone2D.ts +59 -0
- package/gen/classes/PhysicalBone3D.ts +189 -0
- package/gen/classes/PhysicalBoneSimulator3D.ts +43 -0
- package/gen/classes/PhysicalSkyMaterial.ts +83 -0
- package/gen/classes/PhysicsBody2D.ts +55 -0
- package/gen/classes/PhysicsBody3D.ts +94 -0
- package/gen/classes/PhysicsDirectBodyState2D.ts +249 -0
- package/gen/classes/PhysicsDirectBodyState2DExtension.ts +19 -0
- package/gen/classes/PhysicsDirectBodyState3D.ts +256 -0
- package/gen/classes/PhysicsDirectBodyState3DExtension.ts +19 -0
- package/gen/classes/PhysicsDirectSpaceState2D.ts +77 -0
- package/gen/classes/PhysicsDirectSpaceState2DExtension.ts +19 -0
- package/gen/classes/PhysicsDirectSpaceState3D.ts +81 -0
- package/gen/classes/PhysicsDirectSpaceState3DExtension.ts +19 -0
- package/gen/classes/PhysicsMaterial.ts +39 -0
- package/gen/classes/PhysicsPointQueryParameters2D.ts +54 -0
- package/gen/classes/PhysicsPointQueryParameters3D.ts +47 -0
- package/gen/classes/PhysicsRayQueryParameters2D.ts +71 -0
- package/gen/classes/PhysicsRayQueryParameters3D.ts +77 -0
- package/gen/classes/PhysicsServer2D.ts +1078 -0
- package/gen/classes/PhysicsServer2DExtension.ts +33 -0
- package/gen/classes/PhysicsServer2DManager.ts +28 -0
- package/gen/classes/PhysicsServer3D.ts +1620 -0
- package/gen/classes/PhysicsServer3DExtension.ts +26 -0
- package/gen/classes/PhysicsServer3DManager.ts +28 -0
- package/gen/classes/PhysicsServer3DRenderingServerHandler.ts +27 -0
- package/gen/classes/PhysicsShapeQueryParameters2D.ts +89 -0
- package/gen/classes/PhysicsShapeQueryParameters3D.ts +89 -0
- package/gen/classes/PhysicsTestMotionParameters2D.ts +60 -0
- package/gen/classes/PhysicsTestMotionParameters3D.ts +66 -0
- package/gen/classes/PhysicsTestMotionResult2D.ts +82 -0
- package/gen/classes/PhysicsTestMotionResult3D.ts +87 -0
- package/gen/classes/PinJoint2D.ts +50 -0
- package/gen/classes/PinJoint3D.ts +42 -0
- package/gen/classes/PlaceholderCubemap.ts +17 -0
- package/gen/classes/PlaceholderCubemapArray.ts +17 -0
- package/gen/classes/PlaceholderMaterial.ts +16 -0
- package/gen/classes/PlaceholderMesh.ts +23 -0
- package/gen/classes/PlaceholderTexture2D.ts +24 -0
- package/gen/classes/PlaceholderTexture2DArray.ts +17 -0
- package/gen/classes/PlaceholderTexture3D.ts +24 -0
- package/gen/classes/PlaceholderTextureLayered.ts +29 -0
- package/gen/classes/PlaneMesh.ts +64 -0
- package/gen/classes/PointLight2D.ts +40 -0
- package/gen/classes/PointMesh.ts +16 -0
- package/gen/classes/Polygon2D.ts +150 -0
- package/gen/classes/PolygonOccluder3D.ts +23 -0
- package/gen/classes/PolygonPathFinder.ts +61 -0
- package/gen/classes/Popup.ts +22 -0
- package/gen/classes/PopupMenu.ts +567 -0
- package/gen/classes/PopupPanel.ts +14 -0
- package/gen/classes/PortableCompressedTexture2D.ts +74 -0
- package/gen/classes/PrimitiveMesh.ts +69 -0
- package/gen/classes/PrismMesh.ts +45 -0
- package/gen/classes/ProceduralSkyMaterial.ts +102 -0
- package/gen/classes/ProgressBar.ts +60 -0
- package/gen/classes/ProjectSettings.ts +233 -0
- package/gen/classes/PropertyTweener.ts +94 -0
- package/gen/classes/QuadMesh.ts +14 -0
- package/gen/classes/QuadOccluder3D.ts +22 -0
- package/gen/classes/RDAccelerationStructureGeometry.ts +71 -0
- package/gen/classes/RDAccelerationStructureInstance.ts +53 -0
- package/gen/classes/RDAttachmentFormat.ts +33 -0
- package/gen/classes/RDFramebufferPass.ts +52 -0
- package/gen/classes/RDHitGroup.ts +35 -0
- package/gen/classes/RDPipelineColorBlendState.ts +42 -0
- package/gen/classes/RDPipelineColorBlendStateAttachment.ts +161 -0
- package/gen/classes/RDPipelineDepthStencilState.ts +141 -0
- package/gen/classes/RDPipelineMultisampleState.ts +52 -0
- package/gen/classes/RDPipelineRasterizationState.ts +81 -0
- package/gen/classes/RDPipelineShader.ts +29 -0
- package/gen/classes/RDPipelineSpecializationConstant.ts +28 -0
- package/gen/classes/RDSamplerState.ts +106 -0
- package/gen/classes/RDShaderFile.ts +38 -0
- package/gen/classes/RDShaderSPIRV.ts +136 -0
- package/gen/classes/RDShaderSource.ts +82 -0
- package/gen/classes/RDTextureFormat.ts +93 -0
- package/gen/classes/RDTextureView.ts +45 -0
- package/gen/classes/RDUniform.ts +43 -0
- package/gen/classes/RDVertexAttribute.ts +52 -0
- package/gen/classes/RandomNumberGenerator.ts +114 -0
- package/gen/classes/Range.ts +104 -0
- package/gen/classes/RayCast2D.ts +148 -0
- package/gen/classes/RayCast3D.ts +172 -0
- package/gen/classes/RectangleShape2D.ts +22 -0
- package/gen/classes/RefCounted.ts +41 -0
- package/gen/classes/ReferenceRect.ts +33 -0
- package/gen/classes/ReflectionProbe.ts +145 -0
- package/gen/classes/RegEx.ts +129 -0
- package/gen/classes/RegExMatch.ts +53 -0
- package/gen/classes/RemoteTransform2D.ts +51 -0
- package/gen/classes/RemoteTransform3D.ts +51 -0
- package/gen/classes/RenderData.ts +37 -0
- package/gen/classes/RenderDataExtension.ts +17 -0
- package/gen/classes/RenderDataRD.ts +15 -0
- package/gen/classes/RenderSceneBuffers.ts +20 -0
- package/gen/classes/RenderSceneBuffersConfiguration.ts +78 -0
- package/gen/classes/RenderSceneBuffersExtension.ts +15 -0
- package/gen/classes/RenderSceneBuffersRD.ts +163 -0
- package/gen/classes/RenderSceneData.ts +49 -0
- package/gen/classes/RenderSceneDataExtension.ts +16 -0
- package/gen/classes/RenderSceneDataRD.ts +15 -0
- package/gen/classes/RenderingDevice.ts +3416 -0
- package/gen/classes/RenderingServer.ts +5580 -0
- package/gen/classes/Resource.ts +171 -0
- package/gen/classes/ResourceFormatLoader.ts +44 -0
- package/gen/classes/ResourceFormatSaver.ts +18 -0
- package/gen/classes/ResourceImporter.ts +28 -0
- package/gen/classes/ResourceLoader.ts +178 -0
- package/gen/classes/ResourcePreloader.ts +50 -0
- package/gen/classes/ResourceSaver.ts +94 -0
- package/gen/classes/ResourceUID.ts +73 -0
- package/gen/classes/RetargetModifier3D.ts +91 -0
- package/gen/classes/RibbonTrailMesh.ts +66 -0
- package/gen/classes/RichTextEffect.ts +27 -0
- package/gen/classes/RichTextLabel.ts +860 -0
- package/gen/classes/RigidBody2D.ts +359 -0
- package/gen/classes/RigidBody3D.ts +347 -0
- package/gen/classes/RootMotionView.ts +47 -0
- package/gen/classes/SceneMultiplayer.ts +122 -0
- package/gen/classes/SceneReplicationConfig.ts +96 -0
- package/gen/classes/SceneState.ts +160 -0
- package/gen/classes/SceneTree.ts +371 -0
- package/gen/classes/SceneTreeTimer.ts +42 -0
- package/gen/classes/Script.ts +122 -0
- package/gen/classes/ScriptBacktrace.ts +103 -0
- package/gen/classes/ScriptExtension.ts +15 -0
- package/gen/classes/ScriptLanguage.ts +21 -0
- package/gen/classes/ScriptLanguageExtension.ts +72 -0
- package/gen/classes/ScrollBar.ts +26 -0
- package/gen/classes/ScrollContainer.ts +199 -0
- package/gen/classes/SegmentShape2D.ts +27 -0
- package/gen/classes/Semaphore.ts +33 -0
- package/gen/classes/SeparationRayShape2D.ts +27 -0
- package/gen/classes/SeparationRayShape3D.ts +27 -0
- package/gen/classes/Separator.ts +13 -0
- package/gen/classes/Shader.ts +83 -0
- package/gen/classes/ShaderGlobalsOverride.ts +16 -0
- package/gen/classes/ShaderInclude.ts +20 -0
- package/gen/classes/ShaderIncludeDB.ts +30 -0
- package/gen/classes/ShaderMaterial.ts +36 -0
- package/gen/classes/Shape2D.ts +61 -0
- package/gen/classes/Shape3D.ts +35 -0
- package/gen/classes/ShapeCast2D.ts +168 -0
- package/gen/classes/ShapeCast3D.ts +181 -0
- package/gen/classes/Shortcut.ts +60 -0
- package/gen/classes/Skeleton2D.ts +67 -0
- package/gen/classes/Skeleton3D.ts +359 -0
- package/gen/classes/SkeletonIK3D.ts +119 -0
- package/gen/classes/SkeletonModification2D.ts +58 -0
- package/gen/classes/SkeletonModification2DCCDIK.ts +107 -0
- package/gen/classes/SkeletonModification2DFABRIK.ts +73 -0
- package/gen/classes/SkeletonModification2DJiggle.ts +165 -0
- package/gen/classes/SkeletonModification2DLookAt.ts +84 -0
- package/gen/classes/SkeletonModification2DPhysicalBones.ts +49 -0
- package/gen/classes/SkeletonModification2DStackHolder.ts +26 -0
- package/gen/classes/SkeletonModification2DTwoBoneIK.ts +80 -0
- package/gen/classes/SkeletonModificationStack2D.ts +82 -0
- package/gen/classes/SkeletonModifier3D.ts +168 -0
- package/gen/classes/SkeletonProfile.ts +180 -0
- package/gen/classes/SkeletonProfileHumanoid.ts +76 -0
- package/gen/classes/Skin.ts +35 -0
- package/gen/classes/SkinReference.ts +30 -0
- package/gen/classes/Sky.ts +94 -0
- package/gen/classes/Slider.ts +78 -0
- package/gen/classes/SliderJoint3D.ts +122 -0
- package/gen/classes/SocketServer.ts +34 -0
- package/gen/classes/SoftBody3D.ts +188 -0
- package/gen/classes/SphereMesh.ts +45 -0
- package/gen/classes/SphereOccluder3D.ts +21 -0
- package/gen/classes/SphereShape3D.ts +21 -0
- package/gen/classes/SpinBox.ts +97 -0
- package/gen/classes/SplineIK3D.ts +70 -0
- package/gen/classes/SplitContainer.ts +163 -0
- package/gen/classes/SpotLight3D.ts +46 -0
- package/gen/classes/SpringArm3D.ts +64 -0
- package/gen/classes/SpringBoneCollision3D.ts +48 -0
- package/gen/classes/SpringBoneCollisionCapsule3D.ts +40 -0
- package/gen/classes/SpringBoneCollisionPlane3D.ts +14 -0
- package/gen/classes/SpringBoneCollisionSphere3D.ts +26 -0
- package/gen/classes/SpringBoneSimulator3D.ts +476 -0
- package/gen/classes/Sprite2D.ts +125 -0
- package/gen/classes/Sprite3D.ts +71 -0
- package/gen/classes/SpriteBase3D.ts +205 -0
- package/gen/classes/SpriteFrames.ts +147 -0
- package/gen/classes/StandardMaterial3D.ts +14 -0
- package/gen/classes/StaticBody2D.ts +37 -0
- package/gen/classes/StaticBody3D.ts +37 -0
- package/gen/classes/StatusIndicator.ts +50 -0
- package/gen/classes/StreamPeer.ts +206 -0
- package/gen/classes/StreamPeerBuffer.ts +52 -0
- package/gen/classes/StreamPeerExtension.ts +12 -0
- package/gen/classes/StreamPeerGZIP.ts +37 -0
- package/gen/classes/StreamPeerSocket.ts +51 -0
- package/gen/classes/StreamPeerTCP.ts +48 -0
- package/gen/classes/StreamPeerTLS.ts +73 -0
- package/gen/classes/StreamPeerUDS.ts +32 -0
- package/gen/classes/StyleBox.ts +86 -0
- package/gen/classes/StyleBoxEmpty.ts +14 -0
- package/gen/classes/StyleBoxFlat.ts +200 -0
- package/gen/classes/StyleBoxLine.ts +45 -0
- package/gen/classes/StyleBoxTexture.ts +138 -0
- package/gen/classes/SubViewport.ts +98 -0
- package/gen/classes/SubViewportContainer.ts +40 -0
- package/gen/classes/SubtweenTweener.ts +20 -0
- package/gen/classes/SurfaceTool.ts +271 -0
- package/gen/classes/SyntaxHighlighter.ts +54 -0
- package/gen/classes/SystemFont.ts +122 -0
- package/gen/classes/TCPServer.ts +35 -0
- package/gen/classes/TLSOptions.ts +79 -0
- package/gen/classes/TabBar.ts +363 -0
- package/gen/classes/TabContainer.ts +296 -0
- package/gen/classes/TextEdit.ts +1458 -0
- package/gen/classes/TextLine.ts +179 -0
- package/gen/classes/TextMesh.ts +134 -0
- package/gen/classes/TextParagraph.ts +278 -0
- package/gen/classes/TextServer.ts +1891 -0
- package/gen/classes/TextServerAdvanced.ts +14 -0
- package/gen/classes/TextServerDummy.ts +30 -0
- package/gen/classes/TextServerExtension.ts +20 -0
- package/gen/classes/TextServerManager.ts +71 -0
- package/gen/classes/Texture.ts +14 -0
- package/gen/classes/Texture2D.ts +84 -0
- package/gen/classes/Texture2DArray.ts +22 -0
- package/gen/classes/Texture2DArrayRD.ts +15 -0
- package/gen/classes/Texture2DRD.ts +22 -0
- package/gen/classes/Texture3D.ts +55 -0
- package/gen/classes/Texture3DRD.ts +22 -0
- package/gen/classes/TextureButton.ts +112 -0
- package/gen/classes/TextureCubemapArrayRD.ts +15 -0
- package/gen/classes/TextureCubemapRD.ts +15 -0
- package/gen/classes/TextureLayered.ts +73 -0
- package/gen/classes/TextureLayeredRD.ts +21 -0
- package/gen/classes/TextureProgressBar.ts +158 -0
- package/gen/classes/TextureRect.ts +109 -0
- package/gen/classes/Theme.ts +438 -0
- package/gen/classes/ThemeDB.ts +72 -0
- package/gen/classes/Thread.ts +86 -0
- package/gen/classes/TileData.ts +255 -0
- package/gen/classes/TileMap.ts +400 -0
- package/gen/classes/TileMapLayer.ts +303 -0
- package/gen/classes/TileMapPattern.ts +67 -0
- package/gen/classes/TileSet.ts +619 -0
- package/gen/classes/TileSetAtlasSource.ts +269 -0
- package/gen/classes/TileSetScenesCollectionSource.ts +87 -0
- package/gen/classes/TileSetSource.ts +50 -0
- package/gen/classes/Time.ts +237 -0
- package/gen/classes/Timer.ts +109 -0
- package/gen/classes/TorusMesh.ts +38 -0
- package/gen/classes/TouchScreenButton.ts +106 -0
- package/gen/classes/Translation.ts +91 -0
- package/gen/classes/TranslationDomain.ts +154 -0
- package/gen/classes/TranslationServer.ts +194 -0
- package/gen/classes/Tree.ts +521 -0
- package/gen/classes/TreeItem.ts +682 -0
- package/gen/classes/TriangleMesh.ts +52 -0
- package/gen/classes/TubeTrailMesh.ts +64 -0
- package/gen/classes/Tween.ts +604 -0
- package/gen/classes/Tweener.ts +20 -0
- package/gen/classes/TwoBoneIK3D.ts +173 -0
- package/gen/classes/UDPServer.ts +115 -0
- package/gen/classes/UDSServer.ts +28 -0
- package/gen/classes/UPNP.ts +279 -0
- package/gen/classes/UPNPDevice.ts +116 -0
- package/gen/classes/UndoRedo.ts +226 -0
- package/gen/classes/UniformSetCacheRD.ts +21 -0
- package/gen/classes/VBoxContainer.ts +14 -0
- package/gen/classes/VFlowContainer.ts +14 -0
- package/gen/classes/VScrollBar.ts +14 -0
- package/gen/classes/VSeparator.ts +14 -0
- package/gen/classes/VSlider.ts +14 -0
- package/gen/classes/VSplitContainer.ts +14 -0
- package/gen/classes/VehicleBody3D.ts +38 -0
- package/gen/classes/VehicleWheel3D.ts +134 -0
- package/gen/classes/VideoStream.ts +22 -0
- package/gen/classes/VideoStreamPlayback.ts +21 -0
- package/gen/classes/VideoStreamPlayer.ts +129 -0
- package/gen/classes/VideoStreamTheora.ts +15 -0
- package/gen/classes/Viewport.ts +1109 -0
- package/gen/classes/ViewportTexture.ts +35 -0
- package/gen/classes/VirtualJoystick.ts +150 -0
- package/gen/classes/VisibleOnScreenEnabler2D.ts +47 -0
- package/gen/classes/VisibleOnScreenEnabler3D.ts +47 -0
- package/gen/classes/VisibleOnScreenNotifier2D.ts +48 -0
- package/gen/classes/VisibleOnScreenNotifier3D.ts +42 -0
- package/gen/classes/VisualInstance3D.ts +69 -0
- package/gen/classes/VisualShader.ts +247 -0
- package/gen/classes/VisualShaderNode.ts +103 -0
- package/gen/classes/VisualShaderNodeBillboard.ts +52 -0
- package/gen/classes/VisualShaderNodeBooleanConstant.ts +21 -0
- package/gen/classes/VisualShaderNodeBooleanParameter.ts +26 -0
- package/gen/classes/VisualShaderNodeClamp.ts +54 -0
- package/gen/classes/VisualShaderNodeColorConstant.ts +22 -0
- package/gen/classes/VisualShaderNodeColorFunc.ts +106 -0
- package/gen/classes/VisualShaderNodeColorOp.ts +144 -0
- package/gen/classes/VisualShaderNodeColorParameter.ts +27 -0
- package/gen/classes/VisualShaderNodeComment.ts +20 -0
- package/gen/classes/VisualShaderNodeCompare.ts +124 -0
- package/gen/classes/VisualShaderNodeConstant.ts +13 -0
- package/gen/classes/VisualShaderNodeCubemap.ts +72 -0
- package/gen/classes/VisualShaderNodeCubemapParameter.ts +14 -0
- package/gen/classes/VisualShaderNodeCurveTexture.ts +21 -0
- package/gen/classes/VisualShaderNodeCurveXYZTexture.ts +21 -0
- package/gen/classes/VisualShaderNodeCustom.ts +38 -0
- package/gen/classes/VisualShaderNodeDerivativeFunc.ts +100 -0
- package/gen/classes/VisualShaderNodeDeterminant.ts +14 -0
- package/gen/classes/VisualShaderNodeDistanceFade.ts +14 -0
- package/gen/classes/VisualShaderNodeDotProduct.ts +14 -0
- package/gen/classes/VisualShaderNodeExpression.ts +21 -0
- package/gen/classes/VisualShaderNodeFaceForward.ts +14 -0
- package/gen/classes/VisualShaderNodeFloatConstant.ts +20 -0
- package/gen/classes/VisualShaderNodeFloatFunc.ts +158 -0
- package/gen/classes/VisualShaderNodeFloatOp.ts +70 -0
- package/gen/classes/VisualShaderNodeFloatParameter.ts +72 -0
- package/gen/classes/VisualShaderNodeFrame.ts +58 -0
- package/gen/classes/VisualShaderNodeFresnel.ts +14 -0
- package/gen/classes/VisualShaderNodeGlobalExpression.ts +14 -0
- package/gen/classes/VisualShaderNodeGroupBase.ts +118 -0
- package/gen/classes/VisualShaderNodeIf.ts +17 -0
- package/gen/classes/VisualShaderNodeInput.ts +32 -0
- package/gen/classes/VisualShaderNodeIntConstant.ts +20 -0
- package/gen/classes/VisualShaderNodeIntFunc.ts +46 -0
- package/gen/classes/VisualShaderNodeIntOp.ts +78 -0
- package/gen/classes/VisualShaderNodeIntParameter.ts +83 -0
- package/gen/classes/VisualShaderNodeIs.ts +38 -0
- package/gen/classes/VisualShaderNodeLinearSceneDepth.ts +14 -0
- package/gen/classes/VisualShaderNodeMix.ts +58 -0
- package/gen/classes/VisualShaderNodeMultiplyAdd.ts +46 -0
- package/gen/classes/VisualShaderNodeOuterProduct.ts +14 -0
- package/gen/classes/VisualShaderNodeOutput.ts +13 -0
- package/gen/classes/VisualShaderNodeParameter.ts +57 -0
- package/gen/classes/VisualShaderNodeParameterRef.ts +23 -0
- package/gen/classes/VisualShaderNodeParticleAccelerator.ts +42 -0
- package/gen/classes/VisualShaderNodeParticleBoxEmitter.ts +14 -0
- package/gen/classes/VisualShaderNodeParticleConeVelocity.ts +14 -0
- package/gen/classes/VisualShaderNodeParticleEmit.ts +46 -0
- package/gen/classes/VisualShaderNodeParticleEmitter.ts +19 -0
- package/gen/classes/VisualShaderNodeParticleMeshEmitter.ts +33 -0
- package/gen/classes/VisualShaderNodeParticleMultiplyByAxisAngle.ts +20 -0
- package/gen/classes/VisualShaderNodeParticleOutput.ts +14 -0
- package/gen/classes/VisualShaderNodeParticleRandomness.ts +46 -0
- package/gen/classes/VisualShaderNodeParticleRingEmitter.ts +14 -0
- package/gen/classes/VisualShaderNodeParticleSphereEmitter.ts +14 -0
- package/gen/classes/VisualShaderNodeProximityFade.ts +14 -0
- package/gen/classes/VisualShaderNodeRandomRange.ts +14 -0
- package/gen/classes/VisualShaderNodeRemap.ts +55 -0
- package/gen/classes/VisualShaderNodeReroute.ts +18 -0
- package/gen/classes/VisualShaderNodeResizableBase.ts +20 -0
- package/gen/classes/VisualShaderNodeRotationByAxis.ts +14 -0
- package/gen/classes/VisualShaderNodeSDFRaymarch.ts +14 -0
- package/gen/classes/VisualShaderNodeSDFToScreenUV.ts +14 -0
- package/gen/classes/VisualShaderNodeSample3D.ts +37 -0
- package/gen/classes/VisualShaderNodeScreenNormalWorldSpace.ts +14 -0
- package/gen/classes/VisualShaderNodeScreenUVToSDF.ts +14 -0
- package/gen/classes/VisualShaderNodeSmoothStep.ts +59 -0
- package/gen/classes/VisualShaderNodeStep.ts +59 -0
- package/gen/classes/VisualShaderNodeSwitch.ts +62 -0
- package/gen/classes/VisualShaderNodeTexture.ts +96 -0
- package/gen/classes/VisualShaderNodeTexture2DArray.ts +21 -0
- package/gen/classes/VisualShaderNodeTexture2DArrayParameter.ts +14 -0
- package/gen/classes/VisualShaderNodeTexture2DParameter.ts +14 -0
- package/gen/classes/VisualShaderNodeTexture3D.ts +21 -0
- package/gen/classes/VisualShaderNodeTexture3DParameter.ts +14 -0
- package/gen/classes/VisualShaderNodeTextureParameter.ts +177 -0
- package/gen/classes/VisualShaderNodeTextureParameterTriplanar.ts +14 -0
- package/gen/classes/VisualShaderNodeTextureSDF.ts +14 -0
- package/gen/classes/VisualShaderNodeTextureSDFNormal.ts +14 -0
- package/gen/classes/VisualShaderNodeTransformCompose.ts +14 -0
- package/gen/classes/VisualShaderNodeTransformConstant.ts +21 -0
- package/gen/classes/VisualShaderNodeTransformDecompose.ts +14 -0
- package/gen/classes/VisualShaderNodeTransformFunc.ts +38 -0
- package/gen/classes/VisualShaderNodeTransformOp.ts +66 -0
- package/gen/classes/VisualShaderNodeTransformParameter.ts +27 -0
- package/gen/classes/VisualShaderNodeTransformVecMult.ts +46 -0
- package/gen/classes/VisualShaderNodeUIntConstant.ts +20 -0
- package/gen/classes/VisualShaderNodeUIntFunc.ts +38 -0
- package/gen/classes/VisualShaderNodeUIntOp.ts +78 -0
- package/gen/classes/VisualShaderNodeUIntParameter.ts +26 -0
- package/gen/classes/VisualShaderNodeUVFunc.ts +38 -0
- package/gen/classes/VisualShaderNodeUVPolarCoord.ts +14 -0
- package/gen/classes/VisualShaderNodeVarying.ts +26 -0
- package/gen/classes/VisualShaderNodeVaryingGetter.ts +14 -0
- package/gen/classes/VisualShaderNodeVaryingSetter.ts +14 -0
- package/gen/classes/VisualShaderNodeVec2Constant.ts +21 -0
- package/gen/classes/VisualShaderNodeVec2Parameter.ts +27 -0
- package/gen/classes/VisualShaderNodeVec3Constant.ts +21 -0
- package/gen/classes/VisualShaderNodeVec3Parameter.ts +27 -0
- package/gen/classes/VisualShaderNodeVec4Constant.ts +24 -0
- package/gen/classes/VisualShaderNodeVec4Parameter.ts +27 -0
- package/gen/classes/VisualShaderNodeVectorBase.ts +41 -0
- package/gen/classes/VisualShaderNodeVectorCompose.ts +14 -0
- package/gen/classes/VisualShaderNodeVectorDecompose.ts +14 -0
- package/gen/classes/VisualShaderNodeVectorDistance.ts +15 -0
- package/gen/classes/VisualShaderNodeVectorFunc.ts +162 -0
- package/gen/classes/VisualShaderNodeVectorLen.ts +14 -0
- package/gen/classes/VisualShaderNodeVectorOp.ts +78 -0
- package/gen/classes/VisualShaderNodeVectorRefract.ts +14 -0
- package/gen/classes/VisualShaderNodeWorldPositionFromDepth.ts +14 -0
- package/gen/classes/VoxelGI.ts +85 -0
- package/gen/classes/VoxelGIData.ts +95 -0
- package/gen/classes/WeakRef.ts +20 -0
- package/gen/classes/WebRTCDataChannel.ts +115 -0
- package/gen/classes/WebRTCDataChannelExtension.ts +14 -0
- package/gen/classes/WebRTCMultiplayerPeer.ts +63 -0
- package/gen/classes/WebRTCPeerConnection.ts +220 -0
- package/gen/classes/WebRTCPeerConnectionExtension.ts +15 -0
- package/gen/classes/WebSocketMultiplayerPeer.ts +81 -0
- package/gen/classes/WebSocketPeer.ts +213 -0
- package/gen/classes/WebXRInterface.ts +317 -0
- package/gen/classes/Window.ts +1127 -0
- package/gen/classes/WorkerThreadPool.ts +100 -0
- package/gen/classes/World2D.ts +36 -0
- package/gen/classes/World3D.ts +56 -0
- package/gen/classes/WorldBoundaryShape2D.ts +28 -0
- package/gen/classes/WorldBoundaryShape3D.ts +22 -0
- package/gen/classes/WorldEnvironment.ts +37 -0
- package/gen/classes/X509Certificate.ts +36 -0
- package/gen/classes/XMLParser.ts +154 -0
- package/gen/classes/XRAnchor3D.ts +27 -0
- package/gen/classes/XRBodyModifier3D.ts +70 -0
- package/gen/classes/XRBodyTracker.ts +444 -0
- package/gen/classes/XRCamera3D.ts +16 -0
- package/gen/classes/XRController3D.ts +79 -0
- package/gen/classes/XRControllerTracker.ts +16 -0
- package/gen/classes/XRFaceModifier3D.ts +29 -0
- package/gen/classes/XRFaceTracker.ts +614 -0
- package/gen/classes/XRHandModifier3D.ts +47 -0
- package/gen/classes/XRHandTracker.ts +246 -0
- package/gen/classes/XRInterface.ts +282 -0
- package/gen/classes/XRInterfaceExtension.ts +33 -0
- package/gen/classes/XRNode3D.ts +67 -0
- package/gen/classes/XROrigin3D.ts +29 -0
- package/gen/classes/XRPose.ts +80 -0
- package/gen/classes/XRPositionalTracker.ts +125 -0
- package/gen/classes/XRServer.ts +226 -0
- package/gen/classes/XRTracker.ts +40 -0
- package/gen/classes/XRVRS.ts +40 -0
- package/gen/classes/ZIPPacker.ts +114 -0
- package/gen/classes/ZIPReader.ts +89 -0
- package/gen/classes/index.ts +957 -0
- package/gen/global-constants.ts +60 -0
- package/gen/global-enums.ts +2284 -0
- package/gen/heap-types/GodotArray.ts +615 -0
- package/gen/heap-types/GodotDictionary.ts +298 -0
- package/gen/heap-types/PackedByteArray.ts +400 -0
- package/gen/heap-types/PackedColorArray.ts +144 -0
- package/gen/heap-types/PackedFloat32Array.ts +151 -0
- package/gen/heap-types/PackedFloat64Array.ts +152 -0
- package/gen/heap-types/PackedInt32Array.ts +144 -0
- package/gen/heap-types/PackedInt64Array.ts +145 -0
- package/gen/heap-types/PackedStringArray.ts +153 -0
- package/gen/heap-types/PackedVector2Array.ts +151 -0
- package/gen/heap-types/PackedVector3Array.ts +151 -0
- package/gen/heap-types/PackedVector4Array.ts +151 -0
- package/gen/heap-types/Signal.ts +180 -0
- package/gen/heap-types/index.ts +24 -0
- package/gen/index.ts +11 -0
- package/gen/utility-functions.ts +1457 -0
- package/gen/value-types/AABB.ts +288 -0
- package/gen/value-types/Basis.ts +283 -0
- package/gen/value-types/Color.ts +282 -0
- package/gen/value-types/Plane.ts +134 -0
- package/gen/value-types/Projection.ts +137 -0
- package/gen/value-types/Quaternion.ts +192 -0
- package/gen/value-types/Rect2.ts +182 -0
- package/gen/value-types/Rect2i.ts +161 -0
- package/gen/value-types/Transform2D.ts +206 -0
- package/gen/value-types/Transform3D.ts +137 -0
- package/gen/value-types/Vector2.ts +365 -0
- package/gen/value-types/Vector2i.ts +201 -0
- package/gen/value-types/Vector3.ts +365 -0
- package/gen/value-types/Vector3i.ts +202 -0
- package/gen/value-types/Vector4.ts +285 -0
- package/gen/value-types/Vector4i.ts +208 -0
- package/gen/value-types/index.ts +19 -0
- package/package.json +33 -0
- package/src/debug.ts +219 -0
- package/src/index.ts +36 -0
- package/src/runtime.ts +69 -0
|
@@ -0,0 +1,1499 @@
|
|
|
1
|
+
// Auto-generated from extension_api.json - DO NOT EDIT
|
|
2
|
+
// Generated by dev/codegen.ts
|
|
3
|
+
|
|
4
|
+
import { _C, _R, _G } from '../../src/runtime.ts';
|
|
5
|
+
import { CanvasItem } from './CanvasItem.ts';
|
|
6
|
+
import type { Side } from '../global-enums.ts';
|
|
7
|
+
import type { Callable, GodotArray, NodePath, Signal, StringName, Variant } from '../heap-types/index.ts';
|
|
8
|
+
import type { Color, Rect2, Vector2, Vector3i } from '../value-types/index.ts';
|
|
9
|
+
import type { AccessibilityLiveMode } from './DisplayServer.ts';
|
|
10
|
+
import type { Font } from './Font.ts';
|
|
11
|
+
import type { InputEvent } from './InputEvent.ts';
|
|
12
|
+
import type { AutoTranslateMode, Node } from './Node.ts';
|
|
13
|
+
import type { Object } from './Object.ts';
|
|
14
|
+
import type { StyleBox } from './StyleBox.ts';
|
|
15
|
+
import type { Texture2D } from './Texture2D.ts';
|
|
16
|
+
import type { Theme } from './Theme.ts';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Base class for all UI-related nodes. {@link Control} features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and offsets relative to the anchor. The offsets update automatically when the node, any of its parents, or the screen size change.
|
|
20
|
+
* For more information on Godot's UI system, anchors, offsets, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from {@link Control} and {@link Container} nodes.
|
|
21
|
+
* **Note:** Since both {@link Node2D} and {@link Control} inherit from {@link CanvasItem}, they share several concepts from the class such as the {@link CanvasItem.zIndex} and {@link CanvasItem.visible} properties.
|
|
22
|
+
* **User Interface nodes and input**
|
|
23
|
+
* Godot propagates input events via viewports. Each {@link Viewport} is responsible for propagating {@link InputEvent}s to their child nodes. As the {@link SceneTree.root} is a {@link Window}, this already happens automatically for all UI elements in your game.
|
|
24
|
+
* Input events are propagated through the {@link SceneTree} from the root node to all child nodes by calling {@link Node.Input}. For UI elements specifically, it makes more sense to override the virtual method {@link _guiInput}, which filters out unrelated input events, such as by checking z-order, {@link mouseFilter}, focus, or if the event was inside of the control's bounding box.
|
|
25
|
+
* Call {@link acceptEvent} so no other node receives the event. Once you accept an input, it becomes handled so {@link Node.UnhandledInput} will not process it.
|
|
26
|
+
* Only one {@link Control} node can be in focus. Only the node in focus will receive events. To get the focus, call {@link grabFocus}. {@link Control} nodes lose focus when another node grabs it, or if you hide the node in focus. Focus will not be represented visually if gained via mouse/touch input, only appearing with keyboard/gamepad input (for accessibility), or via {@link grabFocus}.
|
|
27
|
+
* Set {@link mouseFilter} to {@link MOUSE_FILTER_IGNORE} to tell a {@link Control} node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.
|
|
28
|
+
* {@link Theme} resources change the control's appearance. The {@link theme} of a {@link Control} node affects all of its direct and indirect children (as long as a chain of controls is uninterrupted). To override some of the theme items, call one of the `add_theme_*_override` methods, like {@link addThemeFontOverride}. You can also override theme items in the Inspector.
|
|
29
|
+
* **Note:** Theme items are *not* {@link Object} properties. This means you can't access their values using {@link Object.get} and {@link Object.set}. Instead, use the `get_theme_*` and `add_theme_*_override` methods provided by this class.
|
|
30
|
+
*/
|
|
31
|
+
export class Control extends CanvasItem {
|
|
32
|
+
constructor(name = 226) { super(name); }
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to {@link Node.UnhandledInput} or {@link Node.UnhandledKeyInput}.
|
|
36
|
+
* **Note:** This does not affect the methods in {@link Input}, only the way events are propagated.
|
|
37
|
+
*/
|
|
38
|
+
acceptEvent(): void { _C(this, 1057); }
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Returns the maximum size for this control. See {@link customMaximumSize}.
|
|
42
|
+
*/
|
|
43
|
+
getMaximumSize(): Vector2 { return _C(this, 5495) as Vector2; }
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Returns the combined maximum size from {@link customMaximumSize} and {@link getMaximumSize}, as well as the {@link customMaximumSize} of this node's parent if it is a Control node with {@link propagateMaximumSize} set to `true`.
|
|
47
|
+
*/
|
|
48
|
+
getCombinedMaximumSize(): Vector2 { return _C(this, 4242) as Vector2; }
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Returns the minimum size for this control. See {@link customMinimumSize}.
|
|
52
|
+
*/
|
|
53
|
+
getMinimumSize(): Vector2 { return _C(this, 5554) as Vector2; }
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Returns the combined minimum size from {@link customMinimumSize} and {@link getMinimumSize}.
|
|
57
|
+
*/
|
|
58
|
+
getCombinedMinimumSize(): Vector2 { return _C(this, 4243) as Vector2; }
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Returns the bound value of {@link getCombinedMinimumSize} by {@link getCombinedMaximumSize}.
|
|
62
|
+
* This value is the true minimum size of the container, as the maximum size has priority over the minimum size.
|
|
63
|
+
* 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).
|
|
64
|
+
*/
|
|
65
|
+
getBoundMinimumSize(): Vector2 { return _C(this, 3996) as Vector2; }
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Sets the anchors to a `preset` from {@link Control.LayoutPreset} enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
|
69
|
+
* If `keepOffsets` is `true`, control's position will also be updated.
|
|
70
|
+
*/
|
|
71
|
+
setAnchorsPreset(preset: LayoutPreset, keepOffsets?: boolean /* = false */): void { _C(this, 10490, preset, keepOffsets); }
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Sets the offsets to a `preset` from {@link Control.LayoutPreset} enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
|
75
|
+
* Use parameter `resizeMode` with constants from {@link Control.LayoutPresetMode} to better determine the resulting size of the {@link Control}. Constant size will be ignored if used with presets that change size, e.g. {@link PRESET_LEFT_WIDE}.
|
|
76
|
+
* Use parameter `margin` to determine the gap between the {@link Control} and the edges.
|
|
77
|
+
*/
|
|
78
|
+
setOffsetsPreset(preset: LayoutPreset, resizeMode?: LayoutPresetMode /* = 0 */, margin?: number /* = 0 */): void { _C(this, 12181, preset, resizeMode, margin); }
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Sets both anchor preset and offset preset. See {@link setAnchorsPreset} and {@link setOffsetsPreset}.
|
|
82
|
+
*/
|
|
83
|
+
setAnchorsAndOffsetsPreset(preset: LayoutPreset, resizeMode?: LayoutPresetMode /* = 0 */, margin?: number /* = 0 */): void { _C(this, 10489, preset, resizeMode, margin); }
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Sets the anchor for the specified {@link Side} to `anchor`. A setter method for {@link anchorBottom}, {@link anchorLeft}, {@link anchorRight} and {@link anchorTop}.
|
|
87
|
+
* If `keepOffset` is `true`, offsets aren't updated after this operation.
|
|
88
|
+
* If `pushOppositeAnchor` is `true` and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If `pushOppositeAnchor` was `false`, the left anchor would get value 0.5.
|
|
89
|
+
*/
|
|
90
|
+
setAnchor(side: Side, anchor: number, keepOffset?: boolean /* = false */, pushOppositeAnchor?: boolean /* = true */): void { _C(this, 10485, side, anchor, keepOffset, pushOppositeAnchor); }
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Works the same as {@link setAnchor}, but instead of `keep_offset` argument and automatic update of offset, it allows to set the offset yourself (see {@link setOffset}).
|
|
94
|
+
*/
|
|
95
|
+
setAnchorAndOffset(side: Side, anchor: number, offset: number, pushOppositeAnchor?: boolean /* = false */): void { _C(this, 10486, side, anchor, offset, pushOppositeAnchor); }
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Sets {@link offsetLeft} and {@link offsetTop} at the same time. Equivalent of changing {@link position}.
|
|
99
|
+
*/
|
|
100
|
+
setBegin(position: Vector2): void { _C(this, 10650, position); }
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Sets {@link offsetRight} and {@link offsetBottom} at the same time.
|
|
104
|
+
*/
|
|
105
|
+
setEnd(position: Vector2): void { _C(this, 11288, position); }
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Sets the {@link position} to given `position`.
|
|
109
|
+
* If `keepOffsets` is `true`, control's anchors will be updated instead of offsets.
|
|
110
|
+
*/
|
|
111
|
+
setPosition(position: Vector2, keepOffsets?: boolean /* = false */): void { _C(this, 12381, position, keepOffsets); }
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Sets the size (see {@link size}).
|
|
115
|
+
* If `keepOffsets` is `true`, control's anchors will be updated instead of offsets.
|
|
116
|
+
*/
|
|
117
|
+
setSize(size: Vector2, keepOffsets?: boolean /* = false */): void { _C(this, 12752, size, keepOffsets); }
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Resets the size to {@link getCombinedMinimumSize}. This is equivalent to calling `set_size(Vector2())` (or any size below the minimum).
|
|
121
|
+
*/
|
|
122
|
+
resetSize(): void { _C(this, 10073); }
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Sets the {@link globalPosition} to given `position`.
|
|
126
|
+
* If `keepOffsets` is `true`, control's anchors will be updated instead of offsets.
|
|
127
|
+
*/
|
|
128
|
+
setGlobalPosition(position: Vector2, keepOffsets?: boolean /* = false */): void { _C(this, 11517, position, keepOffsets); }
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Returns {@link offsetLeft} and {@link offsetTop}. See also {@link position}.
|
|
132
|
+
*/
|
|
133
|
+
getBegin(): Vector2 { return _C(this, 3907) as Vector2; }
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Returns {@link offsetRight} and {@link offsetBottom}.
|
|
137
|
+
*/
|
|
138
|
+
getEnd(): Vector2 { return _C(this, 4660) as Vector2; }
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Returns the combined value of {@link pivotOffset} and {@link pivotOffsetRatio}, in pixels. The ratio is multiplied by the control's size.
|
|
142
|
+
*/
|
|
143
|
+
getCombinedPivotOffset(): Vector2 { return _C(this, 4244) as Vector2; }
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Returns the width/height occupied in the parent control.
|
|
147
|
+
*/
|
|
148
|
+
getParentAreaSize(): Vector2 { return _C(this, 5820) as Vector2; }
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Returns the position of this {@link Control} in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins.
|
|
152
|
+
* Equivalent to `get_screen_transform().origin` (see {@link CanvasItem.getScreenTransform}).
|
|
153
|
+
* **Example:** Show a popup at the mouse position:
|
|
154
|
+
*
|
|
155
|
+
* ```text
|
|
156
|
+
*
|
|
157
|
+
* popup_menu.position = get_screen_position() + get_screen_transform().basis_xform(get_local_mouse_position())
|
|
158
|
+
*
|
|
159
|
+
* # The above code is equivalent to:
|
|
160
|
+
* popup_menu.position = get_screen_transform() * get_local_mouse_position()
|
|
161
|
+
*
|
|
162
|
+
* popup_menu.reset_size()
|
|
163
|
+
* popup_menu.popup()
|
|
164
|
+
*
|
|
165
|
+
* ```
|
|
166
|
+
*/
|
|
167
|
+
getScreenPosition(): Vector2 { return _C(this, 6261) as Vector2; }
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Returns the position and size of the control in the coordinate system of the containing node. See {@link position}, {@link scale} and {@link size}.
|
|
171
|
+
* **Note:** If {@link rotation} is not the default rotation, the resulting size is not meaningful.
|
|
172
|
+
* **Note:** Setting {@link Viewport.guiSnapControlsToPixels} to `true` can lead to rounding inaccuracies between the displayed control and the returned {@link Rect2}.
|
|
173
|
+
*/
|
|
174
|
+
getRect(): Rect2 { return _C(this, 6092) as Rect2; }
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* Returns the position and size of the control relative to the containing canvas. See {@link globalPosition} and {@link size}.
|
|
178
|
+
* **Note:** If the node itself or any parent {@link CanvasItem} between the node and the canvas have a non default rotation or skew, the resulting size is likely not meaningful.
|
|
179
|
+
* **Note:** Setting {@link Viewport.guiSnapControlsToPixels} to `true` can lead to rounding inaccuracies between the displayed control and the returned {@link Rect2}.
|
|
180
|
+
*/
|
|
181
|
+
getGlobalRect(): Rect2 { return _C(this, 4930) as Rect2; }
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Returns the {@link focusMode}, but takes the {@link focusBehaviorRecursive} into account. If {@link focusBehaviorRecursive} is set to {@link FOCUS_BEHAVIOR_DISABLED}, or it is set to {@link FOCUS_BEHAVIOR_INHERITED} and its ancestor is set to {@link FOCUS_BEHAVIOR_DISABLED}, then this returns {@link FOCUS_NONE}.
|
|
185
|
+
*/
|
|
186
|
+
getFocusModeWithOverride(): FocusMode { return _C(this, 4823) as FocusMode; }
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Returns `true` if this is the current focused control. See {@link focusMode}.
|
|
190
|
+
* If `ignoreHiddenFocus` is `true`, controls that have their focus hidden will always return `false`. Hidden focus happens automatically when controls gain focus via mouse input, or manually using {@link grabFocus} with `hide_focus` set to `true`.
|
|
191
|
+
*/
|
|
192
|
+
hasFocus(ignoreHiddenFocus?: boolean /* = false */): boolean { return _C(this, 7397, ignoreHiddenFocus) as boolean; }
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Steal the focus from another control and become the focused control (see {@link focusMode}).
|
|
196
|
+
* If `hideFocus` 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/showFocusStateOnPointerEvent} is set to `Text Input Controls`, or for any control when it is set to `Always`.
|
|
197
|
+
* **Note:** Using this method together with {@link Callable.callDeferred} makes it more reliable, especially when called inside {@link Node.Ready}.
|
|
198
|
+
*/
|
|
199
|
+
grabFocus(hideFocus?: boolean /* = false */): void { _C(this, 7285, hideFocus); }
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Give up the focus. No other control will be able to receive input.
|
|
203
|
+
*/
|
|
204
|
+
releaseFocus(): void { _C(this, 9867); }
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Finds the previous (above in the tree) {@link Control} that can receive the focus.
|
|
208
|
+
*/
|
|
209
|
+
findPrevValidFocus(): Control { return _C(this, 3299) as Control; }
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Finds the next (below in the tree) {@link Control} that can receive the focus.
|
|
213
|
+
*/
|
|
214
|
+
findNextValidFocus(): Control { return _C(this, 3296) as Control; }
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* Finds the next {@link Control} that can receive the focus on the specified {@link Side}.
|
|
218
|
+
* **Note:** This is different from {@link getFocusNeighbor}, which returns the path of a specified focus neighbor.
|
|
219
|
+
*/
|
|
220
|
+
findValidFocusNeighbor(side: Side): Control { return _C(this, 3304, side) as Control; }
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* Prevents `*_theme_*_override` methods from emitting {@link NOTIFICATION_THEME_CHANGED} until {@link endBulkThemeOverride} is called.
|
|
224
|
+
*/
|
|
225
|
+
beginBulkThemeOverride(): void { _C(this, 1746); }
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* Ends a bulk theme override update. See {@link beginBulkThemeOverride}.
|
|
229
|
+
*/
|
|
230
|
+
endBulkThemeOverride(): void { _C(this, 3095); }
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* Creates a local override for a theme icon with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeIconOverride}.
|
|
234
|
+
* See also {@link getThemeIcon}.
|
|
235
|
+
*/
|
|
236
|
+
addThemeIconOverride(name: StringName, texture: Texture2D): void { _C(this, 1312, name, texture); }
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* Creates a local override for a theme {@link StyleBox} with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeStyleboxOverride}.
|
|
240
|
+
* See also {@link getThemeStylebox}.
|
|
241
|
+
* **Example:** Modify a property in a {@link StyleBox} by duplicating it:
|
|
242
|
+
*
|
|
243
|
+
*
|
|
244
|
+
* ```gdscript
|
|
245
|
+
*
|
|
246
|
+
* # The snippet below assumes the child node "MyButton" has a StyleBoxFlat assigned.
|
|
247
|
+
* # Resources are shared across instances, so we need to duplicate it
|
|
248
|
+
* # to avoid modifying the appearance of all other buttons.
|
|
249
|
+
* var new_stylebox_normal = $MyButton.get_theme_stylebox("normal").duplicate()
|
|
250
|
+
* new_stylebox_normal.border_width_top = 3
|
|
251
|
+
* new_stylebox_normal.border_color = Color(0, 1, 0.5)
|
|
252
|
+
* $MyButton.add_theme_stylebox_override("normal", new_stylebox_normal)
|
|
253
|
+
* # Remove the stylebox override.
|
|
254
|
+
* $MyButton.remove_theme_stylebox_override("normal")
|
|
255
|
+
*
|
|
256
|
+
* ```
|
|
257
|
+
*/
|
|
258
|
+
addThemeStyleboxOverride(name: StringName, stylebox: StyleBox): void { _C(this, 1313, name, stylebox); }
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Creates a local override for a theme {@link Font} with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeFontOverride}.
|
|
262
|
+
* See also {@link getThemeFont}.
|
|
263
|
+
*/
|
|
264
|
+
addThemeFontOverride(name: StringName, font: Font): void { _C(this, 1310, name, font); }
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Creates a local override for a theme font size with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeFontSizeOverride}.
|
|
268
|
+
* See also {@link getThemeFontSize}.
|
|
269
|
+
*/
|
|
270
|
+
addThemeFontSizeOverride(name: StringName, fontSize: number): void { _C(this, 1311, name, fontSize); }
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Creates a local override for a theme {@link Color} with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeColorOverride}.
|
|
274
|
+
* See also {@link getThemeColor}.
|
|
275
|
+
* **Example:** Override a {@link Label}'s color and reset it later:
|
|
276
|
+
*
|
|
277
|
+
*
|
|
278
|
+
* ```gdscript
|
|
279
|
+
*
|
|
280
|
+
* # Given the child Label node "MyLabel", override its font color with a custom value.
|
|
281
|
+
* $MyLabel.add_theme_color_override("font_color", Color(1, 0.5, 0))
|
|
282
|
+
* # Reset the font color of the child label.
|
|
283
|
+
* $MyLabel.remove_theme_color_override("font_color")
|
|
284
|
+
* # Alternatively it can be overridden with the default value from the Label type.
|
|
285
|
+
* $MyLabel.add_theme_color_override("font_color", get_theme_color("font_color", "Label"))
|
|
286
|
+
*
|
|
287
|
+
* ```
|
|
288
|
+
*/
|
|
289
|
+
addThemeColorOverride(name: StringName, color: Color): void { _C(this, 1308, name, color); }
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* Creates a local override for a theme constant with the specified `name`. Local overrides always take precedence when fetching theme items for the control. An override can be removed with {@link removeThemeConstantOverride}.
|
|
293
|
+
* See also {@link getThemeConstant}.
|
|
294
|
+
*/
|
|
295
|
+
addThemeConstantOverride(name: StringName, constant: number): void { _C(this, 1309, name, constant); }
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Removes a local override for a theme icon with the specified `name` previously added by {@link addThemeIconOverride} or via the Inspector dock.
|
|
299
|
+
*/
|
|
300
|
+
removeThemeIconOverride(name: StringName): void { _C(this, 9974, name); }
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* Removes a local override for a theme {@link StyleBox} with the specified `name` previously added by {@link addThemeStyleboxOverride} or via the Inspector dock.
|
|
304
|
+
*/
|
|
305
|
+
removeThemeStyleboxOverride(name: StringName): void { _C(this, 9975, name); }
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Removes a local override for a theme {@link Font} with the specified `name` previously added by {@link addThemeFontOverride} or via the Inspector dock.
|
|
309
|
+
*/
|
|
310
|
+
removeThemeFontOverride(name: StringName): void { _C(this, 9972, name); }
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* Removes a local override for a theme font size with the specified `name` previously added by {@link addThemeFontSizeOverride} or via the Inspector dock.
|
|
314
|
+
*/
|
|
315
|
+
removeThemeFontSizeOverride(name: StringName): void { _C(this, 9973, name); }
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* Removes a local override for a theme {@link Color} with the specified `name` previously added by {@link addThemeColorOverride} or via the Inspector dock.
|
|
319
|
+
*/
|
|
320
|
+
removeThemeColorOverride(name: StringName): void { _C(this, 9970, name); }
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* Removes a local override for a theme constant with the specified `name` previously added by {@link addThemeConstantOverride} or via the Inspector dock.
|
|
324
|
+
*/
|
|
325
|
+
removeThemeConstantOverride(name: StringName): void { _C(this, 9971, name); }
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* Returns an icon from the first matching {@link Theme} in the tree if that {@link Theme} has an icon item with the specified `name` and `themeType`.
|
|
329
|
+
* See {@link getThemeColor} for details.
|
|
330
|
+
*/
|
|
331
|
+
getThemeIcon(name: StringName, themeType?: StringName /* = &"" */): Texture2D { return _C(this, 6767, name, themeType) as Texture2D; }
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Returns a {@link StyleBox} from the first matching {@link Theme} in the tree if that {@link Theme} has a stylebox item with the specified `name` and `themeType`.
|
|
335
|
+
* See {@link getThemeColor} for details.
|
|
336
|
+
*/
|
|
337
|
+
getThemeStylebox(name: StringName, themeType?: StringName /* = &"" */): StyleBox { return _C(this, 6771, name, themeType) as StyleBox; }
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Returns a {@link Font} from the first matching {@link Theme} in the tree if that {@link Theme} has a font item with the specified `name` and `themeType`.
|
|
341
|
+
* See {@link getThemeColor} for details.
|
|
342
|
+
*/
|
|
343
|
+
getThemeFont(name: StringName, themeType?: StringName /* = &"" */): Font { return _C(this, 6765, name, themeType) as Font; }
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* Returns a font size from the first matching {@link Theme} in the tree if that {@link Theme} has a font size item with the specified `name` and `themeType`.
|
|
347
|
+
* See {@link getThemeColor} for details.
|
|
348
|
+
*/
|
|
349
|
+
getThemeFontSize(name: StringName, themeType?: StringName /* = &"" */): number { return _C(this, 6766, name, themeType) as number; }
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* Returns a {@link Color} from the first matching {@link Theme} in the tree if that {@link Theme} has a color item with the specified `name` and `themeType`. If `themeType` is omitted the class name of the current control is used as the type, or {@link themeTypeVariation} if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked.
|
|
353
|
+
* For the current control its local overrides are considered first (see {@link addThemeColorOverride}), then its assigned {@link theme}. After the current control, each parent control and its assigned {@link theme} are considered; controls without a {@link theme} assigned are skipped. If no matching {@link Theme} is found in the tree, the custom project {@link Theme} (see {@link ProjectSettings.gui/theme/custom}) and the default {@link Theme} are used (see {@link ThemeDB}).
|
|
354
|
+
*
|
|
355
|
+
*
|
|
356
|
+
* ```gdscript
|
|
357
|
+
*
|
|
358
|
+
* func _ready():
|
|
359
|
+
* # Get the font color defined for the current Control's class, if it exists.
|
|
360
|
+
* modulate = get_theme_color("font_color")
|
|
361
|
+
* # Get the font color defined for the Button class.
|
|
362
|
+
* modulate = get_theme_color("font_color", "Button")
|
|
363
|
+
*
|
|
364
|
+
* ```
|
|
365
|
+
*/
|
|
366
|
+
getThemeColor(name: StringName, themeType?: StringName /* = &"" */): Color { return _C(this, 6760, name, themeType) as Color; }
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Returns a constant from the first matching {@link Theme} in the tree if that {@link Theme} has a constant item with the specified `name` and `themeType`.
|
|
370
|
+
* See {@link getThemeColor} for details.
|
|
371
|
+
*/
|
|
372
|
+
getThemeConstant(name: StringName, themeType?: StringName /* = &"" */): number { return _C(this, 6761, name, themeType) as number; }
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Returns `true` if there is a local override for a theme icon with the specified `name` in this {@link Control} node.
|
|
376
|
+
* See {@link addThemeIconOverride}.
|
|
377
|
+
*/
|
|
378
|
+
hasThemeIconOverride(name: StringName): boolean { return _C(this, 7467, name) as boolean; }
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Returns `true` if there is a local override for a theme {@link StyleBox} with the specified `name` in this {@link Control} node.
|
|
382
|
+
* See {@link addThemeStyleboxOverride}.
|
|
383
|
+
*/
|
|
384
|
+
hasThemeStyleboxOverride(name: StringName): boolean { return _C(this, 7470, name) as boolean; }
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Returns `true` if there is a local override for a theme {@link Font} with the specified `name` in this {@link Control} node.
|
|
388
|
+
* See {@link addThemeFontOverride}.
|
|
389
|
+
*/
|
|
390
|
+
hasThemeFontOverride(name: StringName): boolean { return _C(this, 7463, name) as boolean; }
|
|
391
|
+
|
|
392
|
+
/**
|
|
393
|
+
* Returns `true` if there is a local override for a theme font size with the specified `name` in this {@link Control} node.
|
|
394
|
+
* See {@link addThemeFontSizeOverride}.
|
|
395
|
+
*/
|
|
396
|
+
hasThemeFontSizeOverride(name: StringName): boolean { return _C(this, 7465, name) as boolean; }
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* Returns `true` if there is a local override for a theme {@link Color} with the specified `name` in this {@link Control} node.
|
|
400
|
+
* See {@link addThemeColorOverride}.
|
|
401
|
+
*/
|
|
402
|
+
hasThemeColorOverride(name: StringName): boolean { return _C(this, 7459, name) as boolean; }
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* Returns `true` if there is a local override for a theme constant with the specified `name` in this {@link Control} node.
|
|
406
|
+
* See {@link addThemeConstantOverride}.
|
|
407
|
+
*/
|
|
408
|
+
hasThemeConstantOverride(name: StringName): boolean { return _C(this, 7461, name) as boolean; }
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has an icon item with the specified `name` and `themeType`.
|
|
412
|
+
* See {@link getThemeColor} for details.
|
|
413
|
+
*/
|
|
414
|
+
hasThemeIcon(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7466, name, themeType) as boolean; }
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has a stylebox item with the specified `name` and `themeType`.
|
|
418
|
+
* See {@link getThemeColor} for details.
|
|
419
|
+
*/
|
|
420
|
+
hasThemeStylebox(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7469, name, themeType) as boolean; }
|
|
421
|
+
|
|
422
|
+
/**
|
|
423
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has a font item with the specified `name` and `themeType`.
|
|
424
|
+
* See {@link getThemeColor} for details.
|
|
425
|
+
*/
|
|
426
|
+
hasThemeFont(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7462, name, themeType) as boolean; }
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has a font size item with the specified `name` and `themeType`.
|
|
430
|
+
* See {@link getThemeColor} for details.
|
|
431
|
+
*/
|
|
432
|
+
hasThemeFontSize(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7464, name, themeType) as boolean; }
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has a color item with the specified `name` and `themeType`.
|
|
436
|
+
* See {@link getThemeColor} for details.
|
|
437
|
+
*/
|
|
438
|
+
hasThemeColor(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7458, name, themeType) as boolean; }
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* Returns `true` if there is a matching {@link Theme} in the tree that has a constant item with the specified `name` and `themeType`.
|
|
442
|
+
* See {@link getThemeColor} for details.
|
|
443
|
+
*/
|
|
444
|
+
hasThemeConstant(name: StringName, themeType?: StringName /* = &"" */): boolean { return _C(this, 7460, name, themeType) as boolean; }
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Returns the default base scale value from the first matching {@link Theme} in the tree if that {@link Theme} has a valid {@link Theme.defaultBaseScale} value.
|
|
448
|
+
* See {@link getThemeColor} for details.
|
|
449
|
+
*/
|
|
450
|
+
getThemeDefaultBaseScale(): number { return _C(this, 6762) as number; }
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Returns the default font from the first matching {@link Theme} in the tree if that {@link Theme} has a valid {@link Theme.defaultFont} value.
|
|
454
|
+
* See {@link getThemeColor} for details.
|
|
455
|
+
*/
|
|
456
|
+
getThemeDefaultFont(): Font { return _C(this, 6763) as Font; }
|
|
457
|
+
|
|
458
|
+
/**
|
|
459
|
+
* Returns the default font size value from the first matching {@link Theme} in the tree if that {@link Theme} has a valid {@link Theme.defaultFontSize} value.
|
|
460
|
+
* See {@link getThemeColor} for details.
|
|
461
|
+
*/
|
|
462
|
+
getThemeDefaultFontSize(): number { return _C(this, 6764) as number; }
|
|
463
|
+
|
|
464
|
+
/**
|
|
465
|
+
* Returns the parent control node.
|
|
466
|
+
*/
|
|
467
|
+
getParentControl(): Control { return _C(this, 5823) as Control; }
|
|
468
|
+
|
|
469
|
+
/**
|
|
470
|
+
* Returns the tooltip text for the position `atPosition` in the control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns {@link tooltipText}.
|
|
471
|
+
* You can override {@link _getTooltip} to implement custom behavior for this method.
|
|
472
|
+
* **Note:** If this method returns an empty {@link String} and {@link _makeCustomTooltip} is not overridden, no tooltip is displayed.
|
|
473
|
+
*/
|
|
474
|
+
getTooltip(atPosition?: Vector2 /* = Vector2(0, 0) */): string { return _C(this, 6843, atPosition) as string; }
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Returns the mouse cursor shape for this control when hovered over `atPosition` in local coordinates. For most controls, this is the same as {@link mouseDefaultCursorShape}, but some built-in controls implement more complex logic.
|
|
478
|
+
* You can override {@link _getCursorShape} to implement custom behavior for this method.
|
|
479
|
+
*/
|
|
480
|
+
getCursorShape(atPosition?: Vector2 /* = Vector2(0, 0) */): CursorShape { return _C(this, 4369, atPosition) as CursorShape; }
|
|
481
|
+
|
|
482
|
+
/**
|
|
483
|
+
* Forces drag and bypasses {@link _getDragData} and {@link setDragPreview} by passing `data` and `preview`. Drag will start even if the mouse is neither over nor pressed on this control.
|
|
484
|
+
* The methods {@link _canDropData} and {@link _dropData} must be implemented on controls that want to receive drop data.
|
|
485
|
+
*/
|
|
486
|
+
forceDrag(data: Variant, preview: Control): void { _C(this, 3529, data, preview); }
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* Starts drag-and-drop operation without using a mouse.
|
|
490
|
+
*/
|
|
491
|
+
accessibilityDrag(): void { _C(this, 1069); }
|
|
492
|
+
|
|
493
|
+
/**
|
|
494
|
+
* Ends drag-and-drop operation without using a mouse.
|
|
495
|
+
*/
|
|
496
|
+
accessibilityDrop(): void { _C(this, 1070); }
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Returns the {@link mouseFilter}, but takes the {@link mouseBehaviorRecursive} into account. If {@link mouseBehaviorRecursive} is set to {@link MOUSE_BEHAVIOR_DISABLED}, or it is set to {@link MOUSE_BEHAVIOR_INHERITED} and its ancestor is set to {@link MOUSE_BEHAVIOR_DISABLED}, then this returns {@link MOUSE_FILTER_IGNORE}.
|
|
500
|
+
*/
|
|
501
|
+
getMouseFilterWithOverride(): MouseFilter { return _C(this, 5588) as MouseFilter; }
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* Creates an {@link InputEventMouseButton} that attempts to click the control. If the event is received, the control gains focus.
|
|
505
|
+
*
|
|
506
|
+
*
|
|
507
|
+
* ```gdscript
|
|
508
|
+
*
|
|
509
|
+
* func _process(delta):
|
|
510
|
+
* grab_click_focus() # When clicking another Control node, this node will be clicked instead.
|
|
511
|
+
*
|
|
512
|
+
* ```
|
|
513
|
+
*/
|
|
514
|
+
grabClickFocus(): void { _C(this, 7284); }
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* Sets the given callables to be used instead of the control's own drag-and-drop virtual methods. If a callable is empty, its respective virtual method is used as normal.
|
|
518
|
+
* The arguments for each callable should be exactly the same as their respective virtual methods, which would be:
|
|
519
|
+
* - `dragFunc` corresponds to {@link _getDragData} and requires a {@link Vector2};
|
|
520
|
+
* - `canDropFunc` corresponds to {@link _canDropData} and requires both a {@link Vector2} and a {@link Variant};
|
|
521
|
+
* - `dropFunc` corresponds to {@link _dropData} and requires both a {@link Vector2} and a {@link Variant}.
|
|
522
|
+
*/
|
|
523
|
+
setDragForwarding(dragFunc: Callable, canDropFunc: Callable, dropFunc: Callable): void { _C(this, 11168, dragFunc, canDropFunc, dropFunc); }
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Shows the given control at the mouse pointer. A good time to call this method is in {@link _getDragData}. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended.
|
|
527
|
+
*
|
|
528
|
+
*
|
|
529
|
+
* ```gdscript
|
|
530
|
+
*
|
|
531
|
+
* @export var color = Color(1, 0, 0, 1)
|
|
532
|
+
*
|
|
533
|
+
* func _get_drag_data(position):
|
|
534
|
+
* # Use a control that is not in the tree
|
|
535
|
+
* var cpb = ColorPickerButton.new()
|
|
536
|
+
* cpb.color = color
|
|
537
|
+
* cpb.size = Vector2(50, 50)
|
|
538
|
+
* set_drag_preview(cpb)
|
|
539
|
+
* return color
|
|
540
|
+
*
|
|
541
|
+
* ```
|
|
542
|
+
*/
|
|
543
|
+
setDragPreview(control: Control): void { _C(this, 11173, control); }
|
|
544
|
+
|
|
545
|
+
/**
|
|
546
|
+
* Returns `true` if a drag operation is successful. Alternative to {@link Viewport.guiIsDragSuccessful}.
|
|
547
|
+
* Best used with {@link Node.NOTIFICATION_DRAG_END}.
|
|
548
|
+
*/
|
|
549
|
+
isDragSuccessful(): boolean { return _C(this, 7896) as boolean; }
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Moves the mouse cursor to `position`, relative to {@link position} of this {@link Control}.
|
|
553
|
+
* **Note:** {@link warpMouse} is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.
|
|
554
|
+
*/
|
|
555
|
+
warpMouse(position: Vector2): void { _C(this, 14840, position); }
|
|
556
|
+
|
|
557
|
+
/**
|
|
558
|
+
* Invalidates the maximum size cache in this node and in parent nodes up to top level. Intended to be used with {@link getMaximumSize} when the return value is changed. Setting {@link customMaximumSize} directly calls this method automatically.
|
|
559
|
+
* **Note:** Calling this method also calls {@link updateMinimumSize} since the combined minimum size may be affected by the maximum size change.
|
|
560
|
+
*/
|
|
561
|
+
updateMaximumSize(): void { _C(this, 14521); }
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* Invalidates the minimum size cache in this node and in parent nodes up to top level. Intended to be used with {@link getMinimumSize} when the return value is changed. Setting {@link customMinimumSize} directly calls this method automatically.
|
|
565
|
+
*/
|
|
566
|
+
updateMinimumSize(): void { _C(this, 14522); }
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Returns `true` if the layout is right-to-left. See also {@link layoutDirection}.
|
|
570
|
+
*/
|
|
571
|
+
isLayoutRtl(): boolean { return _C(this, 8067) as boolean; }
|
|
572
|
+
|
|
573
|
+
/**
|
|
574
|
+
* 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 getMinimumSize}. 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 getCombinedMinimumSize}).
|
|
575
|
+
* **Note:** {@link customMaximumSize} has priority over this property. For example, if you set {@link customMinimumSize} to `(200, 200)` and {@link customMaximumSize} to `(100, 100)`, the resulting size will be `(100, 100)`.
|
|
576
|
+
*/
|
|
577
|
+
get customMinimumSize(): Vector2 { return _C(this, 4392) as Vector2; }
|
|
578
|
+
set customMinimumSize(v: Vector2) { _C(this, 11017, v); }
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* 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.
|
|
582
|
+
* **Note:** The final effective maximum size may be subject to parent Container sizing and propagated maximum sizes. See also: {@link getCombinedMaximumSize}.
|
|
583
|
+
* **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.
|
|
584
|
+
* **Note:** This value has priority over {@link customMinimumSize}. For example, if you set {@link customMaximumSize} to `(100, 100)` and {@link customMinimumSize} to `(200, 200)`, the resulting size will be `(100, 100)`.
|
|
585
|
+
* **Note:** It is recommended to use {@link getBoundMinimumSize} instead of {@link getCombinedMinimumSize} when using this property, as the former respects maximum size limits when calculating the minimum size, while the latter does not.
|
|
586
|
+
*/
|
|
587
|
+
get customMaximumSize(): Vector2 { return _C(this, 4390) as Vector2; }
|
|
588
|
+
set customMaximumSize(v: Vector2) { _C(this, 11015, v); }
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* If `true`, this Control's children will use the value returned by {@link getCombinedMaximumSize} in their own size calculations.
|
|
592
|
+
*/
|
|
593
|
+
get propagateMaximumSize(): boolean { return _C(this, 8212) as boolean; }
|
|
594
|
+
set propagateMaximumSize(v: boolean) { _C(this, 12444, v); }
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* 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.
|
|
598
|
+
*/
|
|
599
|
+
get clipContents(): boolean { return _C(this, 7833) as boolean; }
|
|
600
|
+
set clipContents(v: boolean) { _C(this, 10864, v); }
|
|
601
|
+
|
|
602
|
+
get layoutMode(): number { return _C(this, 1003) as number; }
|
|
603
|
+
set layoutMode(v: number) { _C(this, 1031, v); }
|
|
604
|
+
|
|
605
|
+
get anchorsPreset(): number { return _C(this, 994) as number; }
|
|
606
|
+
set anchorsPreset(v: number) { _C(this, 1020, v); }
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left offset updates when the node moves or changes size. You can use one of the {@link Anchor} constants for convenience.
|
|
610
|
+
*/
|
|
611
|
+
get anchorLeft(): number { return _C(this, 3744, 0) as number; }
|
|
612
|
+
set anchorLeft(v: number) { _C(this, 1019, 0, v); }
|
|
613
|
+
|
|
614
|
+
/**
|
|
615
|
+
* Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top offset updates when the node moves or changes size. You can use one of the {@link Anchor} constants for convenience.
|
|
616
|
+
*/
|
|
617
|
+
get anchorTop(): number { return _C(this, 3744, 1) as number; }
|
|
618
|
+
set anchorTop(v: number) { _C(this, 1019, 1, v); }
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right offset updates when the node moves or changes size. You can use one of the {@link Anchor} constants for convenience.
|
|
622
|
+
*/
|
|
623
|
+
get anchorRight(): number { return _C(this, 3744, 2) as number; }
|
|
624
|
+
set anchorRight(v: number) { _C(this, 1019, 2, v); }
|
|
625
|
+
|
|
626
|
+
/**
|
|
627
|
+
* Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom offset updates when the node moves or changes size. You can use one of the {@link Anchor} constants for convenience.
|
|
628
|
+
*/
|
|
629
|
+
get anchorBottom(): number { return _C(this, 3744, 3) as number; }
|
|
630
|
+
set anchorBottom(v: number) { _C(this, 1019, 3, v); }
|
|
631
|
+
|
|
632
|
+
/**
|
|
633
|
+
* Distance between the node's left edge and its parent control, based on {@link anchorLeft}.
|
|
634
|
+
* 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.
|
|
635
|
+
*/
|
|
636
|
+
get offsetLeft(): number { return _C(this, 5703, 0) as number; }
|
|
637
|
+
set offsetLeft(v: number) { _C(this, 12170, 0, v); }
|
|
638
|
+
|
|
639
|
+
/**
|
|
640
|
+
* Distance between the node's top edge and its parent control, based on {@link anchorTop}.
|
|
641
|
+
* 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.
|
|
642
|
+
*/
|
|
643
|
+
get offsetTop(): number { return _C(this, 5703, 1) as number; }
|
|
644
|
+
set offsetTop(v: number) { _C(this, 12170, 1, v); }
|
|
645
|
+
|
|
646
|
+
/**
|
|
647
|
+
* Distance between the node's right edge and its parent control, based on {@link anchorRight}.
|
|
648
|
+
* 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.
|
|
649
|
+
*/
|
|
650
|
+
get offsetRight(): number { return _C(this, 5703, 2) as number; }
|
|
651
|
+
set offsetRight(v: number) { _C(this, 12170, 2, v); }
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* Distance between the node's bottom edge and its parent control, based on {@link anchorBottom}.
|
|
655
|
+
* 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.
|
|
656
|
+
*/
|
|
657
|
+
get offsetBottom(): number { return _C(this, 5703, 3) as number; }
|
|
658
|
+
set offsetBottom(v: number) { _C(this, 12170, 3, v); }
|
|
659
|
+
|
|
660
|
+
/**
|
|
661
|
+
* Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
|
|
662
|
+
*/
|
|
663
|
+
get growHorizontal(): GrowDirection { return _C(this, 5000) as GrowDirection; }
|
|
664
|
+
set growHorizontal(v: GrowDirection) { _C(this, 11585, v); }
|
|
665
|
+
|
|
666
|
+
/**
|
|
667
|
+
* Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
|
|
668
|
+
*/
|
|
669
|
+
get growVertical(): GrowDirection { return _C(this, 7011) as GrowDirection; }
|
|
670
|
+
set growVertical(v: GrowDirection) { _C(this, 13262, v); }
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* The size of the node's bounding rectangle, in the node's coordinate system. {@link Container} nodes update this property automatically.
|
|
674
|
+
*/
|
|
675
|
+
get size(): Vector2 { return _C(this, 6399) as Vector2; }
|
|
676
|
+
set size(v: Vector2) { _C(this, 1043, v); }
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* 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 pivotOffset}.
|
|
680
|
+
*/
|
|
681
|
+
get position(): Vector2 { return _C(this, 5973) as Vector2; }
|
|
682
|
+
set position(v: Vector2) { _C(this, 1039, v); }
|
|
683
|
+
|
|
684
|
+
/**
|
|
685
|
+
* The node's global position, relative to the world (usually to the {@link CanvasLayer}).
|
|
686
|
+
*/
|
|
687
|
+
get globalPosition(): Vector2 { return _C(this, 4929) as Vector2; }
|
|
688
|
+
set globalPosition(v: Vector2) { _C(this, 1028, v); }
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* The node's rotation around its pivot, in radians. See {@link pivotOffset} to change the pivot's position.
|
|
692
|
+
* **Note:** This property is edited in the inspector in degrees. If you want to use degrees in a script, use {@link rotationDegrees}.
|
|
693
|
+
*/
|
|
694
|
+
get rotation(): number { return _C(this, 6204) as number; }
|
|
695
|
+
set rotation(v: number) { _C(this, 12577, v); }
|
|
696
|
+
|
|
697
|
+
/**
|
|
698
|
+
* Helper property to access {@link rotation} in degrees instead of radians.
|
|
699
|
+
*/
|
|
700
|
+
get rotationDegrees(): number { return _C(this, 6209) as number; }
|
|
701
|
+
set rotationDegrees(v: number) { _C(this, 12582, v); }
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* The node's scale, relative to its {@link size}. Change this property to scale the node around its {@link pivotOffset}. The Control's tooltip will also scale according to this value.
|
|
705
|
+
* **Note:** This property is mainly intended to be used for animation purposes. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [documentation]($DOCS_URL/tutorials/rendering/multiple_resolutions.html) instead of scaling Controls individually.
|
|
706
|
+
* **Note:** {@link FontFile.oversampling} does *not* take {@link Control} {@link scale} into account. This means that scaling up/down will cause bitmap fonts and rasterized (non-MSDF) dynamic fonts to appear blurry or pixelated. To ensure text remains crisp regardless of scale, you can enable MSDF font rendering by enabling {@link ProjectSettings.gui/theme/defaultFontMultichannelSignedDistanceField} (applies to the default project font only), or enabling **Multichannel Signed Distance Field** in the import options of a DynamicFont for custom fonts. On system fonts, {@link SystemFont.multichannelSignedDistanceField} can be enabled in the inspector.
|
|
707
|
+
* **Note:** If the Control node is a child of a {@link Container} node, the scale will be reset to `Vector2(1, 1)` when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using `await get_tree().process_frame` then set its {@link scale} property.
|
|
708
|
+
*/
|
|
709
|
+
get scale(): Vector2 { return _C(this, 6236) as Vector2; }
|
|
710
|
+
set scale(v: Vector2) { _C(this, 12608, v); }
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* 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.
|
|
714
|
+
* The actual offset is the combined value of this property and {@link pivotOffsetRatio}.
|
|
715
|
+
*/
|
|
716
|
+
get pivotOffset(): Vector2 { return _C(this, 5911) as Vector2; }
|
|
717
|
+
set pivotOffset(v: Vector2) { _C(this, 12331, v); }
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* Same as {@link pivotOffset}, but expressed as uniform vector, where `Vector2(0, 0)` is the top-left corner of this control, and `Vector2(1, 1)` is its bottom-right corner. Set this property to `Vector2(0.5, 0.5)` to pivot around this control's center.
|
|
721
|
+
* The actual offset is the combined value of this property and {@link pivotOffset}.
|
|
722
|
+
*/
|
|
723
|
+
get pivotOffsetRatio(): Vector2 { return _C(this, 5912) as Vector2; }
|
|
724
|
+
set pivotOffsetRatio(v: Vector2) { _C(this, 12332, v); }
|
|
725
|
+
|
|
726
|
+
/**
|
|
727
|
+
* Tells the parent {@link Container} nodes how they should resize and place the node on the X axis. Use a combination of the {@link SizeFlags} constants to change the flags. See the constants to learn what each does.
|
|
728
|
+
*/
|
|
729
|
+
get sizeFlagsHorizontal(): SizeFlags { return _C(this, 5004) as SizeFlags; }
|
|
730
|
+
set sizeFlagsHorizontal(v: SizeFlags) { _C(this, 11589, v); }
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* Tells the parent {@link Container} nodes how they should resize and place the node on the Y axis. Use a combination of the {@link SizeFlags} constants to change the flags. See the constants to learn what each does.
|
|
734
|
+
*/
|
|
735
|
+
get sizeFlagsVertical(): SizeFlags { return _C(this, 7016) as SizeFlags; }
|
|
736
|
+
set sizeFlagsVertical(v: SizeFlags) { _C(this, 13267, v); }
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* If the node and at least one of its neighbors uses the {@link SIZE_EXPAND} size flag, the parent {@link Container} will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbor a ratio of 1, this node will take two thirds of the available space.
|
|
740
|
+
*/
|
|
741
|
+
get sizeFlagsStretchRatio(): number { return _C(this, 6570) as number; }
|
|
742
|
+
set sizeFlagsStretchRatio(v: number) { _C(this, 12908, v); }
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* If `true`, applies all offset transform properties. Otherwise, no offset transform is applied and the properties have no effect.
|
|
746
|
+
*/
|
|
747
|
+
get offsetTransformEnabled(): boolean { return _C(this, 8142) as boolean; }
|
|
748
|
+
set offsetTransformEnabled(v: boolean) { _C(this, 12172, v); }
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Position offset in absolute units. The final offset is the combined value of this property and {@link offsetTransformPositionRatio}.
|
|
752
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
753
|
+
*/
|
|
754
|
+
get offsetTransformPosition(): Vector2 { return _C(this, 5709) as Vector2; }
|
|
755
|
+
set offsetTransformPosition(v: Vector2) { _C(this, 12175, v); }
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* Same as {@link offsetTransformPosition} 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.
|
|
759
|
+
* The final offset is the combined value of this property and {@link offsetTransformPosition}.
|
|
760
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
761
|
+
*/
|
|
762
|
+
get offsetTransformPositionRatio(): Vector2 { return _C(this, 5710) as Vector2; }
|
|
763
|
+
set offsetTransformPositionRatio(v: Vector2) { _C(this, 12176, v); }
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* Scale offset. The scale pivot is defined by {@link offsetTransformPivot} and {@link offsetTransformPivotRatio}.
|
|
767
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
768
|
+
*/
|
|
769
|
+
get offsetTransformScale(): Vector2 { return _C(this, 5712) as Vector2; }
|
|
770
|
+
set offsetTransformScale(v: Vector2) { _C(this, 12178, v); }
|
|
771
|
+
|
|
772
|
+
/**
|
|
773
|
+
* Rotation offset. The rotation pivot is defined by {@link offsetTransformPivot} and {@link offsetTransformPivotRatio}.
|
|
774
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
775
|
+
*/
|
|
776
|
+
get offsetTransformRotation(): number { return _C(this, 5711) as number; }
|
|
777
|
+
set offsetTransformRotation(v: number) { _C(this, 12177, v); }
|
|
778
|
+
|
|
779
|
+
/**
|
|
780
|
+
* Pivot used by {@link offsetTransformRotation} and {@link offsetTransformScale} in absolute units.
|
|
781
|
+
* The final pivot position is the combined value of this property and {@link offsetTransformPivotRatio}.
|
|
782
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
783
|
+
*/
|
|
784
|
+
get offsetTransformPivot(): Vector2 { return _C(this, 5707) as Vector2; }
|
|
785
|
+
set offsetTransformPivot(v: Vector2) { _C(this, 12173, v); }
|
|
786
|
+
|
|
787
|
+
/**
|
|
788
|
+
* Same as {@link offsetTransformPivot} 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.
|
|
789
|
+
* The final pivot position is the combined value of this property and {@link offsetTransformPivot}.
|
|
790
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
791
|
+
*/
|
|
792
|
+
get offsetTransformPivotRatio(): Vector2 { return _C(this, 5708) as Vector2; }
|
|
793
|
+
set offsetTransformPivotRatio(v: Vector2) { _C(this, 12174, v); }
|
|
794
|
+
|
|
795
|
+
/**
|
|
796
|
+
* 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.
|
|
797
|
+
* If `false`, the entire transform of this Control is affected and input events will register where the Control is visually.
|
|
798
|
+
* Has no effect unless {@link offsetTransformEnabled} is `true`.
|
|
799
|
+
*/
|
|
800
|
+
get offsetTransformVisualOnly(): boolean { return _C(this, 8143) as boolean; }
|
|
801
|
+
set offsetTransformVisualOnly(v: boolean) { _C(this, 12179, v); }
|
|
802
|
+
|
|
803
|
+
/**
|
|
804
|
+
* If `true`, automatically converts code line numbers, list indices, {@link SpinBox} and {@link ProgressBar} values from the Western Arabic (0..9) to the numeral systems used in current locale.
|
|
805
|
+
* **Note:** Numbers within the text are not automatically converted, it can be done manually, using {@link TextServer.formatNumber}.
|
|
806
|
+
*/
|
|
807
|
+
get localizeNumeralSystem(): boolean { return _C(this, 8091) as boolean; }
|
|
808
|
+
set localizeNumeralSystem(v: boolean) { _C(this, 11943, v); }
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). See also {@link isLayoutRtl}.
|
|
812
|
+
*/
|
|
813
|
+
get layoutDirection(): LayoutDirection { return _C(this, 5329) as LayoutDirection; }
|
|
814
|
+
set layoutDirection(v: LayoutDirection) { _C(this, 11889, v); }
|
|
815
|
+
|
|
816
|
+
/**
|
|
817
|
+
* The translation context used when translating this control's displayed text, if it has any. Also used when generating translation templates.
|
|
818
|
+
*/
|
|
819
|
+
get translationContext(): StringName { return _C(this, 6892) as StringName; }
|
|
820
|
+
set translationContext(v: StringName) { _C(this, 13142, v); }
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* Toggles if any text should automatically change to its translated version depending on the current locale.
|
|
824
|
+
*/
|
|
825
|
+
get autoTranslate(): boolean { return _C(this, 7776) as boolean; }
|
|
826
|
+
set autoTranslate(v: boolean) { _C(this, 10581, v); }
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the {@link mouseFilter} property is not {@link MOUSE_FILTER_IGNORE}. The time required for the tooltip to appear can be changed with the {@link ProjectSettings.gui/timers/tooltipDelaySec} setting.
|
|
830
|
+
* This string is the default return value of {@link getTooltip}. Override {@link _getTooltip} to generate tooltip text dynamically. Override {@link _makeCustomTooltip} to customize the tooltip interface and behavior.
|
|
831
|
+
* The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding {@link _makeCustomTooltip}. 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:
|
|
832
|
+
*
|
|
833
|
+
*
|
|
834
|
+
* ```gdscript
|
|
835
|
+
*
|
|
836
|
+
* var style_box = StyleBoxFlat.new()
|
|
837
|
+
* style_box.set_bg_color(Color(1, 1, 0))
|
|
838
|
+
* style_box.set_border_width_all(2)
|
|
839
|
+
* # We assume here that the `theme` property has been assigned a custom Theme beforehand.
|
|
840
|
+
* theme.set_stylebox("panel", "TooltipPanel", style_box)
|
|
841
|
+
* theme.set_color("font_color", "TooltipLabel", Color(0, 1, 1))
|
|
842
|
+
*
|
|
843
|
+
* ```
|
|
844
|
+
*/
|
|
845
|
+
get tooltipText(): string { return _C(this, 6845) as string; }
|
|
846
|
+
set tooltipText(v: string) { _C(this, 13115, v); }
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Defines if tooltip text should automatically change to its translated version depending on the current locale. Uses the same auto translate mode as this control when set to {@link Node.AUTO_TRANSLATE_MODE_INHERIT}.
|
|
850
|
+
* **Note:** Tooltips customized using {@link _makeCustomTooltip} do not use this auto translate mode automatically.
|
|
851
|
+
*/
|
|
852
|
+
get tooltipAutoTranslateMode(): AutoTranslateMode { return _C(this, 6844) as AutoTranslateMode; }
|
|
853
|
+
set tooltipAutoTranslateMode(v: AutoTranslateMode) { _C(this, 13113, v); }
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
* Tells Godot which node it should give focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the {@link ProjectSettings.input/uiLeft} input action. The node must be a {@link Control}. If this property is not set, Godot will give focus to the closest {@link Control} to the left of this one.
|
|
857
|
+
*/
|
|
858
|
+
get focusNeighborLeft(): NodePath { return _C(this, 4824, 0) as NodePath; }
|
|
859
|
+
set focusNeighborLeft(v: NodePath) { _C(this, 11428, 0, v); }
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Tells Godot which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the {@link ProjectSettings.input/uiUp} input action. The node must be a {@link Control}. If this property is not set, Godot will give focus to the closest {@link Control} to the top of this one.
|
|
863
|
+
*/
|
|
864
|
+
get focusNeighborTop(): NodePath { return _C(this, 4824, 1) as NodePath; }
|
|
865
|
+
set focusNeighborTop(v: NodePath) { _C(this, 11428, 1, v); }
|
|
866
|
+
|
|
867
|
+
/**
|
|
868
|
+
* Tells Godot which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the {@link ProjectSettings.input/uiRight} input action. The node must be a {@link Control}. If this property is not set, Godot will give focus to the closest {@link Control} to the right of this one.
|
|
869
|
+
*/
|
|
870
|
+
get focusNeighborRight(): NodePath { return _C(this, 4824, 2) as NodePath; }
|
|
871
|
+
set focusNeighborRight(v: NodePath) { _C(this, 11428, 2, v); }
|
|
872
|
+
|
|
873
|
+
/**
|
|
874
|
+
* Tells Godot which node it should give focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the {@link ProjectSettings.input/uiDown} input action. The node must be a {@link Control}. If this property is not set, Godot will give focus to the closest {@link Control} to the bottom of this one.
|
|
875
|
+
*/
|
|
876
|
+
get focusNeighborBottom(): NodePath { return _C(this, 4824, 3) as NodePath; }
|
|
877
|
+
set focusNeighborBottom(v: NodePath) { _C(this, 11428, 3, v); }
|
|
878
|
+
|
|
879
|
+
/**
|
|
880
|
+
* Tells Godot which node it should give focus to if the user presses `Tab` on a keyboard by default. You can change the key by editing the {@link ProjectSettings.input/uiFocusNext} input action.
|
|
881
|
+
* If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
|
|
882
|
+
*/
|
|
883
|
+
get focusNext(): NodePath { return _C(this, 4825) as NodePath; }
|
|
884
|
+
set focusNext(v: NodePath) { _C(this, 11429, v); }
|
|
885
|
+
|
|
886
|
+
/**
|
|
887
|
+
* Tells Godot which node it should give focus to if the user presses `Shift + Tab` on a keyboard by default. You can change the key by editing the {@link ProjectSettings.input/uiFocusPrev} input action.
|
|
888
|
+
* If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
|
|
889
|
+
*/
|
|
890
|
+
get focusPrevious(): NodePath { return _C(this, 4826) as NodePath; }
|
|
891
|
+
set focusPrevious(v: NodePath) { _C(this, 11430, v); }
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* Determines which controls can be focused. Only one control can be focused at a time, and the focused control will receive keyboard, gamepad, and mouse events in {@link _guiInput}. Use {@link getFocusModeWithOverride} to determine if a control can grab focus, since {@link focusBehaviorRecursive} also affects it. See also {@link grabFocus}.
|
|
895
|
+
*/
|
|
896
|
+
get focusMode(): FocusMode { return _C(this, 4822) as FocusMode; }
|
|
897
|
+
set focusMode(v: FocusMode) { _C(this, 11427, v); }
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Determines which controls can be focused together with {@link focusMode}. See {@link getFocusModeWithOverride}. Since the default behavior is {@link FOCUS_BEHAVIOR_INHERITED}, this can be used to prevent all children controls from getting focused.
|
|
901
|
+
*/
|
|
902
|
+
get focusBehaviorRecursive(): FocusBehaviorRecursive { return _C(this, 4820) as FocusBehaviorRecursive; }
|
|
903
|
+
set focusBehaviorRecursive(v: FocusBehaviorRecursive) { _C(this, 11425, v); }
|
|
904
|
+
|
|
905
|
+
/**
|
|
906
|
+
* Determines which controls will be able to receive mouse button input events through {@link _guiInput} and the {@link mouse_entered}, and {@link mouse_exited} signals. Also determines how these events should be propagated. See the constants to learn what each does. Use {@link getMouseFilterWithOverride} to determine if a control can receive mouse input, since {@link mouseBehaviorRecursive} also affects it.
|
|
907
|
+
*/
|
|
908
|
+
get mouseFilter(): MouseFilter { return _C(this, 5587) as MouseFilter; }
|
|
909
|
+
set mouseFilter(v: MouseFilter) { _C(this, 12094, v); }
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
* Determines which controls can receive mouse input together with {@link mouseFilter}. See {@link getMouseFilterWithOverride}. Since the default behavior is {@link MOUSE_BEHAVIOR_INHERITED}, this can be used to prevent all children controls from receiving mouse input.
|
|
913
|
+
*/
|
|
914
|
+
get mouseBehaviorRecursive(): MouseBehaviorRecursive { return _C(this, 5585) as MouseBehaviorRecursive; }
|
|
915
|
+
set mouseBehaviorRecursive(v: MouseBehaviorRecursive) { _C(this, 12093, v); }
|
|
916
|
+
|
|
917
|
+
/**
|
|
918
|
+
* When enabled, scroll wheel events processed by {@link _guiInput} will be passed to the parent control even if {@link mouseFilter} is set to {@link MOUSE_FILTER_STOP}.
|
|
919
|
+
* You should disable it on the root of your UI if you do not want scroll events to go to the {@link Node.UnhandledInput} processing.
|
|
920
|
+
* **Note:** Because this property defaults to `true`, this allows nested scrollable containers to work out of the box.
|
|
921
|
+
*/
|
|
922
|
+
get mouseForcePassScrollEvents(): boolean { return _C(this, 7970) as boolean; }
|
|
923
|
+
set mouseForcePassScrollEvents(v: boolean) { _C(this, 11464, v); }
|
|
924
|
+
|
|
925
|
+
/**
|
|
926
|
+
* The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
|
|
927
|
+
* **Note:** On Linux, shapes may vary depending on the cursor theme of the system.
|
|
928
|
+
*/
|
|
929
|
+
get mouseDefaultCursorShape(): CursorShape { return _C(this, 4447) as CursorShape; }
|
|
930
|
+
set mouseDefaultCursorShape(v: CursorShape) { _C(this, 11060, v); }
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* The {@link Node} which must be a parent of the focused {@link Control} for the shortcut to be activated. If `null`, the shortcut can be activated when any control is focused (a global shortcut). This allows shortcuts to be accepted only when the user has a certain area of the GUI focused.
|
|
934
|
+
*/
|
|
935
|
+
get shortcutContext(): Node { return _C(this, 6378) as Node; }
|
|
936
|
+
set shortcutContext(v: Node) { _C(this, 12725, v); }
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* The human-readable node name that is reported to assistive apps.
|
|
940
|
+
*/
|
|
941
|
+
get accessibilityName(): string { return _C(this, 3673) as string; }
|
|
942
|
+
set accessibilityName(v: string) { _C(this, 10411, v); }
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* The human-readable node description that is reported to assistive apps.
|
|
946
|
+
*/
|
|
947
|
+
get accessibilityDescription(): string { return _C(this, 3668) as string; }
|
|
948
|
+
set accessibilityDescription(v: string) { _C(this, 10407, v); }
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* The mode with which a live region updates. A live region is a {@link Node} that is updated as a result of an external event when the user's focus may be elsewhere.
|
|
952
|
+
*/
|
|
953
|
+
get accessibilityLive(): AccessibilityLiveMode { return _C(this, 3672) as AccessibilityLiveMode; }
|
|
954
|
+
set accessibilityLive(v: AccessibilityLiveMode) { _C(this, 10410, v); }
|
|
955
|
+
|
|
956
|
+
/**
|
|
957
|
+
* The paths to the nodes which are controlled by this node.
|
|
958
|
+
*/
|
|
959
|
+
get accessibilityControlsNodes(): GodotArray<NodePath> { return _C(this, 3666) as GodotArray<NodePath>; }
|
|
960
|
+
set accessibilityControlsNodes(v: GodotArray<NodePath>) { _C(this, 10405, v); }
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* The paths to the nodes which are describing this node.
|
|
964
|
+
*/
|
|
965
|
+
get accessibilityDescribedByNodes(): GodotArray<NodePath> { return _C(this, 3667) as GodotArray<NodePath>; }
|
|
966
|
+
set accessibilityDescribedByNodes(v: GodotArray<NodePath>) { _C(this, 10406, v); }
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* The paths to the nodes which label this node.
|
|
970
|
+
*/
|
|
971
|
+
get accessibilityLabeledByNodes(): GodotArray<NodePath> { return _C(this, 3671) as GodotArray<NodePath>; }
|
|
972
|
+
set accessibilityLabeledByNodes(v: GodotArray<NodePath>) { _C(this, 10409, v); }
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* The paths to the nodes which this node flows into.
|
|
976
|
+
*/
|
|
977
|
+
get accessibilityFlowToNodes(): GodotArray<NodePath> { return _C(this, 3670) as GodotArray<NodePath>; }
|
|
978
|
+
set accessibilityFlowToNodes(v: GodotArray<NodePath>) { _C(this, 10408, v); }
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
* The {@link Theme} resource this node and all its {@link Control} and {@link Window} children use. If a child node has its own {@link Theme} resource set, theme items are merged with child's definitions having higher priority.
|
|
982
|
+
* **Note:** {@link Window} styles will have no effect unless the window is embedded.
|
|
983
|
+
*/
|
|
984
|
+
get theme(): Theme { return _C(this, 6759) as Theme; }
|
|
985
|
+
set theme(v: Theme) { _C(this, 13051, v); }
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* The name of a theme type variation used by this {@link Control} to look up its own theme items. When empty, the class name of the node is used (e.g. {@link code skip-lint}Button[/code] for the {@link Button} control), as well as the class names of all parent classes (in order of inheritance).
|
|
989
|
+
* When set, this property gives the highest priority to the type of the specified name. This type can in turn extend another type, forming a dependency chain. See {@link Theme.setTypeVariation}. If the theme item cannot be found using this type or its base types, lookup falls back on the class names.
|
|
990
|
+
* **Note:** To look up {@link Control}'s own items use various `get_theme_*` methods without specifying `theme_type`.
|
|
991
|
+
* **Note:** Theme items are looked for in the tree order, from branch to root, where each {@link Control} node is checked for its {@link theme} property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last.
|
|
992
|
+
*/
|
|
993
|
+
get themeTypeVariation(): StringName { return _C(this, 6772) as StringName; }
|
|
994
|
+
set themeTypeVariation(v: StringName) { _C(this, 13053, v); }
|
|
995
|
+
|
|
996
|
+
/**
|
|
997
|
+
* Sent when the node changes size. Use {@link size} to get the new size.
|
|
998
|
+
*/
|
|
999
|
+
static readonly NOTIFICATION_RESIZED = 40;
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* Sent when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1003
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect which Control receives the notification.
|
|
1004
|
+
* See also {@link NOTIFICATION_MOUSE_ENTER_SELF}.
|
|
1005
|
+
*/
|
|
1006
|
+
static readonly NOTIFICATION_MOUSE_ENTER = 41;
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* Sent when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1010
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect which Control receives the notification.
|
|
1011
|
+
* See also {@link NOTIFICATION_MOUSE_EXIT_SELF}.
|
|
1012
|
+
*/
|
|
1013
|
+
static readonly NOTIFICATION_MOUSE_EXIT = 42;
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* Sent when the mouse cursor enters the control's visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1017
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect which Control receives the notification.
|
|
1018
|
+
* See also {@link NOTIFICATION_MOUSE_ENTER}.
|
|
1019
|
+
*/
|
|
1020
|
+
static readonly NOTIFICATION_MOUSE_ENTER_SELF = 60;
|
|
1021
|
+
|
|
1022
|
+
/**
|
|
1023
|
+
* Sent when the mouse cursor leaves the control's visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1024
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect which Control receives the notification.
|
|
1025
|
+
* See also {@link NOTIFICATION_MOUSE_EXIT}.
|
|
1026
|
+
*/
|
|
1027
|
+
static readonly NOTIFICATION_MOUSE_EXIT_SELF = 61;
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* Sent when the node grabs focus.
|
|
1031
|
+
*/
|
|
1032
|
+
static readonly NOTIFICATION_FOCUS_ENTER = 43;
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* Sent when the node loses focus.
|
|
1036
|
+
* This notification is sent in reversed order.
|
|
1037
|
+
*/
|
|
1038
|
+
static readonly NOTIFICATION_FOCUS_EXIT = 44;
|
|
1039
|
+
|
|
1040
|
+
/**
|
|
1041
|
+
* Sent when the node needs to refresh its theme items. This happens in one of the following cases:
|
|
1042
|
+
* - The {@link theme} property is changed on this node or any of its ancestors.
|
|
1043
|
+
* - The {@link themeTypeVariation} property is changed on this node.
|
|
1044
|
+
* - One of the node's theme property overrides is changed.
|
|
1045
|
+
* - The node enters the scene tree.
|
|
1046
|
+
* **Note:** As an optimization, this notification won't be sent from changes that occur while this node is outside of the scene tree. Instead, all of the theme item updates can be applied at once when the node enters the scene tree.
|
|
1047
|
+
* **Note:** This notification is received alongside {@link Node.NOTIFICATION_ENTER_TREE}, so if you are instantiating a scene, the child nodes will not be initialized yet. You can use it to setup theming for this node, child nodes created from script, or if you want to access child nodes added in the editor, make sure the node is ready using {@link Node.isNodeReady}.
|
|
1048
|
+
*
|
|
1049
|
+
* ```text
|
|
1050
|
+
*
|
|
1051
|
+
* func _notification(what):
|
|
1052
|
+
* if what == NOTIFICATION_THEME_CHANGED:
|
|
1053
|
+
* if not is_node_ready():
|
|
1054
|
+
* await ready # Wait until ready signal.
|
|
1055
|
+
* $Label.add_theme_color_override("font_color", Color.YELLOW)
|
|
1056
|
+
*
|
|
1057
|
+
* ```
|
|
1058
|
+
*/
|
|
1059
|
+
static readonly NOTIFICATION_THEME_CHANGED = 45;
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* Sent when this node is inside a {@link ScrollContainer} which has begun being scrolled when dragging the scrollable area *with a touch event*. This notification is *not* sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
|
|
1063
|
+
* **Note:** This signal is only emitted on Android or iOS, or on desktop/web platforms when {@link ProjectSettings.inputDevices/pointing/emulateTouchFromMouse} is enabled.
|
|
1064
|
+
*/
|
|
1065
|
+
static readonly NOTIFICATION_SCROLL_BEGIN = 47;
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* Sent when this node is inside a {@link ScrollContainer} which has stopped being scrolled when dragging the scrollable area *with a touch event*. This notification is *not* sent when scrolling by dragging the scrollbar, scrolling with the mouse wheel or scrolling with keyboard/gamepad events.
|
|
1069
|
+
* **Note:** This signal is only emitted on Android or iOS, or on desktop/web platforms when {@link ProjectSettings.inputDevices/pointing/emulateTouchFromMouse} is enabled.
|
|
1070
|
+
*/
|
|
1071
|
+
static readonly NOTIFICATION_SCROLL_END = 48;
|
|
1072
|
+
|
|
1073
|
+
/**
|
|
1074
|
+
* Sent when the control layout direction is changed from LTR or RTL or vice versa. This notification is propagated to child Control nodes as result of a change to {@link layoutDirection}.
|
|
1075
|
+
*/
|
|
1076
|
+
static readonly NOTIFICATION_LAYOUT_DIRECTION_CHANGED = 49;
|
|
1077
|
+
|
|
1078
|
+
/**
|
|
1079
|
+
* Emitted when the control changes size.
|
|
1080
|
+
*/
|
|
1081
|
+
get resized(): Signal<() => void> { return _G(this, 10082) as Signal<() => void>; }
|
|
1082
|
+
set resized(v: (() => void) | null) { _G(this, 10082, v); }
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* Emitted when the node receives an {@link InputEvent}.
|
|
1086
|
+
*/
|
|
1087
|
+
get guiInput(): Signal<(event: InputEvent) => void> { return _G(this, 7322) as Signal<(event: InputEvent) => void>; }
|
|
1088
|
+
set guiInput(v: ((event: InputEvent) => void) | null) { _G(this, 7322, v); }
|
|
1089
|
+
|
|
1090
|
+
/**
|
|
1091
|
+
* Emitted when the mouse cursor enters the control's (or any child control's) visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1092
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect, which Control receives the signal.
|
|
1093
|
+
*/
|
|
1094
|
+
get mouseEntered(): Signal<() => void> { return _G(this, 8963) as Signal<() => void>; }
|
|
1095
|
+
set mouseEntered(v: (() => void) | null) { _G(this, 8963, v); }
|
|
1096
|
+
|
|
1097
|
+
/**
|
|
1098
|
+
* Emitted when the mouse cursor leaves the control's (and all child control's) visible area, that is not occluded behind other Controls or Windows, provided its {@link mouseFilter} lets the event reach it and regardless if it's currently focused or not.
|
|
1099
|
+
* **Note:** {@link CanvasItem.zIndex} doesn't affect, which Control receives the signal.
|
|
1100
|
+
* **Note:** If you want to check whether the mouse truly left the area, ignoring any top nodes, you can use code like this:
|
|
1101
|
+
*
|
|
1102
|
+
* ```text
|
|
1103
|
+
*
|
|
1104
|
+
* func _on_mouse_exited():
|
|
1105
|
+
* if not Rect2(Vector2(), size).has_point(get_local_mouse_position()):
|
|
1106
|
+
* # Not hovering over area.
|
|
1107
|
+
*
|
|
1108
|
+
* ```
|
|
1109
|
+
*/
|
|
1110
|
+
get mouseExited(): Signal<() => void> { return _G(this, 8964) as Signal<() => void>; }
|
|
1111
|
+
set mouseExited(v: (() => void) | null) { _G(this, 8964, v); }
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* Emitted when the node gains focus.
|
|
1115
|
+
*/
|
|
1116
|
+
get focusEntered(): Signal<() => void> { return _G(this, 3347) as Signal<() => void>; }
|
|
1117
|
+
set focusEntered(v: (() => void) | null) { _G(this, 3347, v); }
|
|
1118
|
+
|
|
1119
|
+
/**
|
|
1120
|
+
* Emitted when the node loses focus.
|
|
1121
|
+
*/
|
|
1122
|
+
get focusExited(): Signal<() => void> { return _G(this, 3348) as Signal<() => void>; }
|
|
1123
|
+
set focusExited(v: (() => void) | null) { _G(this, 3348, v); }
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
* Emitted when one of the size flags changes. See {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1127
|
+
*/
|
|
1128
|
+
get sizeFlagsChanged(): Signal<() => void> { return _G(this, 13612) as Signal<() => void>; }
|
|
1129
|
+
set sizeFlagsChanged(v: (() => void) | null) { _G(this, 13612, v); }
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* Emitted when the node's maximum size changes.
|
|
1133
|
+
*/
|
|
1134
|
+
get maximumSizeChanged(): Signal<() => void> { return _G(this, 8842) as Signal<() => void>; }
|
|
1135
|
+
set maximumSizeChanged(v: (() => void) | null) { _G(this, 8842, v); }
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* Emitted when the node's minimum size changes.
|
|
1139
|
+
*/
|
|
1140
|
+
get minimumSizeChanged(): Signal<() => void> { return _G(this, 8929) as Signal<() => void>; }
|
|
1141
|
+
set minimumSizeChanged(v: (() => void) | null) { _G(this, 8929, v); }
|
|
1142
|
+
|
|
1143
|
+
/**
|
|
1144
|
+
* Emitted when the {@link NOTIFICATION_THEME_CHANGED} notification is sent.
|
|
1145
|
+
*/
|
|
1146
|
+
get themeChanged(): Signal<() => void> { return _G(this, 14239) as Signal<() => void>; }
|
|
1147
|
+
set themeChanged(v: (() => void) | null) { _G(this, 14239, v); }
|
|
1148
|
+
|
|
1149
|
+
static readonly name = _R(226, Control);
|
|
1150
|
+
}
|
|
1151
|
+
|
|
1152
|
+
export const FocusMode = {
|
|
1153
|
+
/**
|
|
1154
|
+
* The node cannot grab focus. Use with {@link focusMode}.
|
|
1155
|
+
*/
|
|
1156
|
+
FOCUS_NONE: 0,
|
|
1157
|
+
/**
|
|
1158
|
+
* The node can only grab focus on mouse clicks. Use with {@link focusMode}.
|
|
1159
|
+
*/
|
|
1160
|
+
FOCUS_CLICK: 1,
|
|
1161
|
+
/**
|
|
1162
|
+
* The node can grab focus on mouse click, using the arrows and the Tab keys on the keyboard, or using the D-pad buttons on a gamepad. Use with {@link focusMode}.
|
|
1163
|
+
*/
|
|
1164
|
+
FOCUS_ALL: 2,
|
|
1165
|
+
/**
|
|
1166
|
+
* The node can grab focus only when screen reader is active. Use with {@link focusMode}.
|
|
1167
|
+
*/
|
|
1168
|
+
FOCUS_ACCESSIBILITY: 3,
|
|
1169
|
+
} as const;
|
|
1170
|
+
|
|
1171
|
+
export type FocusMode = (typeof FocusMode)[keyof typeof FocusMode];
|
|
1172
|
+
|
|
1173
|
+
export const FocusBehaviorRecursive = {
|
|
1174
|
+
/**
|
|
1175
|
+
* Inherits the {@link focusBehaviorRecursive} from the parent control. If there is no parent control, this is the same as {@link FOCUS_BEHAVIOR_ENABLED}.
|
|
1176
|
+
*/
|
|
1177
|
+
FOCUS_BEHAVIOR_INHERITED: 0,
|
|
1178
|
+
/**
|
|
1179
|
+
* Prevents the control from getting focused. {@link getFocusModeWithOverride} will return {@link FOCUS_NONE}.
|
|
1180
|
+
*/
|
|
1181
|
+
FOCUS_BEHAVIOR_DISABLED: 1,
|
|
1182
|
+
/**
|
|
1183
|
+
* Allows the control to be focused, depending on the {@link focusMode}. This can be used to ignore the parent's {@link focusBehaviorRecursive}. {@link getFocusModeWithOverride} will return the {@link focusMode}.
|
|
1184
|
+
*/
|
|
1185
|
+
FOCUS_BEHAVIOR_ENABLED: 2,
|
|
1186
|
+
} as const;
|
|
1187
|
+
|
|
1188
|
+
export type FocusBehaviorRecursive = (typeof FocusBehaviorRecursive)[keyof typeof FocusBehaviorRecursive];
|
|
1189
|
+
|
|
1190
|
+
export const MouseBehaviorRecursive = {
|
|
1191
|
+
/**
|
|
1192
|
+
* Inherits the {@link mouseBehaviorRecursive} from the parent control. If there is no parent control, this is the same as {@link MOUSE_BEHAVIOR_ENABLED}.
|
|
1193
|
+
*/
|
|
1194
|
+
MOUSE_BEHAVIOR_INHERITED: 0,
|
|
1195
|
+
/**
|
|
1196
|
+
* Prevents the control from receiving mouse input. {@link getMouseFilterWithOverride} will return {@link MOUSE_FILTER_IGNORE}.
|
|
1197
|
+
*/
|
|
1198
|
+
MOUSE_BEHAVIOR_DISABLED: 1,
|
|
1199
|
+
/**
|
|
1200
|
+
* Allows the control to receive mouse input, depending on the {@link mouseFilter}. This can be used to ignore the parent's {@link mouseBehaviorRecursive}. {@link getMouseFilterWithOverride} will return the {@link mouseFilter}.
|
|
1201
|
+
*/
|
|
1202
|
+
MOUSE_BEHAVIOR_ENABLED: 2,
|
|
1203
|
+
} as const;
|
|
1204
|
+
|
|
1205
|
+
export type MouseBehaviorRecursive = (typeof MouseBehaviorRecursive)[keyof typeof MouseBehaviorRecursive];
|
|
1206
|
+
|
|
1207
|
+
export const CursorShape = {
|
|
1208
|
+
/**
|
|
1209
|
+
* Show the system's arrow mouse cursor when the user hovers the node. Use with {@link mouseDefaultCursorShape}.
|
|
1210
|
+
*/
|
|
1211
|
+
CURSOR_ARROW: 0,
|
|
1212
|
+
/**
|
|
1213
|
+
* Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text.
|
|
1214
|
+
*/
|
|
1215
|
+
CURSOR_IBEAM: 1,
|
|
1216
|
+
/**
|
|
1217
|
+
* Show the system's pointing hand mouse cursor when the user hovers the node.
|
|
1218
|
+
*/
|
|
1219
|
+
CURSOR_POINTING_HAND: 2,
|
|
1220
|
+
/**
|
|
1221
|
+
* Show the system's cross mouse cursor when the user hovers the node.
|
|
1222
|
+
*/
|
|
1223
|
+
CURSOR_CROSS: 3,
|
|
1224
|
+
/**
|
|
1225
|
+
* Show the system's wait mouse cursor when the user hovers the node. Often an hourglass.
|
|
1226
|
+
*/
|
|
1227
|
+
CURSOR_WAIT: 4,
|
|
1228
|
+
/**
|
|
1229
|
+
* Show the system's busy mouse cursor when the user hovers the node. Often an arrow with a small hourglass.
|
|
1230
|
+
*/
|
|
1231
|
+
CURSOR_BUSY: 5,
|
|
1232
|
+
/**
|
|
1233
|
+
* Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock.
|
|
1234
|
+
*/
|
|
1235
|
+
CURSOR_DRAG: 6,
|
|
1236
|
+
/**
|
|
1237
|
+
* Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock.
|
|
1238
|
+
*/
|
|
1239
|
+
CURSOR_CAN_DROP: 7,
|
|
1240
|
+
/**
|
|
1241
|
+
* Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle.
|
|
1242
|
+
*/
|
|
1243
|
+
CURSOR_FORBIDDEN: 8,
|
|
1244
|
+
/**
|
|
1245
|
+
* Show the system's vertical resize mouse cursor when the user hovers the node. A double-headed vertical arrow. It tells the user they can resize the window or the panel vertically.
|
|
1246
|
+
*/
|
|
1247
|
+
CURSOR_VSIZE: 9,
|
|
1248
|
+
/**
|
|
1249
|
+
* Show the system's horizontal resize mouse cursor when the user hovers the node. A double-headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
|
|
1250
|
+
*/
|
|
1251
|
+
CURSOR_HSIZE: 10,
|
|
1252
|
+
/**
|
|
1253
|
+
* Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically.
|
|
1254
|
+
*/
|
|
1255
|
+
CURSOR_BDIAGSIZE: 11,
|
|
1256
|
+
/**
|
|
1257
|
+
* Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the top left to the bottom right, the opposite of {@link CURSOR_BDIAGSIZE}. It tells the user they can resize the window or the panel both horizontally and vertically.
|
|
1258
|
+
*/
|
|
1259
|
+
CURSOR_FDIAGSIZE: 12,
|
|
1260
|
+
/**
|
|
1261
|
+
* Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely.
|
|
1262
|
+
*/
|
|
1263
|
+
CURSOR_MOVE: 13,
|
|
1264
|
+
/**
|
|
1265
|
+
* Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as {@link CURSOR_VSIZE}.
|
|
1266
|
+
*/
|
|
1267
|
+
CURSOR_VSPLIT: 14,
|
|
1268
|
+
/**
|
|
1269
|
+
* Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as {@link CURSOR_HSIZE}.
|
|
1270
|
+
*/
|
|
1271
|
+
CURSOR_HSPLIT: 15,
|
|
1272
|
+
/**
|
|
1273
|
+
* Show the system's help mouse cursor when the user hovers the node, a question mark.
|
|
1274
|
+
*/
|
|
1275
|
+
CURSOR_HELP: 16,
|
|
1276
|
+
} as const;
|
|
1277
|
+
|
|
1278
|
+
export type CursorShape = (typeof CursorShape)[keyof typeof CursorShape];
|
|
1279
|
+
|
|
1280
|
+
export const LayoutPreset = {
|
|
1281
|
+
/**
|
|
1282
|
+
* Snap all 4 anchors to the top-left of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1283
|
+
*/
|
|
1284
|
+
PRESET_TOP_LEFT: 0,
|
|
1285
|
+
/**
|
|
1286
|
+
* Snap all 4 anchors to the top-right of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1287
|
+
*/
|
|
1288
|
+
PRESET_TOP_RIGHT: 1,
|
|
1289
|
+
/**
|
|
1290
|
+
* Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1291
|
+
*/
|
|
1292
|
+
PRESET_BOTTOM_LEFT: 2,
|
|
1293
|
+
/**
|
|
1294
|
+
* Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1295
|
+
*/
|
|
1296
|
+
PRESET_BOTTOM_RIGHT: 3,
|
|
1297
|
+
/**
|
|
1298
|
+
* Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1299
|
+
*/
|
|
1300
|
+
PRESET_CENTER_LEFT: 4,
|
|
1301
|
+
/**
|
|
1302
|
+
* Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1303
|
+
*/
|
|
1304
|
+
PRESET_CENTER_TOP: 5,
|
|
1305
|
+
/**
|
|
1306
|
+
* Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1307
|
+
*/
|
|
1308
|
+
PRESET_CENTER_RIGHT: 6,
|
|
1309
|
+
/**
|
|
1310
|
+
* Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1311
|
+
*/
|
|
1312
|
+
PRESET_CENTER_BOTTOM: 7,
|
|
1313
|
+
/**
|
|
1314
|
+
* Snap all 4 anchors to the center of the parent control's bounds. Use with {@link setAnchorsPreset}.
|
|
1315
|
+
*/
|
|
1316
|
+
PRESET_CENTER: 8,
|
|
1317
|
+
/**
|
|
1318
|
+
* Snap all 4 anchors to the left edge of the parent control. The left offset becomes relative to the left edge and the top offset relative to the top left corner of the node's parent. Use with {@link setAnchorsPreset}.
|
|
1319
|
+
*/
|
|
1320
|
+
PRESET_LEFT_WIDE: 9,
|
|
1321
|
+
/**
|
|
1322
|
+
* Snap all 4 anchors to the top edge of the parent control. The left offset becomes relative to the top left corner, the top offset relative to the top edge, and the right offset relative to the top right corner of the node's parent. Use with {@link setAnchorsPreset}.
|
|
1323
|
+
*/
|
|
1324
|
+
PRESET_TOP_WIDE: 10,
|
|
1325
|
+
/**
|
|
1326
|
+
* Snap all 4 anchors to the right edge of the parent control. The right offset becomes relative to the right edge and the top offset relative to the top right corner of the node's parent. Use with {@link setAnchorsPreset}.
|
|
1327
|
+
*/
|
|
1328
|
+
PRESET_RIGHT_WIDE: 11,
|
|
1329
|
+
/**
|
|
1330
|
+
* Snap all 4 anchors to the bottom edge of the parent control. The left offset becomes relative to the bottom left corner, the bottom offset relative to the bottom edge, and the right offset relative to the bottom right corner of the node's parent. Use with {@link setAnchorsPreset}.
|
|
1331
|
+
*/
|
|
1332
|
+
PRESET_BOTTOM_WIDE: 12,
|
|
1333
|
+
/**
|
|
1334
|
+
* Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with {@link setAnchorsPreset}.
|
|
1335
|
+
*/
|
|
1336
|
+
PRESET_VCENTER_WIDE: 13,
|
|
1337
|
+
/**
|
|
1338
|
+
* Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with {@link setAnchorsPreset}.
|
|
1339
|
+
*/
|
|
1340
|
+
PRESET_HCENTER_WIDE: 14,
|
|
1341
|
+
/**
|
|
1342
|
+
* Snap all 4 anchors to the respective corners of the parent control. Set all 4 offsets to 0 after you applied this preset and the {@link Control} will fit its parent control. Use with {@link setAnchorsPreset}.
|
|
1343
|
+
*/
|
|
1344
|
+
PRESET_FULL_RECT: 15,
|
|
1345
|
+
} as const;
|
|
1346
|
+
|
|
1347
|
+
export type LayoutPreset = (typeof LayoutPreset)[keyof typeof LayoutPreset];
|
|
1348
|
+
|
|
1349
|
+
export const LayoutPresetMode = {
|
|
1350
|
+
/**
|
|
1351
|
+
* The control will be resized to its minimum size.
|
|
1352
|
+
*/
|
|
1353
|
+
PRESET_MODE_MINSIZE: 0,
|
|
1354
|
+
/**
|
|
1355
|
+
* The control's width will not change.
|
|
1356
|
+
*/
|
|
1357
|
+
PRESET_MODE_KEEP_WIDTH: 1,
|
|
1358
|
+
/**
|
|
1359
|
+
* The control's height will not change.
|
|
1360
|
+
*/
|
|
1361
|
+
PRESET_MODE_KEEP_HEIGHT: 2,
|
|
1362
|
+
/**
|
|
1363
|
+
* The control's size will not change.
|
|
1364
|
+
*/
|
|
1365
|
+
PRESET_MODE_KEEP_SIZE: 3,
|
|
1366
|
+
} as const;
|
|
1367
|
+
|
|
1368
|
+
export type LayoutPresetMode = (typeof LayoutPresetMode)[keyof typeof LayoutPresetMode];
|
|
1369
|
+
|
|
1370
|
+
export const SizeFlags = {
|
|
1371
|
+
/**
|
|
1372
|
+
* Tells the parent {@link Container} to align the node with its start, either the top or the left edge. It is mutually exclusive with {@link SIZE_FILL} and other shrink size flags, but can be used with {@link SIZE_EXPAND} in some containers. Use with {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1373
|
+
* **Note:** Setting this flag is equal to not having any size flags.
|
|
1374
|
+
*/
|
|
1375
|
+
SIZE_SHRINK_BEGIN: 0,
|
|
1376
|
+
/**
|
|
1377
|
+
* Tells the parent {@link Container} to expand the bounds of this node to fill all the available space without pushing any other node. It is mutually exclusive with shrink size flags. Use with {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1378
|
+
*/
|
|
1379
|
+
SIZE_FILL: 1,
|
|
1380
|
+
/**
|
|
1381
|
+
* Tells the parent {@link Container} to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See {@link sizeFlagsStretchRatio}. Use with {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1382
|
+
*/
|
|
1383
|
+
SIZE_EXPAND: 2,
|
|
1384
|
+
/**
|
|
1385
|
+
* Sets the node's size flags to both fill and expand. See {@link SIZE_FILL} and {@link SIZE_EXPAND} for more information.
|
|
1386
|
+
*/
|
|
1387
|
+
SIZE_EXPAND_FILL: 3,
|
|
1388
|
+
/**
|
|
1389
|
+
* Tells the parent {@link Container} to center the node in the available space. It is mutually exclusive with {@link SIZE_FILL} and other shrink size flags, but can be used with {@link SIZE_EXPAND} in some containers. Use with {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1390
|
+
*/
|
|
1391
|
+
SIZE_SHRINK_CENTER: 4,
|
|
1392
|
+
/**
|
|
1393
|
+
* Tells the parent {@link Container} to align the node with its end, either the bottom or the right edge. It is mutually exclusive with {@link SIZE_FILL} and other shrink size flags, but can be used with {@link SIZE_EXPAND} in some containers. Use with {@link sizeFlagsHorizontal} and {@link sizeFlagsVertical}.
|
|
1394
|
+
*/
|
|
1395
|
+
SIZE_SHRINK_END: 8,
|
|
1396
|
+
} as const;
|
|
1397
|
+
|
|
1398
|
+
export type SizeFlags = (typeof SizeFlags)[keyof typeof SizeFlags];
|
|
1399
|
+
|
|
1400
|
+
export const MouseFilter = {
|
|
1401
|
+
/**
|
|
1402
|
+
* The control will receive mouse movement input events and mouse button input events if clicked on through {@link _guiInput}. The control will also receive the {@link mouse_entered} and {@link mouse_exited} signals. These events are automatically marked as handled, and they will not propagate further to other controls. This also results in blocking signals in other controls.
|
|
1403
|
+
*/
|
|
1404
|
+
MOUSE_FILTER_STOP: 0,
|
|
1405
|
+
/**
|
|
1406
|
+
* The control will receive mouse movement input events and mouse button input events if clicked on through {@link _guiInput}. The control will also receive the {@link mouse_entered} and {@link mouse_exited} signals.
|
|
1407
|
+
* If this control does not handle the event, the event will propagate up to its parent control if it has one. The event is bubbled up the node hierarchy until it reaches a non-{@link CanvasItem}, a control with {@link MOUSE_FILTER_STOP}, or a {@link CanvasItem} with {@link CanvasItem.topLevel} enabled. This will allow signals to fire in all controls it reaches. If no control handled it, the event will be passed to {@link Node.ShortcutInput} for further processing.
|
|
1408
|
+
*/
|
|
1409
|
+
MOUSE_FILTER_PASS: 1,
|
|
1410
|
+
/**
|
|
1411
|
+
* The control will not receive any mouse movement input events nor mouse button input events through {@link _guiInput}. The control will also not receive the {@link mouse_entered} nor {@link mouse_exited} signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically. If a child has {@link MOUSE_FILTER_PASS} and an event was passed to this control, the event will further propagate up to the control's parent.
|
|
1412
|
+
* **Note:** If the control has received {@link mouse_entered} but not {@link mouse_exited}, changing the {@link mouseFilter} to {@link MOUSE_FILTER_IGNORE} will cause {@link mouse_exited} to be emitted.
|
|
1413
|
+
*/
|
|
1414
|
+
MOUSE_FILTER_IGNORE: 2,
|
|
1415
|
+
} as const;
|
|
1416
|
+
|
|
1417
|
+
export type MouseFilter = (typeof MouseFilter)[keyof typeof MouseFilter];
|
|
1418
|
+
|
|
1419
|
+
export const GrowDirection = {
|
|
1420
|
+
/**
|
|
1421
|
+
* The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis.
|
|
1422
|
+
*/
|
|
1423
|
+
GROW_DIRECTION_BEGIN: 0,
|
|
1424
|
+
/**
|
|
1425
|
+
* The control will grow to the right or bottom to make up if its minimum size is changed to be greater than its current size on the respective axis.
|
|
1426
|
+
*/
|
|
1427
|
+
GROW_DIRECTION_END: 1,
|
|
1428
|
+
/**
|
|
1429
|
+
* The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size.
|
|
1430
|
+
*/
|
|
1431
|
+
GROW_DIRECTION_BOTH: 2,
|
|
1432
|
+
} as const;
|
|
1433
|
+
|
|
1434
|
+
export type GrowDirection = (typeof GrowDirection)[keyof typeof GrowDirection];
|
|
1435
|
+
|
|
1436
|
+
export const Anchor = {
|
|
1437
|
+
/**
|
|
1438
|
+
* Snaps one of the 4 anchor's sides to the origin of the node's `Rect`, in the top left. Use it with one of the `anchor_*` member variables, like {@link anchorLeft}. To change all 4 anchors at once, use {@link setAnchorsPreset}.
|
|
1439
|
+
*/
|
|
1440
|
+
ANCHOR_BEGIN: 0,
|
|
1441
|
+
/**
|
|
1442
|
+
* Snaps one of the 4 anchor's sides to the end of the node's `Rect`, in the bottom right. Use it with one of the `anchor_*` member variables, like {@link anchorLeft}. To change all 4 anchors at once, use {@link setAnchorsPreset}.
|
|
1443
|
+
*/
|
|
1444
|
+
ANCHOR_END: 1,
|
|
1445
|
+
} as const;
|
|
1446
|
+
|
|
1447
|
+
export type Anchor = (typeof Anchor)[keyof typeof Anchor];
|
|
1448
|
+
|
|
1449
|
+
export const LayoutDirection = {
|
|
1450
|
+
/**
|
|
1451
|
+
* Automatic layout direction, determined from the parent control layout direction.
|
|
1452
|
+
*/
|
|
1453
|
+
LAYOUT_DIRECTION_INHERITED: 0,
|
|
1454
|
+
/**
|
|
1455
|
+
* Automatic layout direction, determined from the current locale. Right-to-left layout direction is automatically used for languages that require it such as Arabic and Hebrew, but only if a valid translation file is loaded for the given language (unless said language is configured as a fallback in {@link ProjectSettings.internationalization/locale/fallback}). For all other languages (or if no valid translation file is found by Godot), left-to-right layout direction is used. If using {@link TextServerFallback} ({@link ProjectSettings.internationalization/rendering/textDriver}), left-to-right layout direction is always used regardless of the language. Right-to-left layout direction can also be forced using {@link ProjectSettings.internationalization/rendering/forceRightToLeftLayoutDirection}.
|
|
1456
|
+
*/
|
|
1457
|
+
LAYOUT_DIRECTION_APPLICATION_LOCALE: 1,
|
|
1458
|
+
/**
|
|
1459
|
+
* Left-to-right layout direction.
|
|
1460
|
+
*/
|
|
1461
|
+
LAYOUT_DIRECTION_LTR: 2,
|
|
1462
|
+
/**
|
|
1463
|
+
* Right-to-left layout direction.
|
|
1464
|
+
*/
|
|
1465
|
+
LAYOUT_DIRECTION_RTL: 3,
|
|
1466
|
+
/**
|
|
1467
|
+
* Automatic layout direction, determined from the system locale. Right-to-left layout direction is automatically used for languages that require it such as Arabic and Hebrew, but only if a valid translation file is loaded for the given language. For all other languages (or if no valid translation file is found by Godot), left-to-right layout direction is used. If using {@link TextServerFallback} ({@link ProjectSettings.internationalization/rendering/textDriver}), left-to-right layout direction is always used regardless of the language.
|
|
1468
|
+
*/
|
|
1469
|
+
LAYOUT_DIRECTION_SYSTEM_LOCALE: 4,
|
|
1470
|
+
/**
|
|
1471
|
+
* Represents the size of the {@link LayoutDirection} enum.
|
|
1472
|
+
*/
|
|
1473
|
+
LAYOUT_DIRECTION_MAX: 5,
|
|
1474
|
+
LAYOUT_DIRECTION_LOCALE: 1,
|
|
1475
|
+
} as const;
|
|
1476
|
+
|
|
1477
|
+
export type LayoutDirection = (typeof LayoutDirection)[keyof typeof LayoutDirection];
|
|
1478
|
+
|
|
1479
|
+
export const TextDirection = {
|
|
1480
|
+
/**
|
|
1481
|
+
* Text writing direction is the same as layout direction.
|
|
1482
|
+
*/
|
|
1483
|
+
TEXT_DIRECTION_INHERITED: 3,
|
|
1484
|
+
/**
|
|
1485
|
+
* Automatic text writing direction, determined from the current locale and text content.
|
|
1486
|
+
*/
|
|
1487
|
+
TEXT_DIRECTION_AUTO: 0,
|
|
1488
|
+
/**
|
|
1489
|
+
* Left-to-right text writing direction.
|
|
1490
|
+
*/
|
|
1491
|
+
TEXT_DIRECTION_LTR: 1,
|
|
1492
|
+
/**
|
|
1493
|
+
* Right-to-left text writing direction.
|
|
1494
|
+
*/
|
|
1495
|
+
TEXT_DIRECTION_RTL: 2,
|
|
1496
|
+
} as const;
|
|
1497
|
+
|
|
1498
|
+
export type TextDirection = (typeof TextDirection)[keyof typeof TextDirection];
|
|
1499
|
+
|