diff options
| author | Julian Murgia - StraToN | 2016-04-26 22:46:52 +0200 |
|---|---|---|
| committer | Rémi Verschelde | 2016-04-27 20:19:37 +0200 |
| commit | d183a5361f17ae4a65dbfc09f0835459592f285d (patch) | |
| tree | 0ea7e96b4a1fd5c863ab576d67a3ab439ed543a1 | |
| parent | 11aa0d140565630add56673333c01f93306194a3 (diff) | |
| download | godot-d183a5361f17ae4a65dbfc09f0835459592f285d.tar.gz godot-d183a5361f17ae4a65dbfc09f0835459592f285d.tar.zst godot-d183a5361f17ae4a65dbfc09f0835459592f285d.zip | |
Documented Node2D
(cherry picked from commit 87aa1282285fe4c71caa82740b7f1d6ddb5643b6)
| -rw-r--r-- | doc/base/classes.xml | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index d9480cd29..7b372c172 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -19363,21 +19363,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="pos" type="Vector2"> </argument> <description> - Set the position of the 2d node. + Set the position of the 2D node. </description> </method> <method name="set_rot"> <argument index="0" name="rot" type="float"> </argument> <description> - Set the rotation of the 2d node. + Set the rotation of the 2D node. </description> </method> <method name="set_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the scale of the 2d node. + Set the scale of the 2D node. </description> </method> <method name="get_pos" qualifiers="const"> @@ -19405,6 +19405,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="radians" type="float"> </argument> <description> + Apply a 'radians' rotation to the 2D node, starting from its current rotation. </description> </method> <method name="move_local_x"> @@ -19413,6 +19414,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> + Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. </description> </method> <method name="move_local_y"> @@ -19421,30 +19423,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> + Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. </description> </method> <method name="translate"> <argument index="0" name="offset" type="Vector2"> </argument> <description> + Apply a local translation of 'offset' to the 2D node, starting from its current local position. </description> </method> <method name="global_translate"> <argument index="0" name="offset" type="Vector2"> </argument> <description> + Apply a global translation of 'offset' to the 2D node, starting from its current global position. </description> </method> <method name="scale"> <argument index="0" name="ratio" type="Vector2"> </argument> <description> + Apply the 'ratio' scale to the 2D node, according to its current scale value. </description> </method> <method name="set_global_pos"> <argument index="0" name="pos" type="Vector2"> </argument> <description> + Set the global position of the 2D node to 'pos'. </description> </method> <method name="get_global_pos" qualifiers="const"> @@ -19458,18 +19465,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="xform" type="Matrix32"> </argument> <description> + Set the local transform [Matrix32] of the 2D node. </description> </method> <method name="set_global_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> <description> + Set the global transform [Matrix32] of the 2D node. </description> </method> <method name="look_at"> <argument index="0" name="point" type="Vector2"> </argument> <description> + Rotate the 2d node so it points at 'point' position. </description> </method> <method name="get_angle_to" qualifiers="const"> @@ -19478,36 +19488,42 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="point" type="Vector2"> </argument> <description> + Return the rotation angle needed for the 2d node to point at 'point' position. </description> </method> <method name="set_z"> <argument index="0" name="z" type="int"> </argument> <description> + Set the Z-index value of the 2D node. </description> </method> <method name="get_z" qualifiers="const"> <return type="int"> </return> <description> + Return the Z-index of the 2D node. </description> </method> <method name="set_z_as_relative"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5. </description> </method> <method name="is_z_relative" qualifiers="const"> <return type="bool"> </return> <description> + Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. </description> </method> <method name="edit_set_pivot"> <argument index="0" name="pivot" type="Vector2"> </argument> <description> + Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. </description> </method> <method name="get_relative_transform_to_parent" qualifiers="const"> @@ -19516,6 +19532,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="parent" type="Object"> </argument> <description> + Return the transform [Matrix32] calculated relatively to the parent of this 2D node. </description> </method> </methods> |
