diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 99aa3499467..c0027f471a7 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -674,7 +674,7 @@ - Sets the update mode (see [enum UpdateMode]) of a value track. + Sets the update mode of a value track. diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 838aab1ac4e..5a264242329 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -92,8 +92,8 @@ - Blend an animation by [param blend] amount (name must be valid in the linked [AnimationPlayer]). A [param time] and [param delta] may be passed, as well as whether [param seeked] happened. - A [param looped_flag] is used by internal processing immediately after the loop. See also [enum Animation.LoopedFlag]. + Blends an animation by [param blend] amount (name must be valid in the linked [AnimationPlayer]). A [param time] and [param delta] may be passed, as well as whether [param seeked] happened. + A [param looped_flag] is used by internal processing immediately after the loop. @@ -107,7 +107,7 @@ - Blend an input. This is only useful for animation nodes created for an [AnimationNodeBlendTree]. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options). + Blends an input. This is only useful for animation nodes created for an [AnimationNodeBlendTree]. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed. diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index c13a7784f78..792eb652e25 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -67,7 +67,7 @@ - Controls the interpolation between animations. See [enum BlendMode] constants. + Controls the interpolation between animations. The blend space's axis's upper limit for the points' position. See [method add_blend_point]. diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index da79e15be15..365887383a8 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -102,7 +102,7 @@ If [code]true[/code], the blend space is triangulated automatically. The mesh updates every time you add or remove points with [method add_blend_point] and [method remove_blend_point]. - Controls the interpolation between animations. See [enum BlendMode] constants. + Controls the interpolation between animations. The blend space's X and Y axes' upper limit for the points' position. See [method add_blend_point]. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 61a103f20da..a89d8f75361 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -67,7 +67,7 @@ See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. - Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for angular damping calculations within this area. The name of the area's audio bus. @@ -92,14 +92,14 @@ The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance. - Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for gravity calculations within this area. The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. - Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for linear damping calculations within this area. If [code]true[/code], other monitoring areas can detect this area. diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index aac98593ff2..58c7e7386e8 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -67,7 +67,7 @@ See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. - Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for angular damping calculations within this area. The name of the area's audio bus. @@ -92,14 +92,14 @@ The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance. - Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for gravity calculations within this area. The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. - Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + Override mode for linear damping calculations within this area. If [code]true[/code], other monitoring areas can detect this area. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 01d0d105005..3020a43c493 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -207,7 +207,7 @@ - Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. + The blend shape mode. Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices. diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index ed0a0c5b08a..6db9fac25ec 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -36,7 +36,7 @@ - Specifies the format in which the sample will be recorded. See [enum AudioStreamWAV.Format] for available formats. + Specifies the format in which the sample will be recorded. diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml index 833ccafa6f7..ab9106f53d7 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml @@ -18,7 +18,7 @@ Returns the magnitude of the frequencies from [param from_hz] to [param to_hz] in linear energy as a Vector2. The [code]x[/code] component of the return value represents the left stereo channel, and [code]y[/code] represents the right channel. - [param mode] determines how the frequency range will be processed. See [enum MagnitudeMode]. + [param mode] determines how the frequency range will be processed. diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 142b41b49c0..dae089ea9f1 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -70,7 +70,7 @@ The maximum number of sounds this node can play at the same time. Calling [method play] after this value is reached will cut off the oldest sounds. - The mix target channels, as one of the [enum MixTarget] constants. Has no effect when two speakers or less are detected (see [enum AudioServer.SpeakerMode]). + The mix target channels. Has no effect when two speakers or less are detected (see [enum AudioServer.SpeakerMode]). The audio's pitch and tempo, as a multiplier of the [member stream]'s sample rate. A value of [code]2.0[/code] doubles the audio's pitch, while a value of [code]0.5[/code] halves the pitch. diff --git a/doc/classes/AudioStreamWAV.xml b/doc/classes/AudioStreamWAV.xml index 7440b558c1c..a848a6b9ca6 100644 --- a/doc/classes/AudioStreamWAV.xml +++ b/doc/classes/AudioStreamWAV.xml @@ -60,7 +60,7 @@ [b]Note:[/b] If [member format] is set to [constant FORMAT_QOA], this property expects data from a full QOA file. - Audio format. See [enum Format] constants for values. + Audio format. The loop start point (in number of samples, relative to the beginning of the stream). @@ -69,7 +69,7 @@ The loop end point (in number of samples, relative to the beginning of the stream). - The loop mode. See [enum LoopMode] constants for values. + The loop mode. The sample rate for mixing this audio. Higher values require more storage space, but result in better quality. diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml index eb657653124..991569f719a 100644 --- a/doc/classes/BackBufferCopy.xml +++ b/doc/classes/BackBufferCopy.xml @@ -12,7 +12,7 @@ - Buffer mode. See [enum CopyMode] constants. + Buffer mode. The area covered by the [BackBufferCopy]. Only used if [member copy_mode] is [constant COPY_MODE_RECT]. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 13b23d70b76..1ce32843923 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -45,7 +45,7 @@ - Determines when the button is considered clicked, one of the [enum ActionMode] constants. + Determines when the button is considered clicked. The [ButtonGroup] associated with the button. Not to be confused with node groups. diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index c2917c47b54..6fd43967451 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -21,7 +21,7 @@ - Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options. + Returns [code]true[/code] if the specified flag is enabled. @@ -44,7 +44,7 @@ - If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options. + If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. @@ -52,7 +52,7 @@ - Sets the texture for the slot specified by [param param]. See [enum TextureParam] for available slots. + Sets the texture for the slot specified by [param param]. @@ -76,7 +76,7 @@ Threshold at which antialiasing will be applied on the alpha channel. - The type of alpha antialiasing to apply. See [enum AlphaAntiAliasing]. + The type of alpha antialiasing to apply. The hashing scale for Alpha Hash. Recommended values between [code]0[/code] and [code]2[/code]. @@ -133,12 +133,12 @@ If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when [member billboard_mode] is not [constant BILLBOARD_DISABLED]. - Controls how the object faces the camera. See [enum BillboardMode]. + Controls how the object faces the camera. [b]Note:[/b] Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See [url=https://github.com/godotengine/godot/issues/41567]GitHub issue #41567[/url] for details. The material's blend mode. - [b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode]. + [b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. Sets the strength of the clearcoat effect. Setting to [code]0[/code] looks the same as disabling the clearcoat effect. @@ -154,17 +154,17 @@ Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel. - Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera. See [enum CullMode]. + Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera. - Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member transparency]. + Determines when depth rendering takes place. See also [member transparency]. Texture that specifies the color of the detail overlay. [member detail_albedo]'s alpha channel is used as a mask, even when the material is opaque. To use a dedicated texture as a mask, see [member detail_mask]. [b]Note:[/b] [member detail_albedo] is [i]not[/i] modulated by [member albedo_color]. - Specifies how the [member detail_albedo] should blend with the current [code]ALBEDO[/code]. See [enum BlendMode] for options. + Specifies how the [member detail_albedo] should blend with the current [code]ALBEDO[/code]. If [code]true[/code], enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on [member detail_mask] and [member detail_albedo]'s alpha channel. This can be used to add variation to objects, or to blend between two different albedo/normal textures. @@ -177,10 +177,10 @@ [b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines. - Specifies whether to use [code]UV[/code] or [code]UV2[/code] for the detail layer. See [enum DetailUV] for options. + Specifies whether to use [code]UV[/code] or [code]UV2[/code] for the detail layer. - The algorithm used for diffuse light scattering. See [enum DiffuseMode]. + The algorithm used for diffuse light scattering. If [code]true[/code], the object receives no ambient light. @@ -221,7 +221,7 @@ Use [code]UV2[/code] to read from the [member emission_texture]. - Sets how [member emission] interacts with [member emission_texture]. Can either add or multiply. See [enum EmissionOperator] for options. + Sets how [member emission] interacts with [member emission_texture]. Can either add or multiply. Texture that specifies how much surface emits light at a given point. @@ -371,7 +371,7 @@ If [code]true[/code], enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR. - The method for rendering the specular blob. See [enum SpecularMode]. + The method for rendering the specular blob. [b]Note:[/b] [member specular_mode] only applies to the specular blob. It does not affect specular reflections from the sky, screen-space reflections, [VoxelGI], SDFGI or [ReflectionProbe]s. To disable reflections from these sources as well, set [member metallic_specular] to [code]0.0[/code] instead. @@ -402,11 +402,11 @@ The texture to use for multiplying the intensity of the subsurface scattering transmittance intensity. See also [member subsurf_scatter_texture]. Ignored if [member subsurf_scatter_skin_mode] is [code]true[/code]. - Filter flags for the texture. See [enum TextureFilter] for options. + Filter flags for the texture. [b]Note:[/b] [member heightmap_texture] is always sampled with linear filtering, even if nearest-neighbor filtering is selected here. This is to ensure the heightmap effect looks as intended. If you need sharper height transitions between pixels, resize the heightmap texture in an image editor with nearest-neighbor filtering. - Repeat flags for the texture. See [enum TextureFilter] for options. + If [code]true[/code], the texture repeats when exceeding the texture's size. See [constant FLAG_USE_TEXTURE_REPEAT]. The material's transparency mode. Some transparency modes will disable shadow casting. Any transparency mode other than [constant TRANSPARENCY_DISABLED] has a greater performance impact compared to opaque rendering. See also [member blend_mode]. diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index cc13cb54f36..b20014fcf23 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -41,7 +41,7 @@ - Text alignment policy for the button's text, use one of the [enum HorizontalAlignment] constants. + Text alignment policy for the button's text. If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. @@ -75,7 +75,7 @@ Base text writing direction. - Sets the clipping behavior when the text exceeds the node's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes. + Sets the clipping behavior when the text exceeds the node's bounding rectangle. Specifies if the icon should be aligned vertically to the top, bottom, or center of a button. Uses the same [enum VerticalAlignment] constants as the text alignment. If centered horizontally and vertically, text will draw on top of the icon. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index d573b9fe6e4..20819a80563 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -43,7 +43,7 @@ - Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). + Returns the enabled state of the given particle flag. @@ -91,7 +91,7 @@ - Enables or disables the given flag (see [enum ParticleFlags] for options). + Enables or disables the given flag. @@ -158,7 +158,7 @@ Unit vector specifying the particles' emission direction. - Particle draw order. Uses [enum DrawOrder] values. + Particle draw order. Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. @@ -173,7 +173,7 @@ The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. - Particles will be emitted inside this region. See [enum EmissionShape] for possible values. + Particles will be emitted inside this region. The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 170f684638b..61b4911dedc 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -49,7 +49,7 @@ - Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). + Returns the enabled state of the given particle flag. @@ -97,7 +97,7 @@ - Enables or disables the given particle flag (see [enum ParticleFlags] for options). + Enables or disables the given particle flag. @@ -166,7 +166,7 @@ Unit vector specifying the particles' emission direction. - Particle draw order. Uses [enum DrawOrder] values. + Particle draw order. The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. @@ -198,7 +198,7 @@ The radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. - Particles will be emitted inside this region. See [enum EmissionShape] for possible values. + Particles will be emitted inside this region. The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 714288de845..05681ce2211 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -92,7 +92,7 @@ - The Camera2D's anchor point. See [enum AnchorMode] constants. + The Camera2D's anchor point. The custom [Viewport] node attached to the [Camera2D]. If [code]null[/code] or not a [Viewport], uses the default viewport instead. @@ -169,7 +169,7 @@ Speed in pixels per second of the camera's smoothing effect when [member position_smoothing_enabled] is [code]true[/code]. - The camera's process callback. See [enum Camera2DProcessCallback]. + The camera's process callback. If [code]true[/code], the camera's view smoothly rotates, via asymptotic smoothing, to align with its target rotation at [member rotation_smoothing_speed]. diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 27194122d56..d286be861cb 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -173,7 +173,7 @@ If multiple cameras are in the scene, one will always be made current. For example, if two [Camera3D] nodes are present in the scene and only one is current, setting one camera's [member current] to [code]false[/code] will cause the other camera to be made current. - If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in particular [code]_process[/code] methods. See [enum DopplerTracking] for possible values. + If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in particular [code]_process[/code] methods. The [Environment] to use for this camera. diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index bd52d3b4ef3..5dde04b7217 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -169,13 +169,13 @@ Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. Must be greater than zero. - Sets the motion mode which defines the behavior of [method move_and_slide]. See [enum MotionMode] constants for available modes. + Sets the motion mode which defines the behavior of [method move_and_slide]. Collision layers that will be included for detecting floor bodies that will act as moving platforms to be followed by the [CharacterBody2D]. By default, all floor bodies are detected and propagate their velocity. - Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. See [enum PlatformOnLeave] constants for available behavior. + Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. Collision layers that will be included for detecting wall bodies that will act as moving platforms to be followed by the [CharacterBody2D]. By default, all wall bodies are ignored. diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 96de443a5a1..1fc098dd5e2 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -160,13 +160,13 @@ Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. Must be greater than zero. - Sets the motion mode which defines the behavior of [method move_and_slide]. See [enum MotionMode] constants for available modes. + Sets the motion mode which defines the behavior of [method move_and_slide]. Collision layers that will be included for detecting floor bodies that will act as moving platforms to be followed by the [CharacterBody3D]. By default, all floor bodies are detected and propagate their velocity. - Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. See [enum PlatformOnLeave] constants for available behavior. + Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied. Collision layers that will be included for detecting wall bodies that will act as moving platforms to be followed by the [CharacterBody3D]. By default, all wall bodies are ignored. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index d01a308e328..9c21f69b9b1 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -35,7 +35,7 @@ - Returns the API type of [param class]. See [enum APIType]. + Returns the API type of the specified [param class]. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 137e7129135..9daac969e81 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -236,7 +236,7 @@ The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. - Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. + Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one [member collision_layer] bit to be set. diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index 063c27c76a1..d93f6a703c7 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -194,7 +194,7 @@ The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. - Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. + Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. If [code]true[/code], the [CollisionObject3D] will continue to receive input events as the mouse is dragged across its shapes. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index 9dbe465ecdc..739a6e2923a 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -11,7 +11,7 @@ - Collision build mode. Use one of the [enum BuildMode] constants. + Collision build mode. If [code]true[/code], no collisions will be detected. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 72db9d8081d..07e17b066c6 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -62,7 +62,7 @@ The currently selected color. - The currently selected color mode. See [enum ColorModeType]. + The currently selected color mode. If [code]true[/code], the color mode buttons are visible. @@ -80,7 +80,7 @@ If [code]true[/code], the hex color code input field is visible. - The shape of the color space view. See [enum PickerShapeType]. + The shape of the color space view. If [code]true[/code], the Swatches and Recent Colors presets are visible. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 8b197e42bcb..06285cf274b 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -406,7 +406,7 @@ - Returns the mouse cursor shape for this control when hovered over [param position] in local coordinates. For most controls, this is the same as [member mouse_default_cursor_shape], but some built-in controls implement more complex logic. See [enum CursorShape]. + Returns the mouse cursor shape for this control when hovered over [param position] in local coordinates. For most controls, this is the same as [member mouse_default_cursor_shape], but some built-in controls implement more complex logic. diff --git a/doc/classes/DirectionalLight3D.xml b/doc/classes/DirectionalLight3D.xml index 0a307a4adeb..acac90eab39 100644 --- a/doc/classes/DirectionalLight3D.xml +++ b/doc/classes/DirectionalLight3D.xml @@ -21,7 +21,7 @@ The maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering). - The light's shadow rendering algorithm. See [enum ShadowMode]. + The light's shadow rendering algorithm. Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to [code]0[/code] turns off the pancaking effect. @@ -36,7 +36,7 @@ The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [constant SHADOW_PARALLEL_4_SPLITS]. - Set whether this [DirectionalLight3D] is visible in the sky, in the scene, or both in the sky and in the scene. See [enum SkyMode] for options. + Whether this [DirectionalLight3D] is visible in the sky, in the scene, or both in the sky and in the scene. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 0b831f117d9..74fcf252f8a 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -278,7 +278,7 @@ - Sets element flag, see [enum DisplayServer.AccessibilityFlags]. + Sets element flag. @@ -2296,7 +2296,7 @@ - Enables or disables the given window's given [param flag]. See [enum WindowFlags] for possible values and their behavior. + Enables or disables the given window's given [param flag]. @@ -2359,7 +2359,7 @@ - Sets window mode for the given window to [param mode]. See [enum WindowMode] for possible values and how each mode behaves. + Sets window mode for the given window to [param mode]. [b]Note:[/b] On Android, setting it to [constant WINDOW_MODE_FULLSCREEN] or [constant WINDOW_MODE_EXCLUSIVE_FULLSCREEN] will enable immersive mode. [b]Note:[/b] Setting the window to full screen forcibly sets the borderless flag to [code]true[/code], so make sure to set it back to [code]false[/code] when not wanted. @@ -2468,7 +2468,6 @@ Sets the V-Sync mode of the given window. See also [member ProjectSettings.display/window/vsync/vsync_mode]. - See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application. Depending on the platform and used renderer, the engine will fall back to [constant VSYNC_ENABLED] if the desired mode is not supported. [b]Note:[/b] V-Sync modes other than [constant VSYNC_ENABLED] are only supported in the Forward+ and Mobile rendering methods, not Compatibility. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 5402f9ab8e0..03cf36fde4a 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -162,7 +162,7 @@ The view format in which the [EditorFileDialog] displays resources to the user. - The dialog's open or save mode, which affects the selection behavior. See [enum FileMode]. + The dialog's open or save mode, which affects the selection behavior. The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code]. Multiple file types can also be specified in a single filter. [code]"*.png, *.jpg, *.jpeg ; Supported Images"[/code] will show both PNG and JPEG files when selected. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index e2fc5f0a912..7ebc41f45b5 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -407,7 +407,7 @@ Adds a plugin to the context menu. [param slot] is the context menu where the plugin will be added. - See [enum EditorContextMenuPlugin.ContextMenuSlot] for available context menus. A plugin instance can belong only to a single context menu slot. + [b]Note:[/b] A plugin instance can belong only to a single context menu slot. @@ -425,7 +425,7 @@ - Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. + Adds a custom control to a container in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [method Node.queue_free]. @@ -436,7 +436,7 @@ - Adds the control to a specific dock slot (see [enum DockSlot] for options). + Adds the control to a specific dock slot. If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free]. Optionally, you can specify a shortcut parameter. When pressed, this shortcut will open and focus the dock. diff --git a/doc/classes/EditorUndoRedoManager.xml b/doc/classes/EditorUndoRedoManager.xml index 09293302817..ae46a2c0ace 100644 --- a/doc/classes/EditorUndoRedoManager.xml +++ b/doc/classes/EditorUndoRedoManager.xml @@ -99,7 +99,7 @@ Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. - The way actions are merged is dictated by the [param merge_mode] argument. See [enum UndoRedo.MergeMode] for details. + The way actions are merged is dictated by the [param merge_mode] argument. If [param custom_context] object is provided, it will be used for deducing target history (instead of using the first operation). The way undo operation are ordered in actions is dictated by [param backward_undo_ops]. When [param backward_undo_ops] is [code]false[/code] undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. If [param mark_unsaved] is [code]false[/code], the action will not mark the history as unsaved. This is useful for example for actions that change a selection, or a setting that will be saved automatically. Otherwise, this should be left to [code]true[/code] if the action requires saving by the user or if it can cause data loss when left unsaved. diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 5c081e09561..e87490a203f 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -78,7 +78,7 @@ Luminance of background measured in nits (candela per square meter). Only used when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is enabled. The default value is roughly equivalent to the sky at midday. - The background mode. See [enum BGMode] for possible values. + The background mode. If set above [code]0.0[/code] (exclusive), blends between the fog's color and the color of the background [Sky], as read from the radiance cubemap. This has a small performance cost when set above [code]0.0[/code]. Must have [member background_mode] set to [constant BG_SKY]. @@ -115,7 +115,7 @@ The fog's brightness. Higher values result in brighter fog. - The fog mode. See [enum FogMode] for possible values. + The fog mode. The factor to use when affecting the sky with non-volumetric fog. [code]1.0[/code] means that fog can fully obscure the sky. Lower values reduce the impact of fog on sky rendering, with [code]0.0[/code] not affecting sky rendering at all. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index d5784d1e473..a016ba794ac 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -123,7 +123,7 @@ - The file system access scope. See [enum Access] constants. + The file system access scope. [b]Warning:[/b] In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, [member use_native_dialog] is automatically used to allow limited access to host file system. @@ -141,7 +141,7 @@ Display mode of the dialog's file list. - The dialog's open or save mode, which affects the selection behavior. See [enum FileMode]. + The dialog's open or save mode, which affects the selection behavior. The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. [member filename_filter] can be edited by the user with the filter button at the top of the file dialog. diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 3620105ff6f..6c6b1267c48 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -175,7 +175,7 @@ - Returns font style flags, see [enum TextServer.FontStyle]. + Returns font style flags. @@ -236,7 +236,7 @@ - Returns the spacing for the given [code]type[/code] (see [enum TextServer.SpacingType]). + Returns the amount of spacing for the given [param spacing] type. diff --git a/doc/classes/FontFile.xml b/doc/classes/FontFile.xml index 6545feb0a75..eed4524ee0d 100644 --- a/doc/classes/FontFile.xml +++ b/doc/classes/FontFile.xml @@ -143,7 +143,7 @@ - Returns spacing for [param spacing] (see [enum TextServer.SpacingType]) in pixels (not relative to the font size). + Returns spacing for [param spacing] in pixels (not relative to the font size). @@ -466,7 +466,7 @@ - Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). + Sets the spacing for [param spacing] to [param value] in pixels (not relative to the font size). @@ -617,7 +617,7 @@ Font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code]. - Font style flags, see [enum TextServer.FontStyle]. + Font style flags. Weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code]. diff --git a/doc/classes/FontVariation.xml b/doc/classes/FontVariation.xml index 1de6d695a90..08c2ec9a4fc 100644 --- a/doc/classes/FontVariation.xml +++ b/doc/classes/FontVariation.xml @@ -38,7 +38,7 @@ - Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). + Sets the spacing for [param spacing] to [param value] in pixels (not relative to the font size). diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index a075d49f513..e211584f6b4 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -73,7 +73,7 @@ [b]Note:[/b] Particles always have a spherical collision shape. - Particle draw order. Uses [enum DrawOrder] values. + Particle draw order. If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle unless all active particles have finished processing. Use the [signal finished] signal to be notified once all active particles finish processing. diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index ddd4fc831ef..1dc64c7f635 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -86,7 +86,7 @@ [b]Note:[/b] Particles always have a spherical collision shape. - Particle draw order. Uses [enum DrawOrder] values. + Particle draw order. [b]Note:[/b] [constant DRAW_ORDER_INDEX] is the only option that supports motion vectors for effects like TAA. It is suggested to use this draw order if the particles are opaque to fix ghosting artifacts. diff --git a/doc/classes/Geometry2D.xml b/doc/classes/Geometry2D.xml index 4c2398d3964..eeeb57f76e3 100644 --- a/doc/classes/Geometry2D.xml +++ b/doc/classes/Geometry2D.xml @@ -193,7 +193,7 @@ Inflates or deflates [param polygon] by [param delta] units (pixels). If [param delta] is positive, makes the polygon grow outward. If [param delta] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [param delta] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. - Each polygon's vertices will be rounded as determined by [param join_type], see [enum PolyJoinType]. + Each polygon's vertices will be rounded as determined by [param join_type]. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. [b]Note:[/b] To translate the polygon's vertices specifically, multiply them to a [Transform2D]: [codeblocks] @@ -220,8 +220,8 @@ Inflates or deflates [param polyline] by [param delta] units (pixels), producing polygons. If [param delta] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [param delta] is negative, returns an empty array. - Each polygon's vertices will be rounded as determined by [param join_type], see [enum PolyJoinType]. - Each polygon's endpoints will be rounded as determined by [param end_type], see [enum PolyEndType]. + Each polygon's vertices will be rounded as determined by [param join_type]. + Each polygon's endpoints will be rounded as determined by [param end_type]. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 9cd7533aeb4..ce2deed0c18 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -31,7 +31,7 @@ - The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values. + The selected shadow casting flag. Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive [AABB] recalculation that happens when a skeleton is used with a [MeshInstance3D] or to have precise control over the [MeshInstance3D]'s bounding box. To use the default AABB, set value to an [AABB] with all fields set to [code]0.0[/code]. To avoid frustum culling, set [member custom_aabb] to a very large AABB that covers your entire game world such as [code]AABB(-10000, -10000, -10000, 20000, 20000, 20000)[/code]. To disable all forms of culling (including occlusion culling), call [method RenderingServer.instance_set_ignore_culling] on the [GeometryInstance3D]'s [RID]. @@ -87,7 +87,7 @@ If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_DISABLED], this acts as a hysteresis distance. If [member visibility_range_fade_mode] is [constant VISIBILITY_RANGE_FADE_SELF] or [constant VISIBILITY_RANGE_FADE_DEPENDENCIES], this acts as a fade transition distance and must be set to a value greater than [code]0.0[/code] for the effect to be noticeable. - Controls which instances will be faded when approaching the limits of the visibility range. See [enum VisibilityRangeFadeMode] for possible values. + Controls which instances will be faded when approaching the limits of the visibility range. diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index c85b3acafae..ee69d453ad3 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -82,11 +82,11 @@ [b]Note:[/b] Setting this property updates all colors at once. To update any color individually use [method set_color]. - The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. See [enum ColorSpace] for available modes. + The color space used to interpolate between points of the gradient. It does not affect the returned colors, which will always be in sRGB space. [b]Note:[/b] This setting has no effect when [member interpolation_mode] is set to [constant GRADIENT_INTERPOLATE_CONSTANT]. - The algorithm used to interpolate between points of the gradient. See [enum InterpolationMode] for available modes. + The algorithm used to interpolate between points of the gradient. Gradient's offsets as a [PackedFloat32Array]. diff --git a/doc/classes/GradientTexture2D.xml b/doc/classes/GradientTexture2D.xml index f6588ef791e..f11b2a60180 100644 --- a/doc/classes/GradientTexture2D.xml +++ b/doc/classes/GradientTexture2D.xml @@ -4,13 +4,14 @@ A 2D texture that creates a pattern with colors obtained from a [Gradient]. - A 2D texture that obtains colors from a [Gradient] to fill the texture data. This texture is able to transform a color transition into different patterns such as a linear or a radial gradient. The gradient is sampled individually for each pixel so it does not necessarily represent an exact copy of the gradient(see [member width] and [member height]). See also [GradientTexture1D], [CurveTexture] and [CurveXYZTexture]. + A 2D texture that obtains colors from a [Gradient] to fill the texture data. This texture is able to transform a color transition into different patterns such as a linear or a radial gradient. The texture is filled by interpolating colors starting from [member fill_from] to [member fill_to] offsets by default, but the gradient fill can be repeated to cover the entire texture. + The gradient is sampled individually for each pixel so it does not necessarily represent an exact copy of the gradient (see [member width] and [member height]). See also [GradientTexture1D], [CurveTexture] and [CurveXYZTexture]. - The gradient fill type, one of the [enum Fill] values. The texture is filled by interpolating colors starting from [member fill_from] to [member fill_to] offsets. + The gradient's fill type. The initial offset used to fill the texture specified in UV coordinates. @@ -25,7 +26,7 @@ The number of vertical color samples that will be obtained from the [Gradient], which also represents the texture's height. - The gradient repeat type, one of the [enum Repeat] values. The texture is filled starting from [member fill_from] to [member fill_to] offsets by default, but the gradient fill can be repeated to cover the entire texture. + The gradient's repeat type. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 82fbbba146e..9af87c24839 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -142,9 +142,9 @@ - Sends a request to the connected host. + Sends an HTTP request to the connected host with the given [param method]. The URL parameter is usually just the part after the host, so for [code]https://example.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). - Headers are HTTP request headers. For available HTTP methods, see [enum Method]. + [param headers] are HTTP request headers. To create a POST request with query strings to push to the server, do: [codeblocks] [gdscript] @@ -170,9 +170,9 @@ - Sends a raw request to the connected host. + Sends a raw HTTP request to the connected host with the given [param method]. The URL parameter is usually just the part after the host, so for [code]https://example.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). - Headers are HTTP request headers. For available HTTP methods, see [enum Method]. + [param headers] are HTTP request headers. Sends the body data raw, as a byte array and does not encode it in any way. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index d294bfa3a4e..d74268b5f75 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -179,7 +179,7 @@ - Returns the current status of the underlying [HTTPClient]. See [enum HTTPClient.Status]. + Returns the current status of the underlying [HTTPClient]. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 0ea7dc16459..657d04f10fa 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -109,7 +109,7 @@ - Converts the image's format. See [enum Format] constants. + Converts this image's format to the given [param format]. @@ -126,7 +126,7 @@ - Creates an empty image of given size and format. See [enum Format] constants. If [param use_mipmaps] is [code]true[/code], then generate mipmaps for this image. See the [method generate_mipmaps]. + Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image. See the [method generate_mipmaps]. @@ -136,7 +136,7 @@ - Creates an empty image of given size and format. See [enum Format] constants. If [param use_mipmaps] is [code]true[/code], then generate mipmaps for this image. See the [method generate_mipmaps]. + Creates an empty image of the given size and format. If [param use_mipmaps] is [code]true[/code], generates mipmaps for this image. See the [method generate_mipmaps]. @@ -147,7 +147,7 @@ - Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [param use_mipmaps] is [code]true[/code] then loads mipmaps for this image from [param data]. See [method generate_mipmaps]. + Creates a new image of the given size and format. Fills the image with the given raw data. If [param use_mipmaps] is [code]true[/code], loads the mipmaps for this image from [param data]. See [method generate_mipmaps]. @@ -175,7 +175,7 @@ - Returns the color channels used by this image, as one of the [enum UsedChannels] constants. If the image is compressed, the original [param source] must be specified. + Returns the color channels used by this image. If the image is compressed, the original [param source] must be specified. @@ -234,7 +234,7 @@ - Returns the image's format. See [enum Format] constants. + Returns this image's format. diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 2421c0642a5..e1ab84584bd 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -39,7 +39,7 @@ - Returns the format of the texture, one of [enum Image.Format]. + Returns the format of the texture. diff --git a/doc/classes/ImageTexture3D.xml b/doc/classes/ImageTexture3D.xml index a36271d67b2..3d2aec1c7fd 100644 --- a/doc/classes/ImageTexture3D.xml +++ b/doc/classes/ImageTexture3D.xml @@ -19,7 +19,7 @@ - Creates the [ImageTexture3D] with specified [param width], [param height], and [param depth]. See [enum Image.Format] for [param format] options. If [param use_mipmaps] is [code]true[/code], then generate mipmaps for the [ImageTexture3D]. + Creates the [ImageTexture3D] with specified [param format], [param width], [param height], and [param depth]. If [param use_mipmaps] is [code]true[/code], generates mipmaps for the [ImageTexture3D]. diff --git a/doc/classes/ImporterMesh.xml b/doc/classes/ImporterMesh.xml index 48584c8ac73..3714f0fcbeb 100644 --- a/doc/classes/ImporterMesh.xml +++ b/doc/classes/ImporterMesh.xml @@ -165,7 +165,7 @@ - Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. + Sets the blend shape mode. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index ca54a44f489..436215305b5 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -90,7 +90,7 @@ - Returns the currently assigned cursor shape (see [enum CursorShape]). + Returns the currently assigned cursor shape. @@ -114,7 +114,7 @@ - Returns the current value of the joypad axis at given index (see [enum JoyAxis]). + Returns the current value of the joypad axis at index [param axis]. @@ -247,7 +247,7 @@ - Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]). + Returns [code]true[/code] if you are pressing the joypad button at index [param button]. @@ -333,7 +333,7 @@ - Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes. + Sets a custom mouse cursor image, which is only visible inside the game window, for the given mouse [param shape]. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. [param image] can be either [Texture2D] or [Image] and its size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended. [param hotspot] must be within [param image]'s size. [b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed. @@ -434,7 +434,7 @@ If [code]true[/code], sends touch input events when clicking or dragging the mouse. See also [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse]. - Controls the mouse mode. See [enum MouseMode] for more information. + Controls the mouse mode. If [code]true[/code], similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index ab939874e50..2107c4ba686 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -11,7 +11,7 @@ - Axis identifier. Use one of the [enum JoyAxis] axis constants. + Axis identifier. Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index aa9f05d9423..bd60328a4a0 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -425,7 +425,7 @@ Allows single or multiple item selection. See the [enum SelectMode] constants. - Sets the clipping behavior when the text exceeds an item's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes. + The clipping behavior when the text exceeds an item's bounding rectangle. If [code]true[/code], the control will automatically move items into a new row to fit its content. See also [HFlowContainer] for this behavior. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index b02c4ac05ea..bb4581c1ca5 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -47,7 +47,7 @@ - If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Autowrap space trimming flags. See [constant TextServer.BREAK_TRIM_START_EDGE_SPACES] and [constant TextServer.BREAK_TRIM_END_EDGE_SPACES] for more info. @@ -59,10 +59,10 @@ Ellipsis character used for text clipping. - Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants. + Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). - Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information. + Line fill alignment rules. A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties. @@ -97,20 +97,20 @@ Base text writing direction. - Sets the clipping behavior when the text exceeds the node's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes. + The clipping behavior when the text exceeds the node's bounding rectangle. If [code]true[/code], all the text displays as UPPERCASE. - Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the [enum VerticalAlignment] constants. + Controls the text's vertical alignment. Supports top, center, bottom, and fill. The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box. [b]Note:[/b] Setting this property updates [member visible_ratio] accordingly. - Sets the clipping behavior when [member visible_characters] or [member visible_ratio] is set. See [enum TextServer.VisibleCharactersBehavior] for more info. + The clipping behavior when [member visible_characters] or [member visible_ratio] is set. The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. diff --git a/doc/classes/Label3D.xml b/doc/classes/Label3D.xml index b655d77b544..958566158c9 100644 --- a/doc/classes/Label3D.xml +++ b/doc/classes/Label3D.xml @@ -28,7 +28,7 @@ - If [code]true[/code], the specified flag will be enabled. See [enum Label3D.DrawFlags] for a list of flags. + If [code]true[/code], the specified [param flag] will be enabled. @@ -37,10 +37,10 @@ Threshold at which antialiasing will be applied on the alpha channel. - The type of alpha antialiasing to apply. See [enum BaseMaterial3D.AlphaAntiAliasing]. + The type of alpha antialiasing to apply. - The alpha cutting mode to use for the sprite. See [enum AlphaCutMode] for possible values. + The alpha cutting mode to use for the sprite. The hashing scale for Alpha Hash. Recommended values between [code]0[/code] and [code]2[/code]. @@ -49,13 +49,13 @@ Threshold at which the alpha scissor will discard values. - If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Autowrap space trimming flags. See [constant TextServer.BREAK_TRIM_START_EDGE_SPACES] and [constant TextServer.BREAK_TRIM_END_EDGE_SPACES] for more info. - The billboard mode to use for the label. See [enum BaseMaterial3D.BillboardMode] for possible values. + The billboard mode to use for the label. @@ -73,10 +73,10 @@ - Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants. + Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). - Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information. + Line fill alignment rules. Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -128,13 +128,13 @@ Base text writing direction. - Filter flags for the texture. See [enum BaseMaterial3D.TextureFilter] for options. + Filter flags for the texture. If [code]true[/code], all the text displays as UPPERCASE. - Controls the text's vertical alignment. Supports top, center, bottom. Set it to one of the [enum VerticalAlignment] constants. + Controls the text's vertical alignment. Supports top, center, and bottom. Text width (in pixels), used for autowrap and fill alignment. diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index a1c1a57ae45..e9d4c7358f4 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -26,7 +26,7 @@ - The Light2D's blend mode. See [enum BlendMode] constants for values. + The Light2D's blend mode. The Light2D's [Color]. @@ -63,7 +63,7 @@ If [code]true[/code], the Light2D will cast shadows. - Shadow filter type. See [enum ShadowFilter] for possible values. + Shadow filter type. Smoothing value for shadows. Higher values will result in softer shadows, at the cost of visible streaks that can appear in shadow rendering. [member shadow_filter_smooth] only has an effect if [member shadow_filter] is [constant SHADOW_FILTER_PCF5] or [constant SHADOW_FILTER_PCF13]. diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index ed074161ded..e035b3d214f 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -60,7 +60,7 @@ [b]Note:[/b] PCSS for directional lights is only supported in the Forward+ rendering method, not Mobile or Compatibility. - The light's bake mode. This will affect the global illumination techniques that have an effect on the light's rendering. See [enum BakeMode]. + The light's bake mode. This will affect the global illumination techniques that have an effect on the light's rendering. [b]Note:[/b] Meshes' global illumination mode will also affect the global illumination rendering. See [member GeometryInstance3D.gi_mode]. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 825462d21a7..9b52c77a057 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -63,7 +63,7 @@ [b]Note:[/b] [Line2D] is not accelerated by batching when being anti-aliased. - The style of the beginning of the polyline, if [member closed] is [code]false[/code]. Use [enum LineCapMode] constants. + The style of the beginning of the polyline, if [member closed] is [code]false[/code]. If [code]true[/code] and the polyline has more than 2 points, the last point and the first one will be connected by a segment. @@ -74,13 +74,13 @@ The color of the polyline. Will not be used if a gradient is set. - The style of the end of the polyline, if [member closed] is [code]false[/code]. Use [enum LineCapMode] constants. + The style of the end of the polyline, if [member closed] is [code]false[/code]. The gradient is drawn through the whole line from start to finish. The [member default_color] will not be used if this property is set. - The style of the connections between segments of the polyline. Use [enum LineJointMode] constants. + The style of the connections between segments of the polyline. The points of the polyline, interpreted in local 2D coordinates. Segments are drawn between the adjacent points in this array. @@ -95,7 +95,7 @@ The texture used for the polyline. Uses [member texture_mode] for drawing style. - The style to render the [member texture] of the polyline. Use [enum LineTextureMode] constants. + The style to render the [member texture] of the polyline. The polyline's width. diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index 802899858ac..ab1b9882e75 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -28,7 +28,7 @@ Base text writing direction. - The underline mode to use for the text. See [enum LinkButton.UnderlineMode] for the available modes. + The underline mode to use for the text. The [url=https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]URI[/url] for this [LinkButton]. If set to a valid URI, pressing the button opens the URI using the operating system's default program for the protocol (via [method OS.shell_open]). HTTP and HTTPS URLs open the default web browser. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 5f51d18e4e0..2c0131c4b72 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -49,7 +49,7 @@ - Returns the item's shadow casting mode. See [enum RenderingServer.ShadowCastingSetting] for possible values. + Returns the item's shadow casting mode. @@ -128,7 +128,7 @@ - Sets the item's shadow casting mode. See [enum RenderingServer.ShadowCastingSetting] for possible values. + Sets the item's shadow casting mode to [param shadow_casting_setting]. diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index cec94641022..038a3e63ec6 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -35,7 +35,7 @@ - Returns the current state of the connection. See [enum ConnectionStatus]. + Returns the current state of the connection. @@ -92,7 +92,7 @@ [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_UNRELIABLE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. - The manner in which to send packets to the target peer. See [enum TransferMode], and the [method set_target_peer] method. + The manner in which to send packets to the target peer. See the [method set_target_peer] method. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index 5898e6841a1..ee61453e741 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -140,10 +140,10 @@ Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH]. - Determines which type of nodes will be parsed as geometry. See [enum ParsedGeometryType] for possible values. + Determines which type of nodes will be parsed as geometry. - The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. + The source of the geometry used when baking. The name of the group to scan for geometry. @@ -158,7 +158,7 @@ [b]Note:[/b] This value will be squared to calculate the minimum number of cells allowed to form isolated island areas. For example, a value of 8 will set the number of cells to 64. - Partitioning algorithm for creating the navigation mesh polys. See [enum SamplePartitionType] for possible values. + Partitioning algorithm for creating the navigation mesh polys. The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 3f7924d5c2f..91ebb032712 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -191,17 +191,17 @@ Only used when [member parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH]. - Determines which type of nodes will be parsed as geometry. See [enum ParsedGeometryType] for possible values. + Determines which type of nodes will be parsed as geometry. - Partitioning algorithm for creating the navigation mesh polys. See [enum SamplePartitionType] for possible values. + Partitioning algorithm for creating the navigation mesh polys. The group name of nodes that should be parsed for baking source geometry. Only used when [member source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT]. - The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. + The source of the geometry used when baking. diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 2257f1e5039..0b6d21a58c7 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -307,7 +307,7 @@ - Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states. + Returns information about the current state of the NavigationServer. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 07ec3203a6e..8a400977ab9 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -339,7 +339,7 @@ - Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states. + Returns information about the current state of the NavigationServer. diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index c30662b1224..9a3d17e0964 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -27,10 +27,10 @@ - The stretch mode to use for horizontal stretching/tiling. See [enum NinePatchRect.AxisStretchMode] for possible values. + The stretch mode to use for horizontal stretching/tiling. - The stretch mode to use for vertical stretching/tiling. See [enum NinePatchRect.AxisStretchMode] for possible values. + The stretch mode to use for vertical stretching/tiling. If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 4a5c3270dd8..2ceda105adc 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -162,7 +162,7 @@ Adds a child [param node]. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [param force_readable_name] is [code]true[/code], improves the readability of the added [param node]. If not named, the [param node] is renamed to its type, and if it shares [member name] with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to [code]false[/code], which assigns a dummy name featuring [code]@[/code] in both situations. - If [param internal] is different than [constant INTERNAL_MODE_DISABLED], the child will be added as internal node. These nodes are ignored by methods like [method get_children], unless their parameter [code]include_internal[/code] is [code]true[/code]. It also prevents these nodes being duplicated with their parent. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. [ColorPicker]. See [enum InternalMode] for available modes. + If [param internal] is different than [constant INTERNAL_MODE_DISABLED], the child will be added as internal node. These nodes are ignored by methods like [method get_children], unless their parameter [code]include_internal[/code] is [code]true[/code]. It also prevents these nodes being duplicated with their parent. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. [ColorPicker]. [b]Note:[/b] If [param node] already has a parent, this method will fail. Use [method remove_child] first to remove [param node] from its current parent. For example: [codeblocks] [gdscript] @@ -1080,7 +1080,7 @@ [b]Note:[/b] When teleporting a node to a distant position you should temporarily disable interpolation with [method Node.reset_physics_interpolation]. - The node's processing behavior (see [enum ProcessMode]). To check if the node can process in its current mode, use [method can_process]. + The node's processing behavior. To check if the node can process in its current mode, use [method can_process]. Similar to [member process_priority] but for [constant NOTIFICATION_PHYSICS_PROCESS], [method _physics_process], or [constant NOTIFICATION_INTERNAL_PHYSICS_PROCESS]. diff --git a/doc/classes/OmniLight3D.xml b/doc/classes/OmniLight3D.xml index 60016822f75..8d91663ea14 100644 --- a/doc/classes/OmniLight3D.xml +++ b/doc/classes/OmniLight3D.xml @@ -25,7 +25,6 @@ [b]Note:[/b] [member omni_range] is not affected by [member Node3D.scale] (the light's scale or its parent's scale). - See [enum ShadowMode]. diff --git a/doc/classes/PacketPeerDTLS.xml b/doc/classes/PacketPeerDTLS.xml index 4e2a7b70cdb..6598c33da58 100644 --- a/doc/classes/PacketPeerDTLS.xml +++ b/doc/classes/PacketPeerDTLS.xml @@ -29,7 +29,7 @@ - Returns the status of the connection. See [enum Status] for values. + Returns the status of the connection. diff --git a/doc/classes/ParticleProcessMaterial.xml b/doc/classes/ParticleProcessMaterial.xml index 7118df8ed85..3d577bfc25b 100644 --- a/doc/classes/ParticleProcessMaterial.xml +++ b/doc/classes/ParticleProcessMaterial.xml @@ -42,7 +42,7 @@ - Returns [code]true[/code] if the specified particle flag is enabled. See [enum ParticleFlags] for options. + Returns [code]true[/code] if the specified particle flag is enabled. @@ -83,7 +83,7 @@ - If [code]true[/code], enables the specified particle flag. See [enum ParticleFlags] for options. + Sets the [param particle_flag] to [param enable]. @@ -222,7 +222,7 @@ The radius of the ring when using the emitter [constant EMISSION_SHAPE_RING]. - Particles will be emitted inside this region. Use [enum EmissionShape] constants for values. + Particles will be emitted inside this region. The offset for the [member emission_shape], in local space. diff --git a/doc/classes/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index e2ad3db0a5c..60c5881b558 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -61,7 +61,7 @@ See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. - Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + Defines how [member angular_damp] is applied. The PhysicalBone3D's rotational velocity in [i]radians[/i] per second. @@ -93,14 +93,14 @@ Sets the joint's rotation in radians. - Sets the joint type. See [enum JointType] for possible values. + Sets the joint type. Damps the body's movement. By default, the body will use [member ProjectSettings.physics/3d/default_linear_damp] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], [member linear_damp] may be added to or replace the body's damping value. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. - Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + Defines how [member linear_damp] is applied. The body's linear velocity in units per second. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index bd960e3da51..efb009dd9b9 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -89,7 +89,7 @@ - Returns the value of the given area parameter. See [enum AreaParameter] for the list of available parameters. + Returns the value of the given area parameter. @@ -195,7 +195,7 @@ - Sets the value of the given area parameter. See [enum AreaParameter] for the list of available parameters. + Sets the value of the given area parameter. @@ -422,7 +422,7 @@ - Returns the body's continuous collision detection mode (see [enum CCDMode]). + Returns the body's continuous collision detection mode. @@ -443,7 +443,7 @@ - Returns the body's mode (see [enum BodyMode]). + Returns the body's mode. @@ -458,7 +458,7 @@ - Returns the value of the given body parameter. See [enum BodyParameter] for the list of available parameters. + Returns the value of the given body parameter. @@ -496,7 +496,7 @@ - Returns the value of the given state of the body. See [enum BodyState] for the list of available states. + Returns the value of the given state of the body. @@ -584,7 +584,7 @@ - Sets the continuous collision detection mode using one of the [enum CCDMode] constants. + Sets the continuous collision detection mode. Continuous collision detection tries to predict where a moving body would collide in between physics updates, instead of moving it and correcting its movement if it collided. @@ -615,7 +615,7 @@ - Sets the body's mode. See [enum BodyMode] for the list of available modes. + Sets the body's mode. @@ -633,7 +633,7 @@ - Sets the value of the given body parameter. See [enum BodyParameter] for the list of available parameters. + Sets the value of the given body parameter. @@ -690,7 +690,7 @@ - Sets the value of a body's state. See [enum BodyState] for the list of available states. + Sets the value of a body's state. [b]Note:[/b] The state change doesn't take effect immediately. The state will change on the next physics frame. @@ -743,7 +743,7 @@ - Returns the value of the given damped spring joint parameter. See [enum DampedSpringParam] for the list of available parameters. + Returns the value of the given damped spring joint parameter. @@ -752,7 +752,7 @@ - Sets the value of the given damped spring joint parameter. See [enum DampedSpringParam] for the list of available parameters. + Sets the value of the given damped spring joint parameter. @@ -766,7 +766,7 @@ - Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for the list of available states. + Returns the value of a physics engine state specified by [param process_info]. @@ -795,14 +795,14 @@ - Returns the value of the given joint parameter. See [enum JointParam] for the list of available parameters. + Returns the value of the given joint parameter. - Returns the joint's type (see [enum JointType]). + Returns the joint's type. @@ -851,7 +851,7 @@ - Sets the value of the given joint parameter. See [enum JointParam] for the list of available parameters. + Sets the value of the given joint parameter. @@ -859,7 +859,7 @@ - Gets a pin joint flag (see [enum PinJointFlag] constants). + Gets a pin joint flag. @@ -867,7 +867,7 @@ - Returns the value of a pin joint parameter. See [enum PinJointParam] for a list of available parameters. + Returns the value of a pin joint parameter. @@ -876,7 +876,7 @@ - Sets a pin joint flag (see [enum PinJointFlag] constants). + Sets a pin joint flag. @@ -885,7 +885,7 @@ - Sets a pin joint parameter. See [enum PinJointParam] for a list of available parameters. + Sets a pin joint parameter. @@ -924,7 +924,7 @@ - Returns the shape's type (see [enum ShapeType]). + Returns the shape's type. @@ -962,7 +962,7 @@ - Returns the value of the given space parameter. See [enum SpaceParameter] for the list of available parameters. + Returns the value of the given space parameter. @@ -986,7 +986,7 @@ - Sets the value of the given space parameter. See [enum SpaceParameter] for the list of available parameters. + Sets the value of the given space parameter. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 130cda73611..36758619783 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -606,7 +606,7 @@ - Sets the body mode, from one of the [enum BodyMode] constants. + Sets the body mode. @@ -675,7 +675,7 @@ - Sets a body state (see [enum BodyState] constants). + Sets a body state. @@ -718,7 +718,7 @@ - Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). + Gets a cone twist joint parameter. @@ -727,7 +727,7 @@ - Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). + Sets a cone twist joint parameter. @@ -758,7 +758,7 @@ - Returns the value of a generic 6DOF joint flag. See [enum G6DOFJointAxisFlag] for the list of available flags. + Returns the value of a generic 6DOF joint flag. @@ -767,7 +767,7 @@ - Returns the value of a generic 6DOF joint parameter. See [enum G6DOFJointAxisParam] for the list of available parameters. + Returns the value of a generic 6DOF joint parameter. @@ -777,7 +777,7 @@ - Sets the value of a given generic 6DOF joint flag. See [enum G6DOFJointAxisFlag] for the list of available flags. + Sets the value of a given generic 6DOF joint flag. @@ -787,14 +787,14 @@ - Sets the value of a given generic 6DOF joint parameter. See [enum G6DOFJointAxisParam] for the list of available parameters. + Sets the value of a given generic 6DOF joint parameter. - Returns information about the current state of the 3D physics engine. See [enum ProcessInfo] for a list of available states. + Returns the value of a physics engine state specified by [param process_info]. @@ -807,7 +807,7 @@ - Gets a hinge_joint flag (see [enum HingeJointFlag] constants). + Gets a hinge joint flag. @@ -815,7 +815,7 @@ - Gets a hinge_joint parameter (see [enum HingeJointParam]). + Gets a hinge joint parameter. @@ -824,7 +824,7 @@ - Sets a hinge_joint flag (see [enum HingeJointFlag] constants). + Sets a hinge joint flag. @@ -833,7 +833,7 @@ - Sets a hinge_joint parameter (see [enum HingeJointParam] constants). + Sets a hinge joint parameter. @@ -954,7 +954,7 @@ - Gets a pin_joint parameter (see [enum PinJointParam] constants). + Gets a pin joint parameter. @@ -979,7 +979,7 @@ - Sets a pin_joint parameter (see [enum PinJointParam] constants). + Sets a pin joint parameter. @@ -1013,7 +1013,7 @@ - Returns the type of shape (see [enum ShapeType] constants). + Returns the type of shape. @@ -1038,7 +1038,7 @@ - Gets a slider_joint parameter (see [enum SliderJointParam] constants). + Gets a slider joint parameter. @@ -1047,7 +1047,7 @@ - Gets a slider_joint parameter (see [enum SliderJointParam] constants). + Gets a slider joint parameter. @@ -1183,7 +1183,7 @@ - Returns the given soft body state (see [enum BodyState] constants). + Returns the given soft body state. [b]Note:[/b] Godot's default physics implementation does not support [constant BODY_STATE_LINEAR_VELOCITY], [constant BODY_STATE_ANGULAR_VELOCITY], [constant BODY_STATE_SLEEPING], or [constant BODY_STATE_CAN_SLEEP]. @@ -1331,7 +1331,7 @@ - Sets the given body state for the given body (see [enum BodyState] constants). + Sets the given body state for the given body. [b]Note:[/b] Godot's default physics implementation does not support [constant BODY_STATE_LINEAR_VELOCITY], [constant BODY_STATE_ANGULAR_VELOCITY], [constant BODY_STATE_SLEEPING], or [constant BODY_STATE_CAN_SLEEP]. diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml index e8947ffd678..575ae01ab34 100644 --- a/doc/classes/PlaneMesh.xml +++ b/doc/classes/PlaneMesh.xml @@ -14,7 +14,7 @@ Offset of the generated plane. Useful for particles. - Direction that the [PlaneMesh] is facing. See [enum Orientation] for options. + Direction that the [PlaneMesh] is facing. Size of the generated plane. diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 54edd2cada1..d8df2ec3b65 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -630,7 +630,7 @@ - Returns the unique identifier of the driver [param resource] for the specified [param rid]. Some driver resource types ignore the specified [param rid] (see [enum DriverResource] descriptions). [param index] is always ignored but must be specified anyway. + Returns the unique identifier of the driver [param resource] for the specified [param rid]. Some driver resource types ignore the specified [param rid]. [param index] is always ignored but must be specified anyway. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index e1def286cd0..bff45f8b8b1 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -72,7 +72,7 @@ - Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see [enum DOFBokehShape]. + Sets the shape of the DOF bokeh pattern to [param shape]. Different shapes may be used to achieve artistic effect, or to meet performance targets. @@ -80,7 +80,7 @@ - Sets the quality level of the DOF blur effect to one of the options in [enum DOFBlurQuality]. [param use_jitter] can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy. + Sets the quality level of the DOF blur effect to [param quality]. [param use_jitter] can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy. @@ -791,7 +791,7 @@ - Sets the blend mode for the given canvas light. See [enum CanvasLightBlendMode] for options. Equivalent to [member Light2D.blend_mode]. + Sets the blend mode for the given canvas light to [param mode]. Equivalent to [member Light2D.blend_mode]. @@ -864,7 +864,7 @@ - The mode of the light, see [enum CanvasLightMode] constants. + Sets the mode of the canvas light. @@ -888,7 +888,7 @@ - Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants. + Sets the canvas light's shadow's filter. @@ -962,7 +962,7 @@ - Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants. + Sets an occluder polygon's cull mode. @@ -1629,7 +1629,7 @@ - Returns a statistic about the rendering engine which can be used for performance profiling. See [enum RenderingServer.RenderingInfo] for a list of values that can be queried. See also [method viewport_get_render_info], which returns information specific to a viewport. + Returns a statistic about the rendering engine which can be used for performance profiling. See also [method viewport_get_render_info], which returns information specific to a viewport. [b]Note:[/b] Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls. [b]Note:[/b] Rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, [method get_rendering_info] returns [code]0[/code]. To print rendering information in [code]_ready()[/code] successfully, use the following: [codeblock] @@ -1853,7 +1853,7 @@ - Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow]. + Sets the shadow casting setting. Equivalent to [member GeometryInstance3D.cast_shadow]. @@ -1862,7 +1862,7 @@ - Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. + Sets the [param flag] for a given [param instance] to [param enabled]. @@ -2084,7 +2084,7 @@ - Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options. + Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. @@ -2167,7 +2167,7 @@ - Sets the specified 3D light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param]. + Sets the specified 3D light parameter. Equivalent to [method Light3D.set_param]. @@ -3020,7 +3020,7 @@ - Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member GPUParticles3D.draw_order]. + Sets the draw order of the particles. Equivalent to [member GPUParticles3D.draw_order]. @@ -3339,7 +3339,7 @@ - Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options. + Sets how often the reflection probe updates. Can either be once or every frame. @@ -3878,7 +3878,7 @@ - Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass [param type]s, each of them having the same [param info]s you can query (different passes will return different values). See [enum RenderingServer.ViewportRenderInfoType] for a list of render pass types and [enum RenderingServer.ViewportRenderInfo] for a list of information that can be queried. + Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass [param type]s, each of them having the same [param info]s you can query (different passes will return different values). See also [method get_rendering_info], which returns global information across all viewports. [b]Note:[/b] Viewport rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, [method viewport_get_render_info] returns [code]0[/code]. To print rendering information in [code]_ready()[/code] successfully, use the following: [codeblock] @@ -3912,7 +3912,7 @@ - Returns the viewport's update mode. See [enum ViewportUpdateMode] constants for options. + Returns the viewport's update mode. [b]Warning:[/b] Calling this from any thread other than the rendering thread will be detrimental to performance. @@ -3976,7 +3976,7 @@ - Sets the clear mode of a viewport. See [enum ViewportClearMode] for options. + Sets the clear mode of a viewport. @@ -3984,7 +3984,7 @@ - Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options. + Sets the debug draw mode of a viewport. @@ -3992,7 +3992,7 @@ - Sets the default texture filtering mode for the specified [param viewport] RID. See [enum CanvasItemTextureFilter] for options. + Sets the default texture filtering mode for the specified [param viewport] RID. @@ -4000,7 +4000,7 @@ - Sets the default texture repeat mode for the specified [param viewport] RID. See [enum CanvasItemTextureRepeat] for options. + Sets the default texture repeat mode for the specified [param viewport] RID. @@ -4056,7 +4056,7 @@ - Sets the multisample antialiasing mode for 2D/Canvas on the specified [param viewport] RID. See [enum ViewportMSAA] for options. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_2d] or [member Viewport.msaa_2d]. + Sets the multisample antialiasing mode for 2D/Canvas on the specified [param viewport] RID. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_2d] or [member Viewport.msaa_2d]. @@ -4064,7 +4064,7 @@ - Sets the multisample antialiasing mode for 3D on the specified [param viewport] RID. See [enum ViewportMSAA] for options. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_3d] or [member Viewport.msaa_3d]. + Sets the multisample antialiasing mode for 3D on the specified [param viewport] RID. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_3d] or [member Viewport.msaa_3d]. @@ -4205,7 +4205,7 @@ - Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options. + Sets when the viewport should be updated. diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 47bcf574276..a6da2ada124 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -97,7 +97,7 @@ Loads a resource at the given [param path], caching the result for further access. The registered [ResourceFormatLoader]s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. An optional [param type_hint] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. - The [param cache_mode] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. + The [param cache_mode] property defines whether and how the cache should be used or updated when loading the resource. Returns an empty resource if no [ResourceFormatLoader] could handle the file, and prints an error if no file is found at the specified path. GDScript has a simplified [method @GDScript.load] built-in method which can be used in most situations, leaving the use of [ResourceLoader] for more advanced scenarios. [b]Note:[/b] If [member ProjectSettings.editor/export/convert_text_resources_to_binary] is [code]true[/code], [method @GDScript.load] will not be able to read converted files in an exported project. If you rely on run-time loading of files present within the PCK, set [member ProjectSettings.editor/export/convert_text_resources_to_binary] to [code]false[/code]. @@ -117,7 +117,7 @@ - Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [param path]. See [enum ThreadLoadStatus] for possible return values. + Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [param path]. An array variable can optionally be passed via [param progress], and will return a one-element array containing the ratio of completion of the threaded loading (between [code]0.0[/code] and [code]1.0[/code]). [b]Note:[/b] The recommended way of using this method is to call it during different frames (e.g., in [method Node._process], instead of a loop). @@ -130,7 +130,7 @@ Loads the resource using threads. If [param use_sub_threads] is [code]true[/code], multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns). - The [param cache_mode] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. + The [param cache_mode] parameter defines whether and how the cache should be used or updated when loading the resource. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 92ab5efeb29..35e9fc14d0e 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -48,7 +48,7 @@ Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. If [param path] is empty, [ResourceSaver] will try to use [member Resource.resource_path]. - The [param flags] bitmask can be specified to customize the save behavior using [enum SaverFlags] flags. + The [param flags] bitmask can be specified to customize the save behavior. Returns [constant OK] on success. [b]Note:[/b] When the project is running, any generated UID associated with the resource will not be saved as the required code is only executed in editor mode. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 0a2363c1161..7a5d47efc74 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -659,7 +659,7 @@ - If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. Autowrap space trimming flags. See [constant TextServer.BREAK_TRIM_START_EDGE_SPACES] and [constant TextServer.BREAK_TRIM_END_EDGE_SPACES] for more info. @@ -690,10 +690,10 @@ If [code]true[/code], the label underlines hint tags such as [code skip-lint][hint=description]{text}[/hint][/code]. - Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants. + Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. - Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information. + Line fill alignment rules. Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. @@ -740,14 +740,14 @@ If [code]true[/code], text processing is done in a background thread. - Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the [enum VerticalAlignment] constants. + Controls the text's vertical alignment. Supports top, center, bottom, and fill. The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box. [b]Note:[/b] Setting this property updates [member visible_ratio] accordingly. - Sets the clipping behavior when [member visible_characters] or [member visible_ratio] is set. See [enum TextServer.VisibleCharactersBehavior] for more info. + The clipping behavior when [member visible_characters] or [member visible_ratio] is set. The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 1977b238e40..7f7e694fff5 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -127,7 +127,7 @@ See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. - Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + Defines how [member angular_damp] is applied. The body's rotational velocity in [i]radians[/i] per second. @@ -140,7 +140,7 @@ When [member center_of_mass_mode] is set to [constant CENTER_OF_MASS_MODE_AUTO] (default value), the center of mass is automatically computed. - Defines the way the body's center of mass is set. See [enum CenterOfMassMode] for possible values. + Defines the way the body's center of mass is set. The body's total constant positional forces applied during each physics update. @@ -156,7 +156,7 @@ Continuous collision detection mode. - Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See [enum CCDMode] for details. + Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. If [code]true[/code], the standard force integration (like gravity or damping) will be disabled for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] method, if that virtual method is overridden. @@ -168,7 +168,7 @@ For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead. - The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled. See [enum FreezeMode] for possible values. + The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled. For a body that is always frozen, use [StaticBody2D] or [AnimatableBody2D] instead. @@ -205,7 +205,7 @@ See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. - Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + Defines how [member linear_damp] is applied. The body's linear velocity in pixels per second. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. diff --git a/doc/classes/RigidBody3D.xml b/doc/classes/RigidBody3D.xml index de6d5cde3d3..162b0aae9e6 100644 --- a/doc/classes/RigidBody3D.xml +++ b/doc/classes/RigidBody3D.xml @@ -134,7 +134,7 @@ See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. - Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + Defines how [member angular_damp] is applied. The RigidBody3D's rotational velocity in [i]radians[/i] per second. @@ -147,7 +147,7 @@ When [member center_of_mass_mode] is set to [constant CENTER_OF_MASS_MODE_AUTO] (default value), the center of mass is automatically computed. - Defines the way the body's center of mass is set. See [enum CenterOfMassMode] for possible values. + Defines the way the body's center of mass is set. The body's total constant positional forces applied during each physics update. @@ -175,7 +175,7 @@ For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead. - The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled. See [enum FreezeMode] for possible values. + The body's freeze mode. Can be used to set the body's behavior when [member freeze] is enabled. For a body that is always frozen, use [StaticBody3D] or [AnimatableBody3D] instead. @@ -212,7 +212,7 @@ See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. - Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + Defines how [member linear_damp] is applied. The body's linear velocity in units per second. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 959721b115d..3eacd7a4e8a 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -47,7 +47,7 @@ If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible. - Controls whether horizontal scrollbar can be used and when it should be visible. See [enum ScrollMode] for options. + Controls whether horizontal scrollbar can be used and when it should be visible. Deadzone for touch scrolling. Lower deadzone makes the scrolling more sensitive. @@ -75,7 +75,7 @@ Overrides the [member ScrollBar.custom_step] used when clicking the internal scroll bar's vertical increment and decrement buttons or when using arrow keys when the [ScrollBar] is focused. - Controls whether vertical scrollbar can be used and when it should be visible. See [enum ScrollMode] for options. + Controls whether vertical scrollbar can be used and when it should be visible. diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index d92319b390d..3d657261fa1 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -10,11 +10,10 @@ - Sets the method for generating the radiance map from the sky. The radiance map is a cubemap with increasingly blurry versions of the sky corresponding to different levels of roughness. Radiance maps can be expensive to calculate. See [enum ProcessMode] for options. + The method for generating the radiance map from the sky. The radiance map is a cubemap with increasingly blurry versions of the sky corresponding to different levels of roughness. Radiance maps can be expensive to calculate. The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be. - See [enum RadianceSize] constants for values. [b]Note:[/b] Some hardware will have trouble with higher radiance sizes, especially [constant RADIANCE_SIZE_512] and above. Only use such high values on high-end hardware. diff --git a/doc/classes/SliderJoint3D.xml b/doc/classes/SliderJoint3D.xml index 89305144929..1ed86cb9143 100644 --- a/doc/classes/SliderJoint3D.xml +++ b/doc/classes/SliderJoint3D.xml @@ -13,7 +13,7 @@ - Returns the value of the given parameter (see [enum Param] constants). + Returns the value of the given parameter. @@ -21,7 +21,7 @@ - Assigns [param value] to the given parameter (see [enum Param] constants). + Assigns [param value] to the given parameter. diff --git a/doc/classes/SoftBody3D.xml b/doc/classes/SoftBody3D.xml index 042a908bbd2..75834c3052d 100644 --- a/doc/classes/SoftBody3D.xml +++ b/doc/classes/SoftBody3D.xml @@ -138,7 +138,7 @@ The body's damping coefficient. Higher values will slow down the body more noticeably when forces are applied. - Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. + Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. The body's drag coefficient. Higher values increase this body's air resistance. diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index daafbbdd87c..3fa59f97f5f 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -45,7 +45,7 @@ Shifts the drag area in the axis of the container to prevent the drag area from overlapping the [ScrollBar] or other selectable [Control] of a child node. - Determines the dragger's visibility. See [enum DraggerVisibility] for details. This property does not determine whether dragging is enabled or not. Use [member dragging_enabled] for that. + Determines the dragger's visibility. This property does not determine whether dragging is enabled or not. Use [member dragging_enabled] for that. Enables or disables split dragging. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 791699fa4c0..c473a626cae 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -33,7 +33,7 @@ - If [code]true[/code], the specified flag will be enabled. See [enum SpriteBase3D.DrawFlags] for a list of flags. + If [code]true[/code], the specified flag will be enabled. @@ -42,10 +42,10 @@ Threshold at which antialiasing will be applied on the alpha channel. - The type of alpha antialiasing to apply. See [enum BaseMaterial3D.AlphaAntiAliasing]. + The type of alpha antialiasing to apply. - The alpha cutting mode to use for the sprite. See [enum AlphaCutMode] for possible values. + The alpha cutting mode to use for the sprite. The hashing scale for Alpha Hash. Recommended values between [code]0[/code] and [code]2[/code]. @@ -57,7 +57,7 @@ The direction in which the front of the texture faces. - The billboard mode to use for the sprite. See [enum BaseMaterial3D.BillboardMode] for possible values. + The billboard mode to use for the sprite. [b]Note:[/b] When billboarding is enabled and the material also casts shadows, billboards will face [b]the[/b] camera in the scene when rendering shadows. In scenes with multiple cameras, the intended shadow cannot be determined and this will result in undefined behavior. See [url=https://github.com/godotengine/godot/pull/72638]GitHub Pull Request #72638[/url] for details. @@ -99,7 +99,7 @@ If [code]true[/code], the [Light3D] in the [Environment] has effects on the sprite. - Filter flags for the texture. See [enum BaseMaterial3D.TextureFilter] for options. + Filter flags for the texture. [b]Note:[/b] Linear filtering may cause artifacts around the edges, which are especially noticeable on opaque textures. To prevent this, use textures with transparent or identical colors around the edges. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index a7880fb4849..2824aae4610 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -54,7 +54,7 @@ - Returns the status of the connection, see [enum Status]. + Returns the status of the connection. diff --git a/doc/classes/StreamPeerTLS.xml b/doc/classes/StreamPeerTLS.xml index ace060f709d..8f19ca4dbf3 100644 --- a/doc/classes/StreamPeerTLS.xml +++ b/doc/classes/StreamPeerTLS.xml @@ -37,7 +37,7 @@ - Returns the status of the connection. See [enum Status] for values. + Returns the status of the connection. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 8c629b12c51..cf09043bbb4 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -37,7 +37,7 @@ - Returns the given [param corner]'s radius. See [enum Corner] for possible values. + Returns the given [param corner]'s radius. @@ -67,7 +67,7 @@ - Sets the corner radius to [param radius] pixels for the given [param corner]. See [enum Corner] for possible values. + Sets the corner radius to [param radius] pixels for the given [param corner]. diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 07d4b13f362..109b5da9ba3 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -56,10 +56,10 @@ - Controls how the stylebox's texture will be stretched or tiled horizontally. See [enum AxisStretchMode] for possible values. + Controls how the stylebox's texture will be stretched or tiled horizontally. - Controls how the stylebox's texture will be stretched or tiled vertically. See [enum AxisStretchMode] for possible values. + Controls how the stylebox's texture will be stretched or tiled vertically. If [code]true[/code], the nine-patch texture's center tile will be drawn. diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml index 5d0b25a8ded..bb9d9d27d30 100644 --- a/doc/classes/TabBar.xml +++ b/doc/classes/TabBar.xml @@ -271,10 +271,10 @@ If [code]true[/code], enables selecting a tab with the right mouse button. - Sets the position at which tabs will be placed. See [enum AlignmentMode] for details. + The position at which tabs will be placed. - Sets when the close button will appear on the tabs. See [enum CloseButtonDisplayPolicy] for details. + When the close button will appear on the tabs. The number of tabs currently in the bar. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 8244ee0fe0b..e8c1eea593a 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -224,13 +224,13 @@ If [code]true[/code], tabs can be rearranged with mouse drag. - Sets the position at which tabs will be placed. See [enum TabBar.AlignmentMode] for details. + The position at which tabs will be placed. The focus access mode for the internal [TabBar] node. - Sets the position of the tab bar. See [enum TabPosition] for details. + The position of the tab bar. [TabContainer]s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with [member drag_to_rearrange_enabled]. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d6591e2a325..c0cfdc7b09f 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -295,7 +295,7 @@ - Returns the type of the gutter at the given index. Gutters can contain icons, text, or custom visuals. See [enum TextEdit.GutterType] for options. + Returns the type of the gutter at the given index. Gutters can contain icons, text, or custom visuals. @@ -1085,7 +1085,7 @@ - Sets the type of gutter at the given index. Gutters can contain icons, text, or custom visuals. See [enum TextEdit.GutterType] for options. + Sets the type of gutter at the given index. Gutters can contain icons, text, or custom visuals. @@ -1281,7 +1281,7 @@ - If [member wrap_mode] is set to [constant LINE_WRAPPING_BOUNDARY], sets text wrapping mode. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + If [member wrap_mode] is set to [constant LINE_WRAPPING_BOUNDARY], sets text wrapping mode. If [code]true[/code] and [member caret_mid_grapheme] is [code]false[/code], backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character. diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml index ef06269803c..d343e37e7fd 100644 --- a/doc/classes/TextLine.xml +++ b/doc/classes/TextLine.xml @@ -175,7 +175,7 @@ If set to [code]true[/code] text will display invalid characters. - Sets the clipping behavior when the text exceeds the text line's set width. See [enum TextServer.OverrunBehavior] for a description of all modes. + The clipping behavior when the text exceeds the text line's set width. Text line width. diff --git a/doc/classes/TextMesh.xml b/doc/classes/TextMesh.xml index b6b1052af5f..481930c3039 100644 --- a/doc/classes/TextMesh.xml +++ b/doc/classes/TextMesh.xml @@ -13,7 +13,7 @@ - If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see [enum TextServer.AutowrapMode]. + If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Step (in pixels) used to approximate Bézier curves. @@ -28,10 +28,10 @@ Font size of the [TextMesh]'s text. - Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants. + Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. - Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information. + Line fill alignment rules. Language code used for text shaping algorithms, if left empty current locale is used instead. @@ -62,7 +62,7 @@ If [code]true[/code], all the text displays as UPPERCASE. - Controls the text's vertical alignment. Supports top, center, bottom. Set it to one of the [enum VerticalAlignment] constants. + Controls the text's vertical alignment. Supports top, center, and bottom. Text width (in pixels), used for fill alignment. diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index ae7ed95418c..7a73203401e 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -296,7 +296,7 @@ Ellipsis character used for text clipping. - Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information. + Line fill alignment rules. Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative. @@ -314,7 +314,7 @@ If set to [code]true[/code] text will display invalid characters. - Sets the clipping behavior when the text exceeds the paragraph's set width. See [enum TextServer.OverrunBehavior] for a description of all modes. + The clipping behavior when the text exceeds the paragraph's set width. Paragraph width. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 22012e11502..6023cd23665 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -448,7 +448,7 @@ - Returns the spacing for [param spacing] (see [enum TextServer.SpacingType]) in pixels (not relative to the font size). + Returns the spacing for [param spacing] in pixels (not relative to the font size). @@ -462,7 +462,7 @@ - Returns font style flags, see [enum FontStyle]. + Returns font style flags. @@ -960,7 +960,7 @@ - Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). + Sets the spacing for [param spacing] to [param value] in pixels (not relative to the font size). @@ -977,7 +977,7 @@ - Sets the font style flags, see [enum FontStyle]. + Sets the font style flags. [b]Note:[/b] This value is used for font matching only and will not affect font rendering. Use [method font_set_face_index], [method font_set_variation_coordinates], [method font_set_embolden], or [method font_set_transform] instead. @@ -1211,7 +1211,7 @@ - Default implementation of the BiDi algorithm override function. See [enum StructuredTextParser] for more info. + Default implementation of the BiDi algorithm override function. @@ -1682,7 +1682,7 @@ - Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking (see [enum GraphemeFlag]). + Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking. diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index db3deedbdf0..65bfbe35541 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -478,7 +478,7 @@ [b]Optional.[/b] - Returns the spacing for [param spacing] (see [enum TextServer.SpacingType]) in pixels (not relative to the font size). + Returns the spacing for [param spacing] in pixels (not relative to the font size). @@ -494,7 +494,7 @@ [b]Optional.[/b] - Returns font style flags, see [enum TextServer.FontStyle]. + Returns font style flags. @@ -1057,7 +1057,7 @@ [b]Optional.[/b] - Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size). + Sets the spacing for [param spacing] to [param value] in pixels (not relative to the font size). @@ -1075,7 +1075,7 @@ [b]Optional.[/b] - Sets the font style flags, see [enum TextServer.FontStyle]. + Sets the font style flags. @@ -1321,7 +1321,7 @@ [b]Optional.[/b] - Default implementation of the BiDi algorithm override function. See [enum TextServer.StructuredTextParser] for more info. + Default implementation of the BiDi algorithm override function. @@ -1855,7 +1855,7 @@ [b]Optional.[/b] - Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking (see [enum TextServer.GraphemeFlag]). + Breaks text into words and returns array of character ranges. Use [param grapheme_flags] to set what characters are used for breaking. diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml index 2b1bc026c2c..4886bd60ff2 100644 --- a/doc/classes/Texture3D.xml +++ b/doc/classes/Texture3D.xml @@ -68,7 +68,7 @@ - Returns the current format being used by this texture. See [enum Image.Format] for details. + Returns the current format being used by this texture. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 05443f809fb..f4a4ce51f33 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -59,7 +59,7 @@ - Returns the current format being used by this texture. See [enum Image.Format] for details. + Returns the current format being used by this texture. diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml index ab268b6ea50..d7fcd1c77aa 100644 --- a/doc/classes/TextureRect.xml +++ b/doc/classes/TextureRect.xml @@ -11,7 +11,7 @@ - Defines how minimum size is determined based on the texture's size. See [enum ExpandMode] for options. + Defines how minimum size is determined based on the texture's size. If [code]true[/code], texture is flipped horizontally. @@ -21,7 +21,7 @@ - Controls the texture's behavior when resizing the node's bounding rectangle. See [enum StretchMode]. + Controls the texture's behavior when resizing the node's bounding rectangle. The node's [Texture2D] resource. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index c29e67340e7..3fcde534cfd 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -55,7 +55,7 @@ If [code]true[/code], the timer is paused. A paused timer does not process until this property is set back to [code]false[/code], even when [method start] is called. - Specifies when the timer is updated during the main loop (see [enum TimerProcessCallback]). + Specifies when the timer is updated during the main loop. The timer's remaining time in seconds. This is always [code]0[/code] if the timer is stopped. diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index faeaaba5b66..1715ea6e826 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -45,7 +45,7 @@ The button's texture for the pressed state. - The button's visibility mode. See [enum VisibilityMode] for possible values. + The button's visibility mode. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 7901d3d0913..c7e5e51d0ba 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -589,7 +589,7 @@ - Sets the given column's cell mode to [param mode]. This determines how the cell is displayed and edited. See [enum TreeCellMode] constants for details. + Sets the given column's cell mode to [param mode]. This determines how the cell is displayed and edited. @@ -822,7 +822,7 @@ - Sets the given column's text alignment. See [enum HorizontalAlignment] for possible values. + Sets the given column's text alignment to [param text_alignment]. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 8a8a742fba5..3d2202c7b43 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -261,7 +261,7 @@ - Determines the behavior of the [Tween] when the [SceneTree] is paused. Check [enum TweenPauseMode] for options. + Determines the behavior of the [Tween] when the [SceneTree] is paused. Default value is [constant TWEEN_PAUSE_BOUND]. diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index e197f7748c9..489c4694f41 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -178,7 +178,7 @@ Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. - The way actions are merged is dictated by [param merge_mode]. See [enum MergeMode] for details. + The way actions are merged is dictated by [param merge_mode]. The way undo operation are ordered in actions is dictated by [param backward_undo_ops]. When [param backward_undo_ops] is [code]false[/code] undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index b3d8ee51409..7fde4302629 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -101,7 +101,7 @@ - Returns rendering statistics of the given type. See [enum RenderInfoType] and [enum RenderInfo] for options. + Returns rendering statistics of the given type. @@ -317,10 +317,10 @@ The rendering layers in which this [Viewport] renders [CanvasItem] nodes. - Sets the default filter mode used by [CanvasItem]s in this Viewport. See [enum DefaultCanvasItemTextureFilter] for options. + Sets the default filter mode used by [CanvasItem]s in this Viewport. - Sets the default repeat mode used by [CanvasItem]s in this Viewport. See [enum DefaultCanvasItemTextureRepeat] for options. + Sets the default repeat mode used by [CanvasItem]s in this Viewport. The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. diff --git a/doc/classes/VisualShaderNodeBillboard.xml b/doc/classes/VisualShaderNodeBillboard.xml index 2fd31c78cb9..a81b09e93fa 100644 --- a/doc/classes/VisualShaderNodeBillboard.xml +++ b/doc/classes/VisualShaderNodeBillboard.xml @@ -10,7 +10,7 @@ - Controls how the object faces the camera. See [enum BillboardType]. + Controls how the object faces the camera. If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. diff --git a/doc/classes/VisualShaderNodeColorFunc.xml b/doc/classes/VisualShaderNodeColorFunc.xml index aa2dcca1d58..6193c10f148 100644 --- a/doc/classes/VisualShaderNodeColorFunc.xml +++ b/doc/classes/VisualShaderNodeColorFunc.xml @@ -10,7 +10,7 @@ - A function to be applied to the input color. See [enum Function] for options. + A function to be applied to the input color. diff --git a/doc/classes/VisualShaderNodeColorOp.xml b/doc/classes/VisualShaderNodeColorOp.xml index b5454da1f9e..758eb7cc680 100644 --- a/doc/classes/VisualShaderNodeColorOp.xml +++ b/doc/classes/VisualShaderNodeColorOp.xml @@ -10,7 +10,7 @@ - An operator to be applied to the inputs. See [enum Operator] for options. + An operator to be applied to the inputs. diff --git a/doc/classes/VisualShaderNodeCompare.xml b/doc/classes/VisualShaderNodeCompare.xml index 9f554dacb44..63f51f2f0e9 100644 --- a/doc/classes/VisualShaderNodeCompare.xml +++ b/doc/classes/VisualShaderNodeCompare.xml @@ -13,10 +13,10 @@ Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR_3D]. - A comparison function. See [enum Function] for options. + A comparison function. - The type to be used in the comparison. See [enum ComparisonType] for options. + The type to be used in the comparison. diff --git a/doc/classes/VisualShaderNodeCubemap.xml b/doc/classes/VisualShaderNodeCubemap.xml index 6f3df9865aa..7647574a5f6 100644 --- a/doc/classes/VisualShaderNodeCubemap.xml +++ b/doc/classes/VisualShaderNodeCubemap.xml @@ -13,10 +13,10 @@ The [Cubemap] texture to sample when using [constant SOURCE_TEXTURE] as [member source]. - Defines which source should be used for the sampling. See [enum Source] for options. + Defines which source should be used for the sampling. - Defines the type of data provided by the source texture. See [enum TextureType] for options. + Defines the type of data provided by the source texture. diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index 5db0dfb3277..4bcb74e0b28 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -33,7 +33,7 @@ Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). The [param input_vars] and [param output_vars] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. The output ports can be assigned values in the shader code. For example, [code]return output_vars[0] + " = " + input_vars[0] + ";"[/code]. - You can customize the generated code based on the shader [param mode] (see [enum Shader.Mode]) and/or [param type] (see [enum VisualShader.Type]). + You can customize the generated code based on the shader [param mode] and/or [param type]. Defining this method is [b]required[/b]. @@ -59,7 +59,7 @@ Override this method to add a shader code to the beginning of each shader function (once). The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). If there are multiple custom nodes of different types which use this feature the order of each insertion is undefined. - You can customize the generated code based on the shader [param mode] (see [enum Shader.Mode]) and/or [param type] (see [enum VisualShader.Type]). + You can customize the generated code based on the shader [param mode] and/or [param type]. Defining this method is [b]optional[/b]. @@ -69,7 +69,7 @@ Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. - You can customize the generated code based on the shader [param mode] (see [enum Shader.Mode]). + You can customize the generated code based on the shader [param mode]. Defining this method is [b]optional[/b]. @@ -100,7 +100,7 @@ - Override this method to define the returned type of each input port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). + Override this method to define the returned type of each input port of the associated custom node. Defining this method is [b]optional[/b], but recommended. If not overridden, input ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -130,7 +130,7 @@ - Override this method to define the returned type of each output port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). + Override this method to define the returned type of each output port of the associated custom node. Defining this method is [b]optional[/b], but recommended. If not overridden, output ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. @@ -177,7 +177,7 @@ - Override this method to prevent the node to be visible in the member dialog for the certain [param mode] (see [enum Shader.Mode]) and/or [param type] (see [enum VisualShader.Type]). + Override this method to prevent the node to be visible in the member dialog for the certain [param mode] and/or [param type]. Defining this method is [b]optional[/b]. If not overridden, it's [code]true[/code]. diff --git a/doc/classes/VisualShaderNodeDerivativeFunc.xml b/doc/classes/VisualShaderNodeDerivativeFunc.xml index c9bed5ead9b..49a189995fe 100644 --- a/doc/classes/VisualShaderNodeDerivativeFunc.xml +++ b/doc/classes/VisualShaderNodeDerivativeFunc.xml @@ -10,13 +10,13 @@ - A derivative function type. See [enum Function] for options. + A derivative function type. - A type of operands and returned value. See [enum OpType] for options. + A type of operands and returned value. - Sets the level of precision to use for the derivative function. See [enum Precision] for options. When using the Compatibility renderer, this setting has no effect. + Sets the level of precision to use for the derivative function. When using the Compatibility renderer, this setting has no effect. diff --git a/doc/classes/VisualShaderNodeFloatFunc.xml b/doc/classes/VisualShaderNodeFloatFunc.xml index 8cde07bfccd..79abbf1a91f 100644 --- a/doc/classes/VisualShaderNodeFloatFunc.xml +++ b/doc/classes/VisualShaderNodeFloatFunc.xml @@ -10,7 +10,7 @@ - A function to be applied to the scalar. See [enum Function] for options. + A function to be applied to the scalar. diff --git a/doc/classes/VisualShaderNodeFloatOp.xml b/doc/classes/VisualShaderNodeFloatOp.xml index de95a3f174f..6e97dd7767a 100644 --- a/doc/classes/VisualShaderNodeFloatOp.xml +++ b/doc/classes/VisualShaderNodeFloatOp.xml @@ -10,7 +10,7 @@ - An operator to be applied to the inputs. See [enum Operator] for options. + An operator to be applied to the inputs. diff --git a/doc/classes/VisualShaderNodeIntFunc.xml b/doc/classes/VisualShaderNodeIntFunc.xml index 51e3faecd3f..aade8be07da 100644 --- a/doc/classes/VisualShaderNodeIntFunc.xml +++ b/doc/classes/VisualShaderNodeIntFunc.xml @@ -10,7 +10,7 @@ - A function to be applied to the scalar. See [enum Function] for options. + A function to be applied to the scalar. diff --git a/doc/classes/VisualShaderNodeIntOp.xml b/doc/classes/VisualShaderNodeIntOp.xml index 1aef337e01f..539f6b7c2d7 100644 --- a/doc/classes/VisualShaderNodeIntOp.xml +++ b/doc/classes/VisualShaderNodeIntOp.xml @@ -10,7 +10,7 @@ - An operator to be applied to the inputs. See [enum Operator] for options. + An operator to be applied to the inputs. diff --git a/doc/classes/VisualShaderNodeIs.xml b/doc/classes/VisualShaderNodeIs.xml index fa5c83771e0..45df5852885 100644 --- a/doc/classes/VisualShaderNodeIs.xml +++ b/doc/classes/VisualShaderNodeIs.xml @@ -10,7 +10,7 @@ - The comparison function. See [enum Function] for options. + The comparison function. diff --git a/doc/classes/VisualShaderNodeTexture.xml b/doc/classes/VisualShaderNodeTexture.xml index eda09573adb..79a50508468 100644 --- a/doc/classes/VisualShaderNodeTexture.xml +++ b/doc/classes/VisualShaderNodeTexture.xml @@ -10,13 +10,13 @@ - Determines the source for the lookup. See [enum Source] for options. + Determines the source for the lookup. The source texture, if needed for the selected [member source]. - Specifies the type of the texture if [member source] is set to [constant SOURCE_TEXTURE]. See [enum TextureType] for options. + Specifies the type of the texture if [member source] is set to [constant SOURCE_TEXTURE]. diff --git a/doc/classes/VisualShaderNodeTextureParameter.xml b/doc/classes/VisualShaderNodeTextureParameter.xml index aa64016746f..9aa56eed16b 100644 --- a/doc/classes/VisualShaderNodeTextureParameter.xml +++ b/doc/classes/VisualShaderNodeTextureParameter.xml @@ -13,16 +13,16 @@ Sets the default color if no texture is assigned to the uniform. - Sets the texture filtering mode. See [enum TextureFilter] for options. + Sets the texture filtering mode. - Sets the texture repeating mode. See [enum TextureRepeat] for options. + Sets the texture repeating mode. - Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture. See [enum TextureSource] for options. + Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture. - Defines the type of data provided by the source texture. See [enum TextureType] for options. + Defines the type of data provided by the source texture. diff --git a/doc/classes/VisualShaderNodeTransformFunc.xml b/doc/classes/VisualShaderNodeTransformFunc.xml index 50070c87259..a753c77e0b8 100644 --- a/doc/classes/VisualShaderNodeTransformFunc.xml +++ b/doc/classes/VisualShaderNodeTransformFunc.xml @@ -10,7 +10,7 @@ - The function to be computed. See [enum Function] for options. + The function to be computed. diff --git a/doc/classes/VisualShaderNodeTransformOp.xml b/doc/classes/VisualShaderNodeTransformOp.xml index 0993fd52e69..9261e9adc00 100644 --- a/doc/classes/VisualShaderNodeTransformOp.xml +++ b/doc/classes/VisualShaderNodeTransformOp.xml @@ -10,7 +10,7 @@ - The type of the operation to be performed on the transforms. See [enum Operator] for options. + The type of the operation to be performed on the transforms. diff --git a/doc/classes/VisualShaderNodeTransformVecMult.xml b/doc/classes/VisualShaderNodeTransformVecMult.xml index 27953d4c19e..c461b7986bb 100644 --- a/doc/classes/VisualShaderNodeTransformVecMult.xml +++ b/doc/classes/VisualShaderNodeTransformVecMult.xml @@ -10,7 +10,7 @@ - The multiplication type to be performed. See [enum Operator] for options. + The multiplication type to be performed. diff --git a/doc/classes/VisualShaderNodeUIntFunc.xml b/doc/classes/VisualShaderNodeUIntFunc.xml index 8f26060a461..dee14c60251 100644 --- a/doc/classes/VisualShaderNodeUIntFunc.xml +++ b/doc/classes/VisualShaderNodeUIntFunc.xml @@ -10,7 +10,7 @@ - A function to be applied to the scalar. See [enum Function] for options. + A function to be applied to the scalar. diff --git a/doc/classes/VisualShaderNodeUIntOp.xml b/doc/classes/VisualShaderNodeUIntOp.xml index a8c3586cc8d..5dd2d54e419 100644 --- a/doc/classes/VisualShaderNodeUIntOp.xml +++ b/doc/classes/VisualShaderNodeUIntOp.xml @@ -10,7 +10,7 @@ - An operator to be applied to the inputs. See [enum Operator] for options. + An operator to be applied to the inputs. diff --git a/doc/classes/VisualShaderNodeUVFunc.xml b/doc/classes/VisualShaderNodeUVFunc.xml index 8ba4b3a1d81..c4bb8b600e9 100644 --- a/doc/classes/VisualShaderNodeUVFunc.xml +++ b/doc/classes/VisualShaderNodeUVFunc.xml @@ -10,7 +10,7 @@ - A function to be applied to the texture coordinates. See [enum Function] for options. + A function to be applied to the texture coordinates. diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml index 47691bd442f..6215d60bd59 100644 --- a/doc/classes/VisualShaderNodeVectorFunc.xml +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -10,7 +10,7 @@ - The function to be performed. See [enum Function] for options. + The function to be performed. diff --git a/doc/classes/VisualShaderNodeVectorOp.xml b/doc/classes/VisualShaderNodeVectorOp.xml index d31460787d6..7a4b68c1470 100644 --- a/doc/classes/VisualShaderNodeVectorOp.xml +++ b/doc/classes/VisualShaderNodeVectorOp.xml @@ -10,7 +10,7 @@ - The operator to be used. See [enum Operator] for options. + The operator to be used. diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 88bec276d01..5e1fb8b9d96 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -623,7 +623,7 @@ If [code]true[/code], native window will be used regardless of parent viewport and project settings. - Specifies the initial type of position for the [Window]. See [enum WindowInitialPosition] constants. + Specifies the initial type of position for the [Window]. If [code]true[/code], the [Window] width is expanded to keep the title bar text fully visible. diff --git a/doc/classes/XRBodyTracker.xml b/doc/classes/XRBodyTracker.xml index 06a48799531..9e4081e677a 100644 --- a/doc/classes/XRBodyTracker.xml +++ b/doc/classes/XRBodyTracker.xml @@ -15,7 +15,7 @@ - Returns flags about the validity of the tracking data for the given body joint (see [enum XRBodyTracker.JointFlags]). + Returns flags about the validity of the tracking data for the given body joint. diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index d322b137951..f37c69f93a3 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -32,7 +32,7 @@ - Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand]. + Returns the hand holding this controller, if known. diff --git a/doc/classes/XRHandTracker.xml b/doc/classes/XRHandTracker.xml index 79ea237480a..cba010ce186 100644 --- a/doc/classes/XRHandTracker.xml +++ b/doc/classes/XRHandTracker.xml @@ -22,7 +22,7 @@ - Returns flags about the validity of the tracking data for the given hand joint (see [enum XRHandTracker.HandJointFlags]). + Returns flags about the validity of the tracking data for the given hand joint. diff --git a/modules/enet/doc_classes/ENetConnection.xml b/modules/enet/doc_classes/ENetConnection.xml index 84534fec066..940d3be7588 100644 --- a/modules/enet/doc_classes/ENetConnection.xml +++ b/modules/enet/doc_classes/ENetConnection.xml @@ -129,7 +129,7 @@ - Returns and resets host statistics. See [enum HostStatistic] for more info. + Returns and resets host statistics. diff --git a/modules/enet/doc_classes/ENetPacketPeer.xml b/modules/enet/doc_classes/ENetPacketPeer.xml index 659cea974c9..6ef16ee668c 100644 --- a/modules/enet/doc_classes/ENetPacketPeer.xml +++ b/modules/enet/doc_classes/ENetPacketPeer.xml @@ -39,14 +39,14 @@ - Returns the current peer state. See [enum PeerState]. + Returns the current peer state. - Returns the requested [param statistic] for this peer. See [enum PeerStatistic]. + Returns the requested [param statistic] for this peer. diff --git a/modules/gltf/doc_classes/GLTFDocument.xml b/modules/gltf/doc_classes/GLTFDocument.xml index 39657a4684a..ee7d91c29f4 100644 --- a/modules/gltf/doc_classes/GLTFDocument.xml +++ b/modules/gltf/doc_classes/GLTFDocument.xml @@ -130,11 +130,11 @@ If [member image_format] is a lossy image format, this determines the lossy quality of the image. On a range of [code]0.0[/code] to [code]1.0[/code], where [code]0.0[/code] is the lowest quality and [code]1.0[/code] is the highest quality. A lossy quality of [code]1.0[/code] is not the same as lossless. - How to process the root node during export. See [enum RootNodeMode] for details. The default and recommended value is [constant ROOT_NODE_MODE_SINGLE_ROOT]. + How to process the root node during export. The default and recommended value is [constant ROOT_NODE_MODE_SINGLE_ROOT]. [b]Note:[/b] Regardless of how the glTF file is exported, when importing, the root node type and name can be overridden in the scene import settings tab. - How to deal with node visibility during export. This setting does nothing if all nodes are visible. See [enum VisibilityMode] for details. The default and recommended value is [constant VISIBILITY_MODE_INCLUDE_REQUIRED], which uses the [code]KHR_node_visibility[/code] extension. + How to deal with node visibility during export. This setting does nothing if all nodes are visible. The default and recommended value is [constant VISIBILITY_MODE_INCLUDE_REQUIRED], which uses the [code]KHR_node_visibility[/code] extension. diff --git a/modules/gltf/doc_classes/GLTFObjectModelProperty.xml b/modules/gltf/doc_classes/GLTFObjectModelProperty.xml index 92f90ec7e84..434ca0dbded 100644 --- a/modules/gltf/doc_classes/GLTFObjectModelProperty.xml +++ b/modules/gltf/doc_classes/GLTFObjectModelProperty.xml @@ -70,7 +70,7 @@ In most cases [member node_paths] will only have one item, but in some cases a single glTF JSON pointer will map to multiple Godot properties. For example, a [GLTFCamera] or [GLTFLight] used on multiple glTF nodes will be represented by multiple Godot nodes. - The type of data stored in the glTF file as defined by the object model. This is a superset of the available accessor types, and determines the accessor type. See [enum GLTFObjectModelType] for possible values. + The type of data stored in the glTF file as defined by the object model. This is a superset of the available accessor types, and determines the accessor type. The type of data stored in the Godot property. This is the type of the property that the [member node_paths] point to. diff --git a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml index edcaa3baef5..74c2194eaf9 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml @@ -69,7 +69,7 @@ If [member root_path] was spawned by a [MultiplayerSpawner], the node will be also be spawned and despawned based on this synchronizer visibility options. - Specifies when visibility filters are updated (see [enum VisibilityUpdateMode] for options). + Specifies when visibility filters are updated. diff --git a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml index a4f7fad2f0a..f2a9ed3ef29 100644 --- a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml +++ b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml @@ -41,7 +41,7 @@ - Returns the replication mode for the property identified by the given [param path]. See [enum ReplicationMode]. + Returns the replication mode for the property identified by the given [param path]. @@ -70,7 +70,7 @@ - Sets the synchronization mode for the property identified by the given [param path]. See [enum ReplicationMode]. + Sets the synchronization mode for the property identified by the given [param path]. diff --git a/modules/noise/doc_classes/FastNoiseLite.xml b/modules/noise/doc_classes/FastNoiseLite.xml index e29581693bd..d3d12bbc0a6 100644 --- a/modules/noise/doc_classes/FastNoiseLite.xml +++ b/modules/noise/doc_classes/FastNoiseLite.xml @@ -11,13 +11,13 @@ - Determines how the distance to the nearest/second-nearest point is computed. See [enum CellularDistanceFunction] for options. + Determines how the distance to the nearest/second-nearest point is computed. Maximum distance a point can move off of its grid position. Set to [code]0[/code] for an even grid. - Return type from cellular noise calculations. See [enum CellularReturnType]. + Return type from cellular noise calculations. Sets the maximum warp distance from the origin. @@ -36,13 +36,13 @@ The number of noise layers that are sampled to get the final value for the fractal noise which warps the space. - The method for combining octaves into a fractal which is used to warp the space. See [enum DomainWarpFractalType]. + The method for combining octaves into a fractal which is used to warp the space. Frequency of the noise which warps the space. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. - Sets the warp algorithm. See [enum DomainWarpType]. + The warp algorithm. Determines the strength of each subsequent layer of noise in fractal noise. @@ -58,7 +58,7 @@ Sets the strength of the fractal ping pong type. - The method for combining octaves into a fractal. See [enum FractalType]. + The method for combining octaves into a fractal. Higher weighting means higher octaves have less impact if lower octaves have a large impact. @@ -67,7 +67,7 @@ The frequency for all noise types. Low frequency results in smooth noise while high frequency results in rougher, more granular noise. - The noise algorithm used. See [enum NoiseType]. + The noise algorithm used. Translate the noise input coordinates by the given [Vector3]. diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml index 82ac179611e..4eddca0eee9 100644 --- a/modules/upnp/doc_classes/UPNPDevice.xml +++ b/modules/upnp/doc_classes/UPNPDevice.xml @@ -55,7 +55,7 @@ IGD service type. - IGD status. See [enum IGDStatus]. + IGD status. Service type. diff --git a/modules/webrtc/doc_classes/WebRTCDataChannel.xml b/modules/webrtc/doc_classes/WebRTCDataChannel.xml index f24fdb4800b..0d3063203f3 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannel.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannel.xml @@ -55,7 +55,7 @@ - Returns the current state of this channel, see [enum ChannelState]. + Returns the current state of this channel. diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 8698c5755a7..97f16113552 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -64,7 +64,7 @@ - Returns the connection state. See [enum ConnectionState]. + Returns the connection state. diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 88f1f4ae0b4..eaff5eed66e 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -100,7 +100,7 @@ - Returns the ready state of the connection. See [enum State]. + Returns the ready state of the connection.