diff options
Diffstat (limited to 'doc/classes/Node2D.xml')
| -rw-r--r-- | doc/classes/Node2D.xml | 36 |
1 files changed, 17 insertions, 19 deletions
diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 80f9329402..abdbfa09f7 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node2D" inherits="CanvasItem" category="Core" version="3.1"> +<class name="Node2D" inherits="CanvasItem" category="Core" version="3.2"> <brief_description> - A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. + A 2D game object, parent of all 2D-related nodes. Has a position, rotation, scale and Z index. </brief_description> <description> A 2D game object, with a position, rotation and scale. All 2D physics nodes and sprites inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control on the node's render order. @@ -9,8 +9,6 @@ <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link> </tutorials> - <demos> - </demos> <methods> <method name="apply_scale"> <return type="void"> @@ -18,7 +16,7 @@ <argument index="0" name="ratio" type="Vector2"> </argument> <description> - Multiplies the current scale by the 'ratio' vector. + Multiplies the current scale by the [code]ratio[/code] vector. </description> </method> <method name="get_angle_to" qualifiers="const"> @@ -27,7 +25,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Returns the angle between the node and the 'point' in radians. + Returns the angle between the node and the [code]point[/code] in radians. </description> </method> <method name="get_relative_transform_to_parent" qualifiers="const"> @@ -45,7 +43,7 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> - Adds the 'offset' vector to the node's global position. + Adds the [code]offset[/code] vector to the node's global position. </description> </method> <method name="look_at"> @@ -54,7 +52,7 @@ <argument index="0" name="point" type="Vector2"> </argument> <description> - Rotates the node so it points towards the 'point'. + Rotates the node so it points towards the [code]point[/code]. </description> </method> <method name="move_local_x"> @@ -65,7 +63,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - 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. + 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. </description> </method> <method name="move_local_y"> @@ -76,7 +74,7 @@ <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - 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. + 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. </description> </method> <method name="rotate"> @@ -132,26 +130,26 @@ <member name="global_transform" type="Transform2D" setter="set_global_transform" getter="get_global_transform"> Global [Transform2D]. </member> - <member name="position" type="Vector2" setter="set_position" getter="get_position"> + <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2( 0, 0 )"> Position, relative to the node's parent. </member> - <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> + <member name="rotation" type="float" setter="set_rotation" getter="get_rotation" default="0.0"> Rotation in radians, relative to the node's parent. </member> - <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees"> + <member name="rotation_degrees" type="float" setter="set_rotation_degrees" getter="get_rotation_degrees" default="0.0"> Rotation in degrees, relative to the node's parent. </member> - <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> - The node's scale. Unscaled value: [code](1, 1)[/code] + <member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2( 1, 1 )"> + The node's scale. Unscaled value: [code](1, 1)[/code]. </member> <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> Local [Transform2D]. </member> - <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative"> - 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 name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_relative" default="true"> + 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> - <member name="z_index" type="int" setter="set_z_index" getter="get_z_index"> - Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. + <member name="z_index" type="int" setter="set_z_index" getter="get_z_index" default="0"> + Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. </member> </members> <constants> |