From 244c5ecc64fc46248a8dc9abbdad29ed3aa9ad18 Mon Sep 17 00:00:00 2001 From: kobewi Date: Tue, 30 Nov 2021 22:32:23 +0100 Subject: [PATCH] Misc improvements to various docs --- doc/classes/Camera2D.xml | 10 +++++----- doc/classes/InputEventScreenTouch.xml | 2 +- doc/classes/Node.xml | 2 +- doc/classes/ParticlesMaterial.xml | 7 ++++--- doc/classes/Vector2.xml | 2 +- doc/classes/Vector3.xml | 2 +- 6 files changed, 13 insertions(+), 12 deletions(-) diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index a3a891cdcb9..6a1782fc526 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -123,13 +123,13 @@ If [code]true[/code], draws the camera's screen rectangle in the editor. - Bottom scroll limit in pixels. The camera stops moving when reaching this value. + Bottom scroll limit in pixels. The camera stops moving when reaching this value, but [member offset] can push the view past the limit. - Left scroll limit in pixels. The camera stops moving when reaching this value. + Left scroll limit in pixels. The camera stops moving when reaching this value, but [member offset] can push the view past the limit. - Right scroll limit in pixels. The camera stops moving when reaching this value. + Right scroll limit in pixels. The camera stops moving when reaching this value, but [member offset] can push the view past the limit. If [code]true[/code], the camera smoothly stops when reaches its limits. @@ -137,10 +137,10 @@ [b]Note:[/b] To immediately update the camera's position to be within limits without smoothing, even with this setting enabled, invoke [method reset_smoothing]. - Top scroll limit in pixels. The camera stops moving when reaching this value. + Top scroll limit in pixels. The camera stops moving when reaching this value, but [member offset] can push the view past the limit. - The camera's offset, useful for looking around or camera shake animations. + The camera's relative offset. Useful for looking around or camera shake animations. The offseted camera can go past the limits defined in [member limit_top], [member limit_bottom], [member limit_left] and [member limit_right]. The camera's process callback. See [enum Camera2DProcessCallback]. diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 0694b2eabc8..17f6eeecabe 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -15,7 +15,7 @@ The touch index in the case of a multi-touch event. One index = one finger. - The touch position. + The touch position, in screen (global) coordinates. If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch's state is released. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index c75b2e305e7..07b2f8e91b7 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -726,7 +726,7 @@ - Emitted when the node is ready. + Emitted when the node is ready. Comes after [method _ready] callback and follows the same rules. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 2cc0d8f2b01..8322d4474f6 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -6,7 +6,7 @@ ParticlesMaterial defines particle properties and behavior. It is used in the [code]process_material[/code] of [GPUParticles3D] and [GPUParticles2D] emitter nodes. Some of this material's properties are applied to each particle when emitted, while others can have a [CurveTexture] applied to vary values over the lifetime of the particle. - When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between [code]1.0[/code] and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of [code]0.4[/code] would scale the original property between [code]0.4-1.0[/code] of its original value. + Particle animation is available only in [GPUParticles2D]. To use it, attach a [CanvasItemMaterial], with [member CanvasItemMaterial.particles_animation] enabled, to the particles node. @@ -104,7 +104,8 @@ Each particle's animation speed will vary along this [CurveTexture]. - Maximum particle animation speed. + Maximum particle animation speed. Animation speed of [code]1[/code] means that the particles will make full [code]0[/code] to [code]1[/code] offset cycle during lifetime, [code]2[/code] means [code]2[/code] cycles etc. + With animation speed greater than [code]1[/code], remember to enable [member CanvasItemMaterial.particles_anim_loop] property if you want the animation to repeat. Minimum particle animation speed. @@ -195,7 +196,7 @@ Minimum initial velocity. - Particle lifetime randomness ratio. + Particle lifetime randomness ratio. The lifetime will be multipled by a value interpolated between [code]1.0[/code] and a random number less than one. For example a random ratio of [code]0.4[/code] would scale the original lifetime between [code]0.4-1.0[/code] of its original value. Each particle's linear acceleration will vary along this [CurveTexture]. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 431815e75aa..abfc38009d6 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -219,7 +219,7 @@ - Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount. + Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 6d20cc85ea7..3e99cd98628 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -201,7 +201,7 @@ - Moves this vector toward [code]to[/code] by the fixed [code]delta[/code] amount. + Moves this vector toward [code]to[/code] by the fixed [code]delta[/code] amount. Will not go past the final value.