From a3e52925bf6238ab245e30190d9f30b87119294b Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Wed, 9 Nov 2022 01:59:49 -0600 Subject: Fix default values on virtual classes causing errors in projects --- doc/classes/AnimatedTexture.xml | 1 + doc/classes/AtlasTexture.xml | 1 + doc/classes/CameraTexture.xml | 1 + doc/classes/CanvasTexture.xml | 1 + doc/classes/CompressedTexture2D.xml | 1 + doc/classes/CurveTexture.xml | 1 + doc/classes/CurveXYZTexture.xml | 1 + doc/classes/EditorSpinSlider.xml | 2 ++ doc/classes/GradientTexture1D.xml | 1 + doc/classes/GradientTexture2D.xml | 1 + doc/classes/ImageTexture.xml | 3 +++ doc/classes/MeshTexture.xml | 1 + doc/classes/PhysicsDirectBodyState2D.xml | 24 ++++++++++++------------ doc/classes/PhysicsDirectBodyState3D.xml | 28 ++++++++++++++-------------- doc/classes/PlaceholderTexture2D.xml | 1 + doc/classes/PortableCompressedTexture2D.xml | 1 + doc/classes/ProgressBar.xml | 2 -- doc/classes/Range.xml | 3 ++- doc/classes/ScrollBar.xml | 1 - doc/classes/Slider.xml | 2 +- doc/classes/SpinBox.xml | 2 ++ doc/classes/TextureProgressBar.xml | 2 ++ doc/classes/ViewportTexture.xml | 1 - 23 files changed, 50 insertions(+), 32 deletions(-) (limited to 'doc') diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index f0c86ba47b..57a7f86901 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -57,6 +57,7 @@ If [code]true[/code], the animation will pause where it currently is (i.e. at [member current_frame]). The animation will continue from where it was paused when changing this property to [code]false[/code]. + The animation speed is multiplied by this value. If set to a negative value, the animation is played in reverse. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 809d983a9d..fc75459e46 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -23,5 +23,6 @@ The region used to draw the [member atlas]. + diff --git a/doc/classes/CameraTexture.xml b/doc/classes/CameraTexture.xml index 8eedfe3580..e7020c869e 100644 --- a/doc/classes/CameraTexture.xml +++ b/doc/classes/CameraTexture.xml @@ -16,6 +16,7 @@ Convenience property that gives access to the active property of the [CameraFeed]. + Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component. diff --git a/doc/classes/CanvasTexture.xml b/doc/classes/CanvasTexture.xml index 2dc83790c7..d5bf65835f 100644 --- a/doc/classes/CanvasTexture.xml +++ b/doc/classes/CanvasTexture.xml @@ -17,6 +17,7 @@ The normal map texture to use. Only has a visible effect if [Light2D]s are affecting this [CanvasTexture]. [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. + The multiplier for specular reflection colors. The [Light2D]'s color is also taken into account when determining the reflection color. Only has a visible effect if [Light2D]s are affecting this [CanvasTexture]. diff --git a/doc/classes/CompressedTexture2D.xml b/doc/classes/CompressedTexture2D.xml index f74265b8d5..f7464d8951 100644 --- a/doc/classes/CompressedTexture2D.xml +++ b/doc/classes/CompressedTexture2D.xml @@ -21,5 +21,6 @@ The CompressedTexture's file path to a [code].ctex[/code] file. + diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index 85473fc237..03e008d738 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -13,6 +13,7 @@ The [Curve] that is rendered onto the texture. + The format the texture should be generated with. When passing a CurveTexture as a input to a [Shader], this may need to be adjusted. diff --git a/doc/classes/CurveXYZTexture.xml b/doc/classes/CurveXYZTexture.xml index e3f2e8fc45..8c4e2dce0f 100644 --- a/doc/classes/CurveXYZTexture.xml +++ b/doc/classes/CurveXYZTexture.xml @@ -19,6 +19,7 @@ The [Curve] that is rendered onto the texture's blue channel. + The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage. diff --git a/doc/classes/EditorSpinSlider.xml b/doc/classes/EditorSpinSlider.xml index 784a3c1214..de105b32e1 100644 --- a/doc/classes/EditorSpinSlider.xml +++ b/doc/classes/EditorSpinSlider.xml @@ -22,6 +22,8 @@ If [code]true[/code], the slider can't be interacted with. + + The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed. diff --git a/doc/classes/GradientTexture1D.xml b/doc/classes/GradientTexture1D.xml index 3254754ac1..fa572eeed0 100644 --- a/doc/classes/GradientTexture1D.xml +++ b/doc/classes/GradientTexture1D.xml @@ -12,6 +12,7 @@ The [Gradient] that will be used to fill the texture. + If [code]true[/code], the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is [code]true[/code]. If [code]false[/code], the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). diff --git a/doc/classes/GradientTexture2D.xml b/doc/classes/GradientTexture2D.xml index 7561f1b947..87d86e7a59 100644 --- a/doc/classes/GradientTexture2D.xml +++ b/doc/classes/GradientTexture2D.xml @@ -27,6 +27,7 @@ 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. + If [code]true[/code], the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is [code]true[/code]. If [code]false[/code], the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index 45cbd7ac87..03d1947475 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -67,4 +67,7 @@ + + + diff --git a/doc/classes/MeshTexture.xml b/doc/classes/MeshTexture.xml index 8e2bccc79f..d09fa4c898 100644 --- a/doc/classes/MeshTexture.xml +++ b/doc/classes/MeshTexture.xml @@ -18,5 +18,6 @@ Sets the mesh used to draw. It must be a mesh using 2D vertices. + diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index e8062f3e94..eca6a1cbc7 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -209,40 +209,40 @@ - + The body's rotational velocity in [i]radians[/i] per second. - + The body's center of mass position relative to the body's center in the global coordinate system. - + The body's center of mass position in the body's local coordinate system. - + The inverse of the inertia of the body. - + The inverse of the mass of the body. - + The body's linear velocity in pixels per second. - + If [code]true[/code], this body is currently sleeping (not active). - + The timestep (delta) used for the simulation. - + The rate at which the body stops rotating, if there are not any other forces moving it. - + The total gravity vector being currently applied to this body. - + The rate at which the body stops moving, if there are not any other forces moving it. - + The body's transformation matrix. diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml index 4c6d51c85a..a809384642 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -216,45 +216,45 @@ - + The body's rotational velocity in [i]radians[/i] per second. - + The body's center of mass position relative to the body's center in the global coordinate system. - + The body's center of mass position in the body's local coordinate system. - + The inverse of the inertia of the body. - + The inverse of the inertia tensor of the body. - + The inverse of the mass of the body. - + The body's linear velocity in units per second. - + - + If [code]true[/code], this body is currently sleeping (not active). - + The timestep (delta) used for the simulation. - + The rate at which the body stops rotating, if there are not any other forces moving it. - + The total gravity vector being currently applied to this body. - + The rate at which the body stops moving, if there are not any other forces moving it. - + The body's transformation matrix. diff --git a/doc/classes/PlaceholderTexture2D.xml b/doc/classes/PlaceholderTexture2D.xml index 76e575265b..5d8509ec77 100644 --- a/doc/classes/PlaceholderTexture2D.xml +++ b/doc/classes/PlaceholderTexture2D.xml @@ -7,6 +7,7 @@ + diff --git a/doc/classes/PortableCompressedTexture2D.xml b/doc/classes/PortableCompressedTexture2D.xml index a0492f2c07..b64cda6df5 100644 --- a/doc/classes/PortableCompressedTexture2D.xml +++ b/doc/classes/PortableCompressedTexture2D.xml @@ -58,6 +58,7 @@ When running on the editor, this class will keep the source compressed data in memory. Otherwise, the source compressed data is lost after loading and the resource can't be re saved. This flag allows to keep the compressed data in memory if you intend it to persist after loading. + Allow overriding the texture size (for 2D only). diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index f8c5dc0e1f..510b8d5bd1 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -15,8 +15,6 @@ If [code]true[/code], the fill percentage is displayed on the bar. - - diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 8aa89015c6..2dcfc90955 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -62,7 +62,8 @@ If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. - + + If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml index 266787c9c8..247e892c24 100644 --- a/doc/classes/ScrollBar.xml +++ b/doc/classes/ScrollBar.xml @@ -12,7 +12,6 @@ Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the [ScrollBar] is focused. - diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml index 0e626842bd..cecca0a5fb 100644 --- a/doc/classes/Slider.xml +++ b/doc/classes/Slider.xml @@ -17,7 +17,7 @@ If [code]true[/code], the value can be changed using the mouse wheel. - + Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 93799b58f0..e214867890 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -59,6 +59,8 @@ If [code]true[/code], the [SpinBox] will select the whole text when the [LineEdit] gains focus. Clicking the up and down arrows won't trigger this behavior. + + Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox]. diff --git a/doc/classes/TextureProgressBar.xml b/doc/classes/TextureProgressBar.xml index ded4dac7da..54b77bf5eb 100644 --- a/doc/classes/TextureProgressBar.xml +++ b/doc/classes/TextureProgressBar.xml @@ -41,6 +41,8 @@ Starting angle for the fill of [member texture_progress] if [member fill_mode] is [constant FILL_CLOCKWISE] or [constant FILL_COUNTER_CLOCKWISE]. When the node's [code]value[/code] is equal to its [code]min_value[/code], the texture doesn't show up at all. When the [code]value[/code] increases, the texture fills and tends towards [member radial_fill_degrees]. + + The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml index 955f054cea..6bd64a50bb 100644 --- a/doc/classes/ViewportTexture.xml +++ b/doc/classes/ViewportTexture.xml @@ -15,7 +15,6 @@ https://godotengine.org/asset-library/asset/586 - The path to the [Viewport] node to display. This is relative to the scene root, not to the node which uses the texture. -- cgit v1.2.3