Browse Source

doc: Improve Node2D to_local/to_global description

(cherry picked from commit 5c6f824e7136bff5d9323cb1a804cfe8fbf9262b)
Avantir-Chaosfire 5 years ago
parent
commit
fd6424aa04
1 changed files with 2 additions and 2 deletions
  1. 2 2
      doc/classes/Node2D.xml

+ 2 - 2
doc/classes/Node2D.xml

@@ -92,7 +92,7 @@
 			<argument index="0" name="local_point" type="Vector2">
 			</argument>
 			<description>
-				Converts a local point's coordinates to global coordinates.
+				Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the [Node2D] it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position.
 			</description>
 		</method>
 		<method name="to_local" qualifiers="const">
@@ -101,7 +101,7 @@
 			<argument index="0" name="global_point" type="Vector2">
 			</argument>
 			<description>
-				Converts a global point's coordinates to local coordinates.
+				Transforms the provided global position into a position in local coordinate space. The output will be local relative to the [Node2D] it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent.
 			</description>
 		</method>
 		<method name="translate">