hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #68098 from compmstr/apply-torque-inertia-note

Browse source 
Add note about inertia being required for apply_torque on various Node types
This commit is contained in:
Rémi Verschelde 2022-11-08 10:48:33 +01:00
commit 56e1520f82
No known key found for this signature in database
GPG key ID: C3336907360768E1
4 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/PhysicsDirectBodyState2D.xml
View file

@ -76,6 +76,7 @@
<param index="0" name="torque" type="float" />
<description>
Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
[b]Note:[/b] [member inverse_inertia] is required for this to work. To have [member inverse_inertia], an active [CollisionShape2D] must be a child of the node, or you can manually set [member inverse_inertia].
</description>
</method>
<method name="apply_torque_impulse">
@ -84,6 +85,7 @@
<description>
Applies a rotational impulse to the body without affecting the position.
An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
[b]Note:[/b] [member inverse_inertia] is required for this to work. To have [member inverse_inertia], an active [CollisionShape2D] must be a child of the node, or you can manually set [member inverse_inertia].
</description>
</method>
<method name="get_constant_force" qualifiers="const">