summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWinston <44872771+winston-yallow@users.noreply.github.com>2023-04-26 02:31:40 +0200
committerWinston <44872771+winston-yallow@users.noreply.github.com>2023-04-26 03:19:23 +0200
commit7b30d7da51e40a69b464e501dbc02fcaa99deb5b (patch)
tree550fa362569c57f39953148cfcd64dc0cb9890f7
parente0e93ce094d19d132f34aa5c92e892524a8125c9 (diff)
downloadredot-engine-7b30d7da51e40a69b464e501dbc02fcaa99deb5b.tar.gz
Document automatic center mode using shape origins
-rw-r--r--doc/classes/RigidBody2D.xml2
-rw-r--r--doc/classes/RigidBody3D.xml2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml
index 38334b1348..24372e51e0 100644
--- a/doc/classes/RigidBody2D.xml
+++ b/doc/classes/RigidBody2D.xml
@@ -283,7 +283,7 @@
Kinematic body freeze mode. Similar to [constant FREEZE_MODE_STATIC], but collides with other bodies along its path when moved. Useful for a frozen body that needs to be animated.
</constant>
<constant name="CENTER_OF_MASS_MODE_AUTO" value="0" enum="CenterOfMassMode">
- In this mode, the body's center of mass is calculated automatically based on its shapes.
+ In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass.
</constant>
<constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode">
In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position.
diff --git a/doc/classes/RigidBody3D.xml b/doc/classes/RigidBody3D.xml
index f087f912bc..3bd660d8dd 100644
--- a/doc/classes/RigidBody3D.xml
+++ b/doc/classes/RigidBody3D.xml
@@ -290,7 +290,7 @@
Kinematic body freeze mode. Similar to [constant FREEZE_MODE_STATIC], but collides with other bodies along its path when moved. Useful for a frozen body that needs to be animated.
</constant>
<constant name="CENTER_OF_MASS_MODE_AUTO" value="0" enum="CenterOfMassMode">
- In this mode, the body's center of mass is calculated automatically based on its shapes.
+ In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass.
</constant>
<constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode">
In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position.