Browse Source

Document lerp_angle behavior when angles are approximately PI apart

(cherry picked from commit 492903a0b221ac50c5db0426d22db2457f946b58)
Haoyu Qiu 3 years ago
parent
commit
86b14496b1
1 changed files with 1 additions and 0 deletions
  1. 1 0
      modules/gdscript/doc_classes/@GDScript.xml

+ 1 - 0
modules/gdscript/doc_classes/@GDScript.xml

@@ -521,6 +521,7 @@
 				    rotation = lerp_angle(min_angle, max_angle, elapsed)
 				    rotation = lerp_angle(min_angle, max_angle, elapsed)
 				    elapsed += delta
 				    elapsed += delta
 				[/codeblock]
 				[/codeblock]
+				[b]Note:[/b] This method lerps through the shortest path between [code]from[/code] and [code]to[/code]. However, when these two angles are approximately [code]PI + k * TAU[/code] apart for any integer [code]k[/code], it's not obvious which way they lerp due to floating-point precision errors. For example, [code]lerp_angle(0, PI, weight)[/code] lerps counter-clockwise, while [code]lerp_angle(0, PI + 5 * TAU, weight)[/code] lerps clockwise.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="linear2db">
 		<method name="linear2db">