class_position2d.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Position2D.xml.
  6. .. _class_Position2D:
  7. Position2D
  8. ==========
  9. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Generic 2D position hint for editing.
  11. Description
  12. -----------
  13. 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.
  14. Properties
  15. ----------
  16. +---------------------------+---------------------------------------------------------------+----------+
  17. | :ref:`float<class_float>` | :ref:`gizmo_extents<class_Position2D_property_gizmo_extents>` | ``10.0`` |
  18. +---------------------------+---------------------------------------------------------------+----------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_Position2D_property_gizmo_extents:
  22. - :ref:`float<class_float>` **gizmo_extents**
  23. +-----------+--------------------------+
  24. | *Default* | ``10.0`` |
  25. +-----------+--------------------------+
  26. | *Setter* | set_gizmo_extents(value) |
  27. +-----------+--------------------------+
  28. | *Getter* | get_gizmo_extents() |
  29. +-----------+--------------------------+
  30. Size of the gizmo cross that appears in the editor.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  34. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  35. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  36. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`