diff options
| author | Jakob Sinclair <sinclair.jakob@mailbox.org> | 2017-10-20 03:45:17 +0200 |
|---|---|---|
| committer | Jakob Sinclair <sinclair.jakob@mailbox.org> | 2017-10-20 22:40:02 +0200 |
| commit | 1870c2fdcff7c62b7b63e44773af39975965c388 (patch) | |
| tree | ccd3c90597b5c977447e74315824128c3b8a58e0 /doc | |
| parent | a3a85670a338388aa93c40e49d60cbad834cba11 (diff) | |
Fix ambiguous documentation for RigidBody2D
Fixes #12225 and the possesive form of the word body. Also uses simpler terms now
when describing when the linear velocity gets updated.
Signed-off-by: Jakob Sinclair <sinclair.jakob@mailbox.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/RigidBody2D.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index a4faa697de..f2584de5aa 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -113,7 +113,7 @@ <return type="float"> </return> <description> - Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. + Returns the body's moment of inertia. Automatically computed from associated [class CollisionShape2D]s' mass during physic frames. Inertia is not computed the same frame in which the node was added in. Therefore inertia is not computed during the [code]_ready[/code] function. </description> </method> <method name="get_linear_damp" qualifiers="const"> @@ -127,7 +127,7 @@ <return type="Vector2"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + Returns the body's linear velocity. This changes when a physics frame has passed, not during a normal update. See [method set_linear_velocity]. </description> </method> <method name="get_mass" qualifiers="const"> |