diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-04-29 13:04:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-29 13:04:19 +0200 |
| commit | b3da42942301e621b0fe64474dbbe0b39cef336b (patch) | |
| tree | 48d9b3ae76fa208549aa2c414d6ce7e8007b235e | |
| parent | a277c895563840c7732dfc70065e7aae296d2e11 (diff) | |
| parent | 5c6f824e7136bff5d9323cb1a804cfe8fbf9262b (diff) | |
Merge pull request #36498 from Avantir-Chaosfire/patch-1
doc: Improve Node2D to_local/to_global description
| -rw-r--r-- | doc/classes/Node2D.xml | 4 |
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"> |