From c089e687cfe3381eba813b5ea6b7c176ff46ecf9 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 23 Aug 2021 17:11:25 +0200 Subject: [PATCH] Document that RigidBody angular velocity is in degrees per second This will be changed to radians per second in Godot 4.0, but it can't be changed in 3.x to preserve compatibility with existing projects. (cherry picked from commit 2fe15124de20184a246dfe3eab30886c81862cf6) --- doc/classes/CPUParticles.xml | 2 +- doc/classes/CPUParticles2D.xml | 2 +- doc/classes/ParticlesMaterial.xml | 8 ++++---- doc/classes/Physics2DDirectBodyState.xml | 4 ++-- doc/classes/PhysicsDirectBodyState.xml | 4 ++-- doc/classes/RigidBody.xml | 4 ++-- doc/classes/RigidBody2D.xml | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index e25b8788f4e..7c89c8a9881 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -100,7 +100,7 @@ Rotation randomness ratio. - Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. + Initial angular velocity applied to each particle in [i]degrees[/i] per second. Sets the speed of rotation of the particle. Each particle's angular velocity will vary along this [Curve]. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 0e44007456f..bb346dc315d 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -101,7 +101,7 @@ Rotation randomness ratio. - Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. + Initial angular velocity applied to each particle in [i]degrees[/i] per second. Sets the speed of rotation of the particle. Each particle's angular velocity will vary along this [Curve]. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index d21aa4f7ff0..5f51f15347c 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -75,7 +75,7 @@ Initial rotation applied to each particle, in degrees. - Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. + [b]Note:[/b] Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. Each particle's rotation will be animated along this [CurveTexture]. @@ -84,8 +84,8 @@ Rotation randomness ratio. - Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. - Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. + Initial angular velocity applied to each particle in [i]degrees[/i] per second. Sets the speed of rotation of the particle. + [b]Note:[/b] Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES]. Each particle's angular velocity will vary along this [CurveTexture]. @@ -206,7 +206,7 @@ Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. - Only available when [member flag_disable_z] is [code]true[/code]. + [b]Note:[/b] Only available when [member flag_disable_z] is [code]true[/code]. Each particle's orbital velocity will vary along this [CurveTexture]. diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index ec85ae0cedc..d77e6256ae8 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -154,7 +154,7 @@ - The body's rotational velocity. + The body's rotational velocity in [i]radians[/i] per second. The inverse of the inertia of the body. @@ -163,7 +163,7 @@ The inverse of the mass of the body. - The body's linear velocity. + The body's linear velocity in pixels per second. If [code]true[/code], this body is currently sleeping (not active). diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index d4bc395305e..1cb32d35e4a 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -156,7 +156,7 @@ - The body's rotational velocity. + The body's rotational velocity in axis-angle format. The magnitude of the vector is the rotation rate in [i]radians[/i] per second. @@ -167,7 +167,7 @@ The inverse of the mass of the body. - The body's linear velocity. + The body's linear velocity in units per second. diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 7435be47db2..5b8c0d37f18 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -112,7 +112,7 @@ See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. - RigidBody's rotational velocity. + The body's rotational velocity in axis-angle format. The magnitude of the vector is the rotation rate in [i]radians[/i] per second. Lock the body's rotation in the X axis. @@ -166,7 +166,7 @@ See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. - The body's linear velocity. 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. + 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. The body's mass. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 00d1cc3e3d5..99a2b3b00a9 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -98,7 +98,7 @@ See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. - The body's rotational velocity. + The body's rotational velocity in [i]radians[/i] per second. The body's total applied force. @@ -143,7 +143,7 @@ See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. - The body's linear velocity. + 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. The body's mass.