summaryrefslogtreecommitdiff
path: root/doc/classes/Node2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Node2D.xml')
-rw-r--r--doc/classes/Node2D.xml56
1 files changed, 29 insertions, 27 deletions
diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml
index 084bee92df..2fdc6bf440 100644
--- a/doc/classes/Node2D.xml
+++ b/doc/classes/Node2D.xml
@@ -26,7 +26,7 @@
<argument index="0" name="pivot" type="Vector2">
</argument>
<description>
- Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method.
+ Sets the node's pivot position.
</description>
</method>
<method name="get_angle_to" qualifiers="const">
@@ -52,7 +52,7 @@
Returns the node's global rotation in radians.
</description>
</method>
- <method name="get_global_rotation_in_degrees" qualifiers="const">
+ <method name="get_global_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -89,7 +89,7 @@
Returns the node's rotation in radians.
</description>
</method>
- <method name="get_rotation_in_degrees" qualifiers="const">
+ <method name="get_rotation_degrees" qualifiers="const">
<return type="float">
</return>
<description>
@@ -143,7 +143,7 @@
<argument index="1" name="scaled" type="bool" default="false">
</argument>
<description>
- Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement.
+ Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement.
</description>
</method>
<method name="move_local_y">
@@ -154,7 +154,7 @@
<argument index="1" name="scaled" type="bool" default="false">
</argument>
<description>
- Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement.
+ Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is false, normalizes the movement.
</description>
</method>
<method name="rotate">
@@ -163,7 +163,7 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
- Apply a rotation to the node, in radians, starting from its current rotation.
+ Applies a rotation to the node, in radians, starting from its current rotation.
</description>
</method>
<method name="set_global_position">
@@ -172,7 +172,7 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
- Set the node's global position.
+ Sets the node's global position.
</description>
</method>
<method name="set_global_rotation">
@@ -181,16 +181,16 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
- Set the node's global rotation in radians.
+ Sets the node's global rotation in radians.
</description>
</method>
- <method name="set_global_rotation_in_degrees">
+ <method name="set_global_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
- Set the node's global rotation in degrees.
+ Sets the node's global rotation in degrees.
</description>
</method>
<method name="set_global_scale">
@@ -199,7 +199,7 @@
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
- Set the node's global scale.
+ Sets the node's global scale.
</description>
</method>
<method name="set_global_transform">
@@ -208,7 +208,7 @@
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
- Set the node's global [Transform2D].
+ Sets the node's global [Transform2D].
</description>
</method>
<method name="set_position">
@@ -217,7 +217,7 @@
<argument index="0" name="position" type="Vector2">
</argument>
<description>
- Set the node's position.
+ Sets the node's position.
</description>
</method>
<method name="set_rotation">
@@ -226,16 +226,16 @@
<argument index="0" name="radians" type="float">
</argument>
<description>
- Set the node's rotation in radians.
+ Sets the node's rotation in radians.
</description>
</method>
- <method name="set_rotation_in_degrees">
+ <method name="set_rotation_degrees">
<return type="void">
</return>
<argument index="0" name="degrees" type="float">
</argument>
<description>
- Set the node's rotation in degrees.
+ Sets the node's rotation in degrees.
</description>
</method>
<method name="set_scale">
@@ -244,7 +244,7 @@
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
- Set the node's scale.
+ Sets the node's scale.
</description>
</method>
<method name="set_transform">
@@ -253,7 +253,7 @@
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
- Set the node's local [Transform2D].
+ Sets the node's local [Transform2D].
</description>
</method>
<method name="set_z">
@@ -262,7 +262,7 @@
<argument index="0" name="z" type="int">
</argument>
<description>
- Set the node's Z-index.
+ Sets the node's Z-index.
</description>
</method>
<method name="set_z_as_relative">
@@ -271,7 +271,7 @@
<argument index="0" name="enable" type="bool">
</argument>
<description>
- Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
+ Makes the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
</description>
</method>
<method name="to_global" qualifiers="const">
@@ -280,6 +280,7 @@
<argument index="0" name="local_point" type="Vector2">
</argument>
<description>
+ Converts a local point's coordinates to global coordinates.
</description>
</method>
<method name="to_local" qualifiers="const">
@@ -288,6 +289,7 @@
<argument index="0" name="global_point" type="Vector2">
</argument>
<description>
+ Converts a global point's coordinates to local coordinates.
</description>
</method>
<method name="translate">
@@ -296,7 +298,7 @@
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
- Translate the node locally by the 'offset' vector, starting from its current local position.
+ Translates the node by the given [code]offset[/code] in local coordinates.
</description>
</method>
</methods>
@@ -307,7 +309,7 @@
<member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation">
Global rotation in radians.
</member>
- <member name="global_rotation_deg" type="float" setter="set_global_rotation_in_degrees" getter="get_global_rotation_in_degrees">
+ <member name="global_rotation_degrees" type="float" setter="set_global_rotation_degrees" getter="get_global_rotation_degrees">
Global rotation in degrees.
</member>
<member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale">
@@ -320,13 +322,13 @@
Position, relative to the node's parent.
</member>
<member name="rotation" type="float" setter="set_rotation" getter="get_rotation">
- Rotation in radians.
+ Rotation in radians, relative to the node's parent.
</member>
- <member name="rotation_deg" type="float" setter="set_rotation_in_degrees" getter="get_rotation_in_degrees">
- Rotation in degrees.
+ <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees">
+ Rotation in degrees, relative to the node's parent.
</member>
<member name="scale" type="Vector2" setter="set_scale" getter="get_scale">
- Rotation in degrees.
+ The node's scale. Unscaled value: [code](1, 1)[/code]
</member>
<member name="transform" type="Transform2D" setter="set_transform" getter="get_transform">
Local [Transform2D].
@@ -335,7 +337,7 @@
Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others.
</member>
<member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative">
- Make the node's Z-index relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
+ If [code]true[/code] the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5.
</member>
</members>
<constants>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-31 07:30:56 +0000