2
0
Эх сурвалжийг харах

Merge pull request #78362 from AThousandShips/doc_curve_fix

Clarify the return value of `Curve2D.sample_baked_with_rotation`
Rémi Verschelde 2 жил өмнө
parent
commit
0c4188fe32

+ 9 - 4
doc/classes/Curve2D.xml

@@ -107,11 +107,16 @@
 			<param index="0" name="offset" type="float" default="0.0" />
 			<param index="1" name="cubic" type="bool" default="false" />
 			<description>
-				Similar to [method sample_baked], but returns [Transform2D] that includes a rotation along the curve. Returns empty transform if length of the curve is [code]0[/code].
+				Similar to [method sample_baked], but returns [Transform2D] that includes a rotation along the curve, with [member Transform2D.origin] as the point position, [member Transform2D.x] as the sideways vector, and [member Transform2D.y] as the forward vector. Returns an empty transform if the length of the curve is [code]0[/code].
 				[codeblock]
-				var transform = curve.sample_baked_with_rotation(offset)
-				position = transform.get_origin()
-				rotation = transform.get_rotation()
+				var baked = curve.sample_baked_with_rotation(offset)
+				# This will rotate and position the node with the up direction pointing along the curve.
+				position = baked.get_origin()
+				rotation = baked.get_rotation()
+				# Alternatively, not preserving scale.
+				transform = baked * Transform2D.FLIP_Y
+				# To match the rotation of PathFollow2D, not preserving scale.
+				transform = Transform2D(baked.y, baked.x, baked.origin)
 				[/codeblock]
 			</description>
 		</method>