godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #101652 from TokageItLab/gravity-doc-springbone

Browse Source 
Clarify `SpringBoneSimulator3D`'s gravity units and improve documentation
This commit is contained in:
Thaddeus Crews
2025-01-17 10:16:49 -06:00
parent 923eb44c6f 8eb5443d0a
commit 9875cb6c95
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/SpringBoneSimulator3D.xml
View File

@@ -447,7 +447,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="gravity" type="float" />
<description>
Sets the gravity amount of the bone chain.
Sets the gravity amount of the bone chain. This value is not an acceleration, but a constant velocity of movement in [method set_gravity_direction].
If [param gravity] is not [code]0[/code], the modified pose will not return to the original pose since it is always affected by gravity.
The value is scaled by [method set_gravity_damping_curve] and cached in each joint setting in the joint list.
</description>
@@ -465,7 +465,7 @@
<param index="0" name="index" type="int" />
<param index="1" name="gravity_direction" type="Vector3" />
<description>
Sets the gravity direction of the bone chain.
Sets the gravity direction of the bone chain. This value is internally normalized and then multiplied by [method set_gravity].
The value is cached in each joint setting in the joint list.
</description>
</method>