class_editorspinslider.rst 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the EditorSpinSlider.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_EditorSpinSlider:
  6. EditorSpinSlider
  7. ================
  8. **Inherits:** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Godot editor's control for editing numeric values.
  10. Description
  11. -----------
  12. This :ref:`Control<class_Control>` node is used in the editor's Inspector dock to allow editing of numeric values. Can be used with :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>` to recreate the same behavior.
  13. Properties
  14. ----------
  15. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`flat<class_EditorSpinSlider_property_flat>` | ``false`` |
  17. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  18. | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
  19. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  20. | :ref:`String<class_String>` | :ref:`label<class_EditorSpinSlider_property_label>` | ``""`` |
  21. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`read_only<class_EditorSpinSlider_property_read_only>` | ``false`` |
  23. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`suffix<class_EditorSpinSlider_property_suffix>` | ``""`` |
  25. +------------------------------------------+-------------------------------------------------------------+---------------------------------------------------------------------+
  26. Property Descriptions
  27. ---------------------
  28. .. _class_EditorSpinSlider_property_flat:
  29. - :ref:`bool<class_bool>` **flat**
  30. +-----------+-----------------+
  31. | *Default* | ``false`` |
  32. +-----------+-----------------+
  33. | *Setter* | set_flat(value) |
  34. +-----------+-----------------+
  35. | *Getter* | is_flat() |
  36. +-----------+-----------------+
  37. ----
  38. .. _class_EditorSpinSlider_property_label:
  39. - :ref:`String<class_String>` **label**
  40. +-----------+------------------+
  41. | *Default* | ``""`` |
  42. +-----------+------------------+
  43. | *Setter* | set_label(value) |
  44. +-----------+------------------+
  45. | *Getter* | get_label() |
  46. +-----------+------------------+
  47. ----
  48. .. _class_EditorSpinSlider_property_read_only:
  49. - :ref:`bool<class_bool>` **read_only**
  50. +-----------+----------------------+
  51. | *Default* | ``false`` |
  52. +-----------+----------------------+
  53. | *Setter* | set_read_only(value) |
  54. +-----------+----------------------+
  55. | *Getter* | is_read_only() |
  56. +-----------+----------------------+
  57. ----
  58. .. _class_EditorSpinSlider_property_suffix:
  59. - :ref:`String<class_String>` **suffix**
  60. +-----------+-------------------+
  61. | *Default* | ``""`` |
  62. +-----------+-------------------+
  63. | *Setter* | set_suffix(value) |
  64. +-----------+-------------------+
  65. | *Getter* | get_suffix() |
  66. +-----------+-------------------+
  67. The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed.
  68. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  69. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  70. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  71. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  72. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  73. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`