2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "Node2D" inherits= "CanvasItem" version= "3.3" >
2017-09-12 22:42:36 +02:00
<brief_description >
2019-12-26 19:24:29 +01:00
A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2019-12-26 19:24:29 +01:00
A 2D game object, with a transform (position, rotation, and scale). All 2D nodes, including physics objects and sprites, inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control of the node's render order.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2021-03-26 10:43:43 +01:00
<link title= "Custom drawing in 2D" > https://docs.godotengine.org/en/3.3/tutorials/2d/custom_drawing_in_2d.html</link>
2020-10-01 10:34:47 +02:00
<link title= "All 2D Demos" > https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "apply_scale" >
<return type= "void" >
</return>
<argument index= "0" name= "ratio" type= "Vector2" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Multiplies the current scale by the [code]ratio[/code] vector.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_angle_to" qualifiers= "const" >
<return type= "float" >
</return>
<argument index= "0" name= "point" type= "Vector2" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Returns the angle between the node and the [code]point[/code] in radians.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_relative_transform_to_parent" qualifiers= "const" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "parent" type= "Node" >
</argument>
<description >
Returns the [Transform2D] relative to this node's parent.
</description>
</method>
<method name= "global_translate" >
<return type= "void" >
</return>
<argument index= "0" name= "offset" type= "Vector2" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Adds the [code]offset[/code] vector to the node's global position.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "look_at" >
<return type= "void" >
</return>
<argument index= "0" name= "point" type= "Vector2" >
</argument>
<description >
2019-09-13 13:31:38 +02:00
Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "move_local_x" >
<return type= "void" >
</return>
<argument index= "0" name= "delta" type= "float" >
</argument>
<argument index= "1" name= "scaled" type= "bool" default= "false" >
</argument>
<description >
2019-04-17 13:42:56 +02:00
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 [code]false[/code], normalizes the movement.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "move_local_y" >
<return type= "void" >
</return>
<argument index= "0" name= "delta" type= "float" >
</argument>
<argument index= "1" name= "scaled" type= "bool" default= "false" >
</argument>
<description >
2019-04-17 13:42:56 +02:00
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 [code]false[/code], normalizes the movement.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "rotate" >
<return type= "void" >
</return>
<argument index= "0" name= "radians" type= "float" >
</argument>
<description >
2017-10-22 22:43:35 +02:00
Applies a rotation to the node, in radians, starting from its current rotation.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "to_global" qualifiers= "const" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "local_point" type= "Vector2" >
</argument>
<description >
2020-02-24 04:38:32 +01:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "to_local" qualifiers= "const" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "global_point" type= "Vector2" >
</argument>
<description >
2020-02-24 04:38:32 +01:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "translate" >
<return type= "void" >
</return>
<argument index= "0" name= "offset" type= "Vector2" >
</argument>
<description >
2017-10-22 22:43:35 +02:00
Translates the node by the given [code]offset[/code] in local coordinates.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-06-29 21:22:15 +02:00
<member name= "global_position" type= "Vector2" setter= "set_global_position" getter= "get_global_position" >
2017-09-12 22:42:36 +02:00
Global position.
</member>
2019-06-29 21:22:15 +02:00
<member name= "global_rotation" type= "float" setter= "set_global_rotation" getter= "get_global_rotation" >
2017-09-12 22:42:36 +02:00
Global rotation in radians.
</member>
2019-06-29 21:22:15 +02:00
<member name= "global_rotation_degrees" type= "float" setter= "set_global_rotation_degrees" getter= "get_global_rotation_degrees" >
2017-09-12 22:42:36 +02:00
Global rotation in degrees.
</member>
2019-06-29 21:22:15 +02:00
<member name= "global_scale" type= "Vector2" setter= "set_global_scale" getter= "get_global_scale" >
2017-09-12 22:42:36 +02:00
Global scale.
</member>
2019-06-29 21:22:15 +02:00
<member name= "global_transform" type= "Transform2D" setter= "set_global_transform" getter= "get_global_transform" >
2017-09-12 22:42:36 +02:00
Global [Transform2D].
</member>
2019-06-29 12:38:01 +02:00
<member name= "position" type= "Vector2" setter= "set_position" getter= "get_position" default= "Vector2( 0, 0 )" >
2017-09-12 22:42:36 +02:00
Position, relative to the node's parent.
</member>
2019-06-29 12:38:01 +02:00
<member name= "rotation" type= "float" setter= "set_rotation" getter= "get_rotation" default= "0.0" >
2018-01-11 23:38:35 +01:00
Rotation in radians, relative to the node's parent.
</member>
2019-06-29 12:38:01 +02:00
<member name= "rotation_degrees" type= "float" setter= "set_rotation_degrees" getter= "get_rotation_degrees" default= "0.0" >
2017-10-27 00:30:23 +02:00
Rotation in degrees, relative to the node's parent.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "scale" type= "Vector2" setter= "set_scale" getter= "get_scale" default= "Vector2( 1, 1 )" >
2019-06-22 01:04:47 +02:00
The node's scale. Unscaled value: [code](1, 1)[/code].
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 21:22:15 +02:00
<member name= "transform" type= "Transform2D" setter= "set_transform" getter= "get_transform" >
2017-09-12 22:42:36 +02:00
Local [Transform2D].
</member>
2019-06-29 12:38:01 +02:00
<member name= "z_as_relative" type= "bool" setter= "set_z_as_relative" getter= "is_z_relative" default= "true" >
2019-06-22 01:04:47 +02:00
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.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "z_index" type= "int" setter= "set_z_index" getter= "get_z_index" default= "0" >
2021-05-20 00:42:08 +02:00
Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between [constant VisualServer.CANVAS_ITEM_Z_MIN] and [constant VisualServer.CANVAS_ITEM_Z_MAX] (inclusive).
2018-01-04 01:48:24 +01:00
</member>
2017-09-12 22:42:36 +02:00
</members>
<constants >
</constants>
</class>