diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index ce7bf4ef5cc..dc7bbe0e4f9 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -362,7 +362,7 @@ [/codeblock] - + @@ -518,7 +518,7 @@ [/codeblocks] - + @@ -537,7 +537,7 @@ See also [method lerp], which performs the reverse of this operation, and [method remap] to map a continuous series of values to another. - + @@ -615,7 +615,7 @@ This function is faster than using [method is_equal_approx] with one value as zero. - + @@ -630,7 +630,7 @@ [b]Note:[/b] For better type safety, use [method lerpf], [method Vector2.lerp], [method Vector3.lerp], [method Vector4.lerp], [method Color.lerp], [method Quaternion.slerp] or [method Basis.slerp]. - + @@ -1080,7 +1080,7 @@ [b]Note:[/b] This function is called automatically when the project is run. If you need to fix the seed to have consistent, reproducible results, use [method seed] to initialize the random number generator. - + diff --git a/doc/classes/AudioListener2D.xml b/doc/classes/AudioListener2D.xml index 8328e82dbdc..85505438e73 100644 --- a/doc/classes/AudioListener2D.xml +++ b/doc/classes/AudioListener2D.xml @@ -1,5 +1,5 @@ - + Overrides the location sounds are heard from. diff --git a/doc/classes/AudioListener3D.xml b/doc/classes/AudioListener3D.xml index a5fe0153c47..c9de0891953 100644 --- a/doc/classes/AudioListener3D.xml +++ b/doc/classes/AudioListener3D.xml @@ -1,5 +1,5 @@ - + Overrides the location sounds are heard from. diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index ac50a5ee30e..fbe2508da33 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -1,5 +1,5 @@ - + Plays back audio non-positionally. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 77a038c5fa7..8b818879769 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -1,5 +1,5 @@ - + Plays positional sound in 2D space. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index f4c9adcaec3..af92fd4a44c 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -1,5 +1,5 @@ - + Plays positional sound in 3D space. diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index c5998ad8a18..764f4a65b52 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -59,7 +59,7 @@ If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] Setting [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal]. - + If [code]true[/code], the button is in disabled state and can't be clicked or toggled. diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index 2a54ae0527a..1bd4183b3c7 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -57,19 +57,19 @@ - + The material's base color. [b]Note:[/b] If [member detail_enabled] is [code]true[/code] and a [member detail_albedo] texture is specified, [member albedo_color] will [i]not[/i] modulate the detail texture. This can be used to color partial areas of a material by not specifying an albedo texture and using a transparent [member detail_albedo] texture instead. - + Texture to multiply by [member albedo_color]. Used for basic texturing of objects. If the texture appears unexpectedly too dark or too bright, check [member albedo_texture_force_srgb]. - + If [code]true[/code], forces a conversion of the [member albedo_texture] from sRGB color space to linear color space. See also [member vertex_color_is_srgb]. This should only be enabled when needed (typically when using a [ViewportTexture] as [member albedo_texture]). If [member albedo_texture_force_srgb] is [code]true[/code] when it shouldn't be, the texture will appear to be too dark. If [member albedo_texture_force_srgb] is [code]false[/code] when it shouldn't be, the texture will appear to be too bright. - + Enables multichannel signed distance field rendering shader. Use [member msdf_pixel_range] and [member msdf_outline_size] to configure MSDF parameters. @@ -81,7 +81,7 @@ The hashing scale for Alpha Hash. Recommended values between [code]0[/code] and [code]2[/code]. - + Threshold at which the alpha scissor will discard values. Higher values will result in more pixels being discarded. If the material becomes too opaque at a distance, try increasing [member alpha_scissor_threshold]. If the material disappears at a distance, try decreasing [member alpha_scissor_threshold]. @@ -534,7 +534,7 @@ The material will use the texture's alpha values for transparency. This is the slowest to render, and disables shadow casting. - + The material will cut off all values below a threshold, the rest will remain opaque. The opaque portions will be rendered in the depth prepass. This is faster to render than alpha blending, but slower than opaque rendering. This also supports casting shadows. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 8731b27fc95..3865e54e26a 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -297,7 +297,7 @@ [/codeblocks] - + diff --git a/doc/classes/BoneAttachment3D.xml b/doc/classes/BoneAttachment3D.xml index 111e58e981d..227f6817cc3 100644 --- a/doc/classes/BoneAttachment3D.xml +++ b/doc/classes/BoneAttachment3D.xml @@ -1,5 +1,5 @@ - + А node that dynamically copies or overrides the 3D transform of a bone in its parent [Skeleton3D]. diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index d7782a816dc..739a824655d 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -134,7 +134,7 @@ Default icon for the [Button]. Appears only if [member icon] is not assigned. - + [StyleBox] used when the [Button] is disabled. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 92a57007bdd..99411c73aa7 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -126,7 +126,7 @@ Minimum equivalent of [member anim_speed_max]. - + Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 79283d6f859..27726ff8a23 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -125,7 +125,7 @@ Minimum particle animation speed. - + Each particle's initial color. [b]Note:[/b] [member color] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color] will have no visible effect. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 7604e4b75cf..608a47d4169 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -576,7 +576,7 @@ The material applied to this [CanvasItem]. - + The color applied to this [CanvasItem]. This property does affect child [CanvasItem]s, unlike [member self_modulate] which only affects the node itself. diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml index 214b3959c7b..7db03610207 100644 --- a/doc/classes/CanvasModulate.xml +++ b/doc/classes/CanvasModulate.xml @@ -1,5 +1,5 @@ - + A node that applies a color tint to a canvas. @@ -9,7 +9,7 @@ - + The tint color to apply. diff --git a/doc/classes/CharFXTransform.xml b/doc/classes/CharFXTransform.xml index ce74227298c..403033f85d1 100644 --- a/doc/classes/CharFXTransform.xml +++ b/doc/classes/CharFXTransform.xml @@ -11,7 +11,7 @@ https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project - + The color the character will be drawn with. diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index acb3f66c17f..12f7024518a 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -13,7 +13,7 @@ Collision build mode. Use one of the [enum BuildMode] constants. - + If [code]true[/code], no collisions will be detected. diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml index ed6fa0ba3c9..16090c203e8 100644 --- a/doc/classes/CollisionPolygon3D.xml +++ b/doc/classes/CollisionPolygon3D.xml @@ -13,7 +13,7 @@ Length that the resulting collision extends in either direction perpendicular to its 2D polygon. - + If [code]true[/code], no collision will be produced. diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index f3143e1f5c7..13209823764 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -17,7 +17,7 @@ The collision shape debug color. [b]Note:[/b] The default value is [member ProjectSettings.debug/shapes/collision/shape_color]. The [code]Color(0, 0, 0, 1)[/code] value documented here is a placeholder, and not the actual default debug color. - + A disabled collision shape has no effect in the world. This property should be changed with [method Object.set_deferred]. diff --git a/doc/classes/CollisionShape3D.xml b/doc/classes/CollisionShape3D.xml index 0dcfa75e5be..f6c0c323f4c 100644 --- a/doc/classes/CollisionShape3D.xml +++ b/doc/classes/CollisionShape3D.xml @@ -29,7 +29,7 @@ - + A disabled collision shape has no effect in the world. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 393e8525844..517fb6bef77 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -299,7 +299,7 @@ Returns [code]true[/code] if this color and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. - + diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index ce450f6786f..9aa0122ed2c 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -58,7 +58,7 @@ If [code]true[/code], it's possible to add presets under Swatches. If [code]false[/code], the button to add presets is disabled. - + The currently selected color. diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 89cb01407da..c53d61f036d 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -29,7 +29,7 @@ - + The currently selected color. diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index 5bc97e6f46a..413d51db723 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -10,7 +10,7 @@ https://godotengine.org/asset-library/asset/515 - + The fill color of the rectangle. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index a13bf0870d2..c7ddd5b12ef 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -949,16 +949,16 @@ The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard, gamepad, and mouse signals. - + Tells Godot which node it should give focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the [member ProjectSettings.input/ui_down] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one. - + Tells Godot which node it should give focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the [member ProjectSettings.input/ui_left] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the left of this one. - + Tells Godot which node it should give focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the [member ProjectSettings.input/ui_right] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the right of this one. - + Tells Godot which node it should give focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the [member ProjectSettings.input/ui_up] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the top of this one. diff --git a/doc/classes/Decal.xml b/doc/classes/Decal.xml index b89db8dc9e6..10ac769e770 100644 --- a/doc/classes/Decal.xml +++ b/doc/classes/Decal.xml @@ -1,5 +1,5 @@ - + Node that projects a texture onto a [MeshInstance3D]. @@ -65,13 +65,13 @@ Specifies which [member VisualInstance3D.layers] this decal will project on. By default, Decals affect all layers. This is used so you can specify which types of objects receive the Decal and which do not. This is especially useful so you can ensure that dynamic objects don't accidentally receive a Decal intended for the terrain under them. - + The distance from the camera at which the Decal begins to fade away (in 3D units). - + If [code]true[/code], decals will smoothly fade away when far from the active [Camera3D] starting at [member distance_fade_begin]. The Decal will fade out over [member distance_fade_begin] + [member distance_fade_length], after which it will be culled and not sent to the shader at all. Use this to reduce the number of active Decals in a scene and thus improve performance. - + The distance over which the Decal fades (in 3D units). The Decal becomes slowly more transparent over this distance and is completely invisible at the end. Higher values result in a smoother fade-out transition, which is more suited when the camera moves fast. @@ -80,7 +80,7 @@ Sets the curve over which the decal will fade as the surface gets further from the center of the [AABB]. Only positive values are valid (negative values will be clamped to [code]0.0[/code]). See also [member upper_fade]. - + Changes the [Color] of the Decal by multiplying the albedo and emission colors with this value. The alpha component is only taken into account when multiplying the albedo color, not the emission color. See also [member emission_energy] and [member albedo_mix] to change the emission and albedo intensity independently of each other. diff --git a/doc/classes/DirectionalLight2D.xml b/doc/classes/DirectionalLight2D.xml index 02909c95faa..d037f10c5b6 100644 --- a/doc/classes/DirectionalLight2D.xml +++ b/doc/classes/DirectionalLight2D.xml @@ -1,5 +1,5 @@ - + Directional 2D light from a distance. diff --git a/doc/classes/DirectionalLight3D.xml b/doc/classes/DirectionalLight3D.xml index d3cca5fa6d0..0a307a4adeb 100644 --- a/doc/classes/DirectionalLight3D.xml +++ b/doc/classes/DirectionalLight3D.xml @@ -1,5 +1,5 @@ - + Directional light from a distance, as from the Sun. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 4fd288f16df..2b1083393f6 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -84,7 +84,7 @@ Set this property to change the label (if you want to show one). - + Used by the inspector, set to [code]true[/code] when the property is read-only. diff --git a/doc/classes/EditorResourcePicker.xml b/doc/classes/EditorResourcePicker.xml index f139502e189..4649e26edf0 100644 --- a/doc/classes/EditorResourcePicker.xml +++ b/doc/classes/EditorResourcePicker.xml @@ -43,7 +43,7 @@ The base type of allowed resource types. Can be a comma-separated list of several options. - + If [code]true[/code], the value can be selected and edited. diff --git a/doc/classes/EditorSpinSlider.xml b/doc/classes/EditorSpinSlider.xml index 7108f873e66..783f1243e24 100644 --- a/doc/classes/EditorSpinSlider.xml +++ b/doc/classes/EditorSpinSlider.xml @@ -20,7 +20,7 @@ The text that displays to the left of the value. - + If [code]true[/code], the slider can't be interacted with. diff --git a/doc/classes/FogMaterial.xml b/doc/classes/FogMaterial.xml index a6acaaef00c..f256555d865 100644 --- a/doc/classes/FogMaterial.xml +++ b/doc/classes/FogMaterial.xml @@ -10,7 +10,7 @@ - + The single-scattering [Color] of the [FogVolume]. Internally, [member albedo] is converted into single-scattering, which is additively blended with other [FogVolume]s and the [member Environment.volumetric_fog_albedo]. diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 6b0d2e4a62b..a93f77e3244 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -42,7 +42,7 @@ The texel density to use for lightmapping in [LightmapGI]. Greater scale values provide higher resolution in the lightmap, which can result in sharper shadows for lights that have both direct and indirect light baked. However, greater scale values will also increase the space taken by the mesh in the lightmap texture, which increases the memory, storage, and bake time requirements. When using a single mesh at different scales, consider adjusting this value to keep the lightmap texel density consistent across meshes. - + The global illumination mode to use for the whole geometry. To avoid inconsistent results, use a mode that matches the purpose of the mesh during gameplay (static/dynamic). [b]Note:[/b] Lights' bake mode will also affect the global illumination rendering. See [member Light3D.light_bake_mode]. @@ -62,26 +62,26 @@ The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. - + The transparency applied to the whole geometry (as a multiplier of the materials' existing transparency). [code]0.0[/code] is fully opaque, while [code]1.0[/code] is fully transparent. Values greater than [code]0.0[/code] (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting [member transparency] to a value greater than [code]0.0[/code] (exclusive) will [i]not[/i] disable shadow rendering. In spatial shaders, [code]1.0 - transparency[/code] is set as the default value of the [code]ALPHA[/code] built-in. [b]Note:[/b] [member transparency] is clamped between [code]0.0[/code] and [code]1.0[/code], so this property cannot be used to make transparent materials more opaque than they originally are. - + Starting distance from which the GeometryInstance3D will be visible, taking [member visibility_range_begin_margin] into account as well. The default value of 0 is used to disable the range check. - + Margin for the [member visibility_range_begin] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_begin] threshold by this amount. 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. - + Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check. - + Margin for the [member visibility_range_end] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_end] threshold by this amount. 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. diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 9fe3362e0f1..129a1816148 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -1,5 +1,5 @@ - + Internet protocol (IP) support functions such as DNS resolution. @@ -65,7 +65,7 @@ Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [param id]. - + diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 984d426c0af..d9b2ef59e38 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -234,7 +234,7 @@ Returns [code]true[/code] if any action, key, joypad button, or mouse button is being pressed. This will also return [code]true[/code] if any action is simulated via code by calling [method action_press]. - + @@ -242,7 +242,7 @@ Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]). - + diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index a545eaf811c..3d1842fa77c 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,5 +1,5 @@ - + Represents a gamepad button being pressed or released. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index f6b9692d38d..ab939874e50 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,5 +1,5 @@ - + Represents axis motions (such as joystick or analog triggers) from a gamepad. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 77ead8fca0f..edd8a3e4368 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -1,5 +1,5 @@ - + A control for displaying plain text. diff --git a/doc/classes/Label3D.xml b/doc/classes/Label3D.xml index 977fb00402b..4c708974525 100644 --- a/doc/classes/Label3D.xml +++ b/doc/classes/Label3D.xml @@ -1,5 +1,5 @@ - + A node for displaying plain text in 3D space. @@ -81,7 +81,7 @@ Vertical space between lines in multiline [Label3D]. - + Text [Color] of the [Label3D]. diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 9e0cf664deb..a1c1a57ae45 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -28,7 +28,7 @@ The Light2D's blend mode. See [enum BlendMode] constants for values. - + The Light2D's [Color]. diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index d0bc7926ca5..bffa20bf233 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -35,31 +35,31 @@ - + The distance from the camera at which the light begins to fade away (in 3D units). [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D]. - + If [code]true[/code], the light will smoothly fade away when far from the active [Camera3D] starting at [member distance_fade_begin]. This acts as a form of level of detail (LOD). The light will fade out over [member distance_fade_begin] + [member distance_fade_length], after which it will be culled and not sent to the shader at all. Use this to reduce the number of active lights in a scene and thus improve performance. [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D]. - + Distance over which the light and its shadow fades. The light's energy and shadow's opacity is progressively reduced over this distance and is completely invisible at the end. [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D]. - + The distance from the camera at which the light's shadow cuts off (in 3D units). Set this to a value lower than [member distance_fade_begin] + [member distance_fade_length] to further improve performance, as shadow rendering is often more expensive than light rendering itself. [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D], and only when [member shadow_enabled] is [code]true[/code]. If [code]true[/code], the light only appears in the editor and will not be visible at runtime. If [code]true[/code], the light will never be baked in [LightmapGI] regardless of its [member light_bake_mode]. - + The light's angular size in degrees. Increasing this will make shadows softer at greater distances (also called percentage-closer soft shadows, or PCSS). Only available for [DirectionalLight3D]s. For reference, the Sun from the Earth is approximately [code]0.5[/code]. Increasing this value above [code]0.0[/code] for lights with shadows enabled will have a noticeable performance cost due to PCSS. [b]Note:[/b] [member light_angular_distance] is not affected by [member Node3D.scale] (the light's scale or its parent's scale). [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]. [b]Note:[/b] Meshes' global illumination mode will also affect the global illumination rendering. See [member GeometryInstance3D.gi_mode]. @@ -88,12 +88,12 @@ If [code]true[/code], the light's effect is reversed, darkening areas and casting bright shadows. - + [Texture2D] projected by light. [member shadow_enabled] must be on for the projector to work. Light projectors make the light appear as if it is shining through a colored but transparent object, almost like light shining through stained-glass. [b]Note:[/b] Unlike [BaseMaterial3D] whose filter mode can be adjusted on a per-material basis, the filter mode for light projector textures is set globally with [member ProjectSettings.rendering/textures/light_projectors/filter]. [b]Note:[/b] Light projector textures are only supported in the Forward+ and Mobile rendering methods, not Compatibility. - + The size of the light in Godot units. Only available for [OmniLight3D]s and [SpotLight3D]s. Increasing this value will make the light fade out slower and shadows appear blurrier (also called percentage-closer soft shadows, or PCSS). This can be used to simulate area lights to an extent. Increasing this value above [code]0.0[/code] for lights with shadows enabled will have a noticeable performance cost due to PCSS. [b]Note:[/b] [member light_size] is not affected by [member Node3D.scale] (the light's scale or its parent's scale). [b]Note:[/b] PCSS for positional lights is only supported in the Forward+ and Mobile rendering methods, not Compatibility. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index e706e3d6e08..1f25e926c9d 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -1,5 +1,5 @@ - + An input field for single-line text. @@ -216,7 +216,7 @@ If [code]true[/code], control characters are displayed. - + If [code]false[/code], existing text cannot be modified and new text cannot be added. @@ -494,7 +494,7 @@ Default background for the [LineEdit]. - + Background used when [LineEdit] is in read-only mode ([member editable] is set to [code]false[/code]). diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index b83ee7ba005..e3dd64648f7 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -1,5 +1,5 @@ - + A container that keeps a margin around its child controls. diff --git a/doc/classes/MenuBar.xml b/doc/classes/MenuBar.xml index 07f64d0572f..8812017e499 100644 --- a/doc/classes/MenuBar.xml +++ b/doc/classes/MenuBar.xml @@ -151,7 +151,7 @@ Font size of the menu item's text. - + [StyleBox] used when the menu item is disabled. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 1ac79cd3da2..c608ee79f1b 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -1,5 +1,5 @@ - + Provides high-performance drawing of a mesh multiple times using GPU instancing. diff --git a/doc/classes/MultiMeshInstance2D.xml b/doc/classes/MultiMeshInstance2D.xml index dc38d920bc4..0d8a0e136a2 100644 --- a/doc/classes/MultiMeshInstance2D.xml +++ b/doc/classes/MultiMeshInstance2D.xml @@ -1,5 +1,5 @@ - + Node that instances a [MultiMesh] in 2D. diff --git a/doc/classes/MultiMeshInstance3D.xml b/doc/classes/MultiMeshInstance3D.xml index 65abd174edc..5b6fd92d99e 100644 --- a/doc/classes/MultiMeshInstance3D.xml +++ b/doc/classes/MultiMeshInstance3D.xml @@ -1,5 +1,5 @@ - + Node that instances a [MultiMesh]. diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 95baf7c7060..009d7c03eae 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -1,5 +1,5 @@ - + High-level multiplayer API interface. diff --git a/doc/classes/MultiplayerAPIExtension.xml b/doc/classes/MultiplayerAPIExtension.xml index 7f6e7951b2a..cc6d3b7fcf0 100644 --- a/doc/classes/MultiplayerAPIExtension.xml +++ b/doc/classes/MultiplayerAPIExtension.xml @@ -1,5 +1,5 @@ - + Base class used for extending the [MultiplayerAPI]. diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 39980a05e1b..04fd282457b 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -1,5 +1,5 @@ - + Abstract class for specialized [PacketPeer]s used by the [MultiplayerAPI]. diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml index 8fd6755a7b8..b7d55f31b6a 100644 --- a/doc/classes/MultiplayerPeerExtension.xml +++ b/doc/classes/MultiplayerPeerExtension.xml @@ -1,5 +1,5 @@ - + Class that can be inherited to implement custom multiplayer API networking layers via GDExtension. diff --git a/doc/classes/OmniLight3D.xml b/doc/classes/OmniLight3D.xml index db2e27fbd66..64bf981a90e 100644 --- a/doc/classes/OmniLight3D.xml +++ b/doc/classes/OmniLight3D.xml @@ -1,5 +1,5 @@ - + Omnidirectional light, such as a light bulb or a candle. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 4e223c12fab..f04b0d942f7 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -1,5 +1,5 @@ - + A button that brings up a dropdown with selectable options when pressed. diff --git a/doc/classes/ParticleProcessMaterial.xml b/doc/classes/ParticleProcessMaterial.xml index d0c3e64b7dd..8d0ae317b98 100644 --- a/doc/classes/ParticleProcessMaterial.xml +++ b/doc/classes/ParticleProcessMaterial.xml @@ -147,7 +147,7 @@ If [code]true[/code], [member GPUParticles3D.collision_base_size] is multiplied by the particle's effective scale (see [member scale_min], [member scale_max], [member scale_curve], and [member scale_over_velocity_curve]). - + Each particle's initial color. If the [GPUParticles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. [b]Note:[/b] [member color] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color] will have no visible effect. diff --git a/doc/classes/PointLight2D.xml b/doc/classes/PointLight2D.xml index 556ad50cb14..9af3667126d 100644 --- a/doc/classes/PointLight2D.xml +++ b/doc/classes/PointLight2D.xml @@ -1,5 +1,5 @@ - + Positional 2D light source. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 25adc57990e..029a69a399d 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -74,7 +74,7 @@ Internal list of [Bone2D] nodes used by the assigned [member skeleton]. Edited using the Polygon2D editor ("UV" button on the top toolbar). - + The polygon's fill color. If [member texture] is set, it will be multiplied by this color. It will also be the default color for vertices not set in [member vertex_colors]. diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 61bc4f47204..411935aa79e 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -134,7 +134,7 @@ Returns whether the quaternion is normalized or not. - + Returns the length of the quaternion. @@ -158,7 +158,7 @@ Returns a copy of the quaternion, normalized to unit length. - + diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index c7d067b94d3..367942682e1 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -1,5 +1,5 @@ - + Captures its surroundings to create fast, accurate reflections from a given point. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 62215493fc0..b368e8374d9 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1014,7 +1014,7 @@ Sets the cull [param mask] in the decal specified by the [param decal] RID. Equivalent to [member Decal.cull_mask]. - + @@ -1958,7 +1958,7 @@ Sets the cull mask for this 3D light. Lights only affect objects in the selected layers. Equivalent to [member Light3D.light_cull_mask]. - + @@ -1994,7 +1994,7 @@ Sets the specified 3D light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param]. - + @@ -5223,13 +5223,13 @@ Only render the shadows from the object. The object itself will not be drawn. - + Disable visibility range fading for the given instance. - + Fade-out the given instance when it approaches its visibility range limits. - + Fade-in the given instance's dependencies when reaching its visibility range limits. diff --git a/doc/classes/RootMotionView.xml b/doc/classes/RootMotionView.xml index 648ea04a7dd..d7fbb2d80dc 100644 --- a/doc/classes/RootMotionView.xml +++ b/doc/classes/RootMotionView.xml @@ -17,7 +17,7 @@ The grid's cell size in 3D units. - + The grid's color. diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 492b6164bf3..a4ffa5c1e7b 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -9,7 +9,7 @@ - + If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 8627a9e40fd..44427c8c5e5 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -1,5 +1,5 @@ - + An input field for numbers. @@ -52,7 +52,7 @@ If not [code]0[/code], [member Range.value] will always be rounded to a multiple of [member custom_arrow_step] when interacting with the arrow buttons of the [SpinBox]. - + If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 44883512129..d6f8a519db7 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -75,7 +75,7 @@ If [code]true[/code], texture is flipped vertically. - + A color value used to [i]multiply[/i] the texture's colors. Can be used for mood-coloring or to simulate the color of ambient light. [b]Note:[/b] Unlike [member CanvasItem.modulate] for 2D, colors with values above [code]1.0[/code] (overbright) are not supported. [b]Note:[/b] If a [member GeometryInstance3D.material_override] is defined on the [SpriteBase3D], the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in [member modulate] will be ignored. For a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] must be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. diff --git a/doc/classes/StatusIndicator.xml b/doc/classes/StatusIndicator.xml index b92018e1720..6b015c3d15f 100644 --- a/doc/classes/StatusIndicator.xml +++ b/doc/classes/StatusIndicator.xml @@ -1,5 +1,5 @@ - + Application status indicator (aka notification area icon). [b]Note:[/b] Status indicator is implemented on macOS and Windows. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 3acd174196e..cffe9e219db 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -531,7 +531,7 @@ [/codeblock] - + Returns the number of characters in the string. Empty strings ([code]""[/code]) always return [code]0[/code]. See also [method is_empty]. diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 8db19ec957a..41763489f1b 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -507,7 +507,7 @@ [/codeblock] - + Returns the number of characters in the string. Empty strings ([code]""[/code]) always return [code]0[/code]. See also [method is_empty]. diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml index 8958cf9fc83..5f9d3332f2d 100644 --- a/doc/classes/StyleBoxLine.xml +++ b/doc/classes/StyleBoxLine.xml @@ -9,7 +9,7 @@ - + The line's color. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 6a1879baa4d..001cf06db46 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -1,5 +1,5 @@ - + A multiline text editor. @@ -1144,7 +1144,7 @@ If [code]true[/code], the "tab" character will have a visible representation. - + If [code]false[/code], existing text cannot be modified and new text cannot be added. @@ -1480,7 +1480,7 @@ Sets the [StyleBox] of this [TextEdit]. - + Sets the [StyleBox] of this [TextEdit] when [member editable] is disabled. diff --git a/doc/classes/TextureProgressBar.xml b/doc/classes/TextureProgressBar.xml index 6ab1b86e5cf..d3e334ef55c 100644 --- a/doc/classes/TextureProgressBar.xml +++ b/doc/classes/TextureProgressBar.xml @@ -70,13 +70,13 @@ [Texture2D] that draws under the progress bar. The bar's background. - + Multiplies the color of the bar's [member texture_over] texture. The effect is similar to [member CanvasItem.modulate], except it only affects this specific texture instead of the entire node. - + Multiplies the color of the bar's [member texture_progress] texture. - + Multiplies the color of the bar's [member texture_under] texture. diff --git a/doc/classes/TileData.xml b/doc/classes/TileData.xml index 9e833e0236d..c5b86f079e9 100644 --- a/doc/classes/TileData.xml +++ b/doc/classes/TileData.xml @@ -214,7 +214,7 @@ The [Material] to use for this [TileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader. - + Color modulation of the tile. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 1bb23211c95..daa0eec230a 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -1,5 +1,5 @@ - + Node for 2D tile-based maps. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 3fa7bb46fc2..76f97d0968c 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -236,7 +236,7 @@ This method is faster than using [method is_equal_approx] with one value as a zero vector. - + Returns the length (magnitude) of this vector. @@ -249,7 +249,7 @@ This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. - + @@ -257,7 +257,7 @@ Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. - + @@ -344,7 +344,7 @@ Returns a new vector with each component set to [code]1.0[/code] if it's positive, [code]-1.0[/code] if it's negative, and [code]0.0[/code] if it's zero. The result is identical to calling [method @GlobalScope.sign] on each component. - + diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index e0047558189..18291e06a96 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -79,7 +79,7 @@ Returns the distance between this vector and [param to]. - + Returns the length (magnitude) of this vector. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 83a8c6af739..5730826043c 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -204,7 +204,7 @@ This method is faster than using [method is_equal_approx] with one value as a zero vector. - + Returns the length (magnitude) of this vector. @@ -217,7 +217,7 @@ This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. - + @@ -225,7 +225,7 @@ Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. - + @@ -337,7 +337,7 @@ Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the [param axis]. - + diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index 96760ed9f9f..ffebd3e1f3d 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -74,7 +74,7 @@ Returns the distance between this vector and [param to]. - + Returns the length (magnitude) of this vector. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index c5503a93577..8514670231c 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -155,7 +155,7 @@ This method is faster than using [method is_equal_approx] with one value as a zero vector. - + Returns the length (magnitude) of this vector. @@ -168,7 +168,7 @@ This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. - + diff --git a/doc/classes/Vector4i.xml b/doc/classes/Vector4i.xml index ded5d6f3ef6..f8a00260666 100644 --- a/doc/classes/Vector4i.xml +++ b/doc/classes/Vector4i.xml @@ -72,7 +72,7 @@ Returns the distance between this vector and [param to]. - + Returns the length (magnitude) of this vector. diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index 27b07821b1f..c7ee1601746 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -1,5 +1,5 @@ - + Default environment properties for the entire scene (post-processing effects, lighting and background settings). diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 5cfbd3f9ddf..4b009f1866a 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -209,7 +209,7 @@ [b]Note:[/b] Calling this function from a [Thread] is not supported. Doing so will instead print the thread ID. - + Returns an array with the given range. [method range] can be called in three ways: diff --git a/modules/gltf/doc_classes/GLTFLight.xml b/modules/gltf/doc_classes/GLTFLight.xml index 653a394ebb6..1c82430abf7 100644 --- a/modules/gltf/doc_classes/GLTFLight.xml +++ b/modules/gltf/doc_classes/GLTFLight.xml @@ -39,7 +39,7 @@ - + The [Color] of the light. Defaults to white. A black color causes the light to have no effect. diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index da11cd216f9..7aeecef980a 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -1,5 +1,5 @@ - + Node for 3D tile-based maps. diff --git a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml index 482db3e8b59..3da245f806c 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml @@ -1,5 +1,5 @@ - + Automatically replicates spawnable nodes from the authority to other multiplayer peers. diff --git a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml index df2644767d2..c2d879962cc 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml @@ -1,5 +1,5 @@ - + Synchronizes properties from the multiplayer authority to the remote peers.