Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-01-09 03:27:15 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix ambiguous documentation for RigidBody2D

Browse Source 
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>
This commit is contained in:
Jakob Sinclair 2017-10-20 03:45:17 +02:00
parent a3a85670a3
commit 1870c2fdcf
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/RigidBody2D.xml
View File

@ -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">