godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document RigidBody2D/3D and particles' angular velocity units

This commit is contained in:
Hugo Locurcio 2021-12-11 17:38:55 +01:00
parent 092a286127
commit 5d81742dc8
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
6 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/CPUParticles3D.xml
View File

@ -96,13 +96,13 @@
Minimum angle. Minimum angle.
</member> </member>
<member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> <member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
Each particle's angular velocity will vary along this [Curve]. Each particle's angular velocity (rotation speed) will vary along this [Curve] over its lifetime.
</member> </member>
<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0"> <member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Maximum angular velocity. Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
</member> </member>
<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0"> <member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Minimum angular velocity. Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
</member> </member>
<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> <member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
Each particle's animation offset will vary along this [Curve]. Each particle's animation offset will vary along this [Curve].

6
doc/classes/ParticlesMaterial.xml
View File

@ -83,13 +83,13 @@
Minimum angle. Minimum angle.
</member> </member>
<member name="angular_velocity_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture"> <member name="angular_velocity_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
Each particle's angular velocity will vary along this [CurveTexture]. Each particle's angular velocity (rotation speed) will vary along this [CurveTexture] over its lifetime.
</member> </member>
<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0"> <member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Maximum angular velocity. Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
</member> </member>
<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0"> <member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Minimum angular velocity. Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
</member> </member>
<member name="anim_offset_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture"> <member name="anim_offset_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
Each particle's animation offset will vary along this [CurveTexture]. Each particle's animation offset will vary along this [CurveTexture].

4
doc/classes/PhysicsDirectBodyState2D.xml
View File

@ -208,7 +208,7 @@
</methods> </methods>
<members> <members>
<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity">
The body's rotational velocity. The body's rotational velocity in [i]radians[/i] per second.
</member> </member>
<member name="center_of_mass" type="Vector2" setter="" getter="get_center_of_mass"> <member name="center_of_mass" type="Vector2" setter="" getter="get_center_of_mass">
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 relative to the body's center in the global coordinate system.
@ -223,7 +223,7 @@
The inverse of the mass of the body. The inverse of the mass of the body.
</member> </member>
<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity">
The body's linear velocity. The body's linear velocity in pixels per second.
</member> </member>
<member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping"> <member name="sleeping" type="bool" setter="set_sleep_state" getter="is_sleeping">
If [code]true[/code], this body is currently sleeping (not active). If [code]true[/code], this body is currently sleeping (not active).

4
doc/classes/PhysicsDirectBodyState3D.xml
View File

@ -215,7 +215,7 @@
</methods> </methods>
<members> <members>
<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity"> <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity">
The body's rotational velocity. The body's rotational velocity in [i]radians[/i] per second.
</member> </member>
<member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass"> <member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass">
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 relative to the body's center in the global coordinate system.
@ -230,7 +230,7 @@
The inverse of the mass of the body. The inverse of the mass of the body.
</member> </member>
<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity"> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity">
The body's linear velocity. The body's linear velocity in units per second.
</member> </member>
<member name="principal_inertia_axes" type="Basis" setter="" getter="get_principal_inertia_axes"> <member name="principal_inertia_axes" type="Basis" setter="" getter="get_principal_inertia_axes">
</member> </member>

4
doc/classes/RigidDynamicBody2D.xml
View File

@ -121,7 +121,7 @@
Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. Defines how [member angular_damp] is applied. See [enum DampMode] for possible values.
</member> </member>
<member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity" default="0.0"> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity" default="0.0">
The body's rotational velocity. The body's rotational velocity in [i]radians[/i] per second.
</member> </member>
<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true">
If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping].
@ -179,7 +179,7 @@
Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. Defines how [member linear_damp] is applied. See [enum DampMode] for possible values.
</member> </member>
<member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector2(0, 0)"> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector2(0, 0)">
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.
</member> </member>
<member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false"> <member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false">
If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement. If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement.

4
doc/classes/RigidDynamicBody3D.xml
View File

@ -127,7 +127,7 @@
Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. Defines how [member angular_damp] is applied. See [enum DampMode] for possible values.
</member> </member>
<member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)"> <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)">
RigidDynamicBody3D's rotational velocity. The RigidDynamicBody3D's rotational velocity in [i]radians[/i] per second.
</member> </member>
<member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true">
If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping]. If [code]true[/code], the body can enter sleep mode when there is no movement. See [member sleeping].
@ -185,7 +185,7 @@
Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. Defines how [member linear_damp] is applied. See [enum DampMode] for possible values.
</member> </member>
<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)"> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)">
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.
</member> </member>
<member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false"> <member name="lock_rotation" type="bool" setter="set_lock_rotation_enabled" getter="is_lock_rotation_enabled" default="false">
If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement. If [code]true[/code], the body cannot rotate. Gravity and forces only apply linear movement.