summaryrefslogtreecommitdiff
path: root/doc/classes/Node2D.xml
diff options
context:
space:
mode:
authorAvantir-Chaosfire <Avantir-Chaosfire@users.noreply.github.com>2020-02-23 19:38:32 -0800
committerAvantir-Chaosfire <Avantir-Chaosfire@users.noreply.github.com>2020-04-29 09:44:51 +0200
commit5c6f824e7136bff5d9323cb1a804cfe8fbf9262b (patch)
tree252d609f9582640906db075ef962c6ed91b863f2 /doc/classes/Node2D.xml
parent5cae0f3402a2cc8b336fc6669e553a8b419c3564 (diff)
doc: Improve Node2D to_local/to_global description
Diffstat (limited to 'doc/classes/Node2D.xml')
-rw-r--r--doc/classes/Node2D.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml
index 9f017e9aed..d4517f0588 100644
--- a/doc/classes/Node2D.xml
+++ b/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">