Files
godot-docs/classes/class_position2d.rst
2022-06-08 13:39:15 +02:00

51 lines
2.2 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Position2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Position2D:
Position2D
==========
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Generic 2D position hint for editing.
Description
-----------
Generic 2D position hint for editing. It's just like a plain :ref:`Node2D<class_Node2D>`, but it displays as a cross in the 2D editor at all times. You can set cross' visual size by using the gizmo in the 2D editor while the node is selected.
Properties
----------
+---------------------------+---------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`gizmo_extents<class_Position2D_property_gizmo_extents>` | ``10.0`` |
+---------------------------+---------------------------------------------------------------+----------+
Property Descriptions
---------------------
.. _class_Position2D_property_gizmo_extents:
- :ref:`float<class_float>` **gizmo_extents**
+-----------+--------------------------+
| *Default* | ``10.0`` |
+-----------+--------------------------+
| *Setter* | set_gizmo_extents(value) |
+-----------+--------------------------+
| *Getter* | get_gizmo_extents() |
+-----------+--------------------------+
Size of the gizmo cross that appears in the editor.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`