class_inputeventmidi.rst 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the InputEventMIDI.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_InputEventMIDI:
  6. InputEventMIDI
  7. ==============
  8. **Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +-----------------------+---------------------------------------------------------------------------+---+
  15. | :ref:`int<class_int>` | :ref:`channel<class_InputEventMIDI_property_channel>` | 0 |
  16. +-----------------------+---------------------------------------------------------------------------+---+
  17. | :ref:`int<class_int>` | :ref:`controller_number<class_InputEventMIDI_property_controller_number>` | 0 |
  18. +-----------------------+---------------------------------------------------------------------------+---+
  19. | :ref:`int<class_int>` | :ref:`controller_value<class_InputEventMIDI_property_controller_value>` | 0 |
  20. +-----------------------+---------------------------------------------------------------------------+---+
  21. | :ref:`int<class_int>` | :ref:`instrument<class_InputEventMIDI_property_instrument>` | 0 |
  22. +-----------------------+---------------------------------------------------------------------------+---+
  23. | :ref:`int<class_int>` | :ref:`message<class_InputEventMIDI_property_message>` | 0 |
  24. +-----------------------+---------------------------------------------------------------------------+---+
  25. | :ref:`int<class_int>` | :ref:`pitch<class_InputEventMIDI_property_pitch>` | 0 |
  26. +-----------------------+---------------------------------------------------------------------------+---+
  27. | :ref:`int<class_int>` | :ref:`pressure<class_InputEventMIDI_property_pressure>` | 0 |
  28. +-----------------------+---------------------------------------------------------------------------+---+
  29. | :ref:`int<class_int>` | :ref:`velocity<class_InputEventMIDI_property_velocity>` | 0 |
  30. +-----------------------+---------------------------------------------------------------------------+---+
  31. Property Descriptions
  32. ---------------------
  33. .. _class_InputEventMIDI_property_channel:
  34. - :ref:`int<class_int>` **channel**
  35. +-----------+--------------------+
  36. | *Default* | 0 |
  37. +-----------+--------------------+
  38. | *Setter* | set_channel(value) |
  39. +-----------+--------------------+
  40. | *Getter* | get_channel() |
  41. +-----------+--------------------+
  42. .. _class_InputEventMIDI_property_controller_number:
  43. - :ref:`int<class_int>` **controller_number**
  44. +-----------+------------------------------+
  45. | *Default* | 0 |
  46. +-----------+------------------------------+
  47. | *Setter* | set_controller_number(value) |
  48. +-----------+------------------------------+
  49. | *Getter* | get_controller_number() |
  50. +-----------+------------------------------+
  51. .. _class_InputEventMIDI_property_controller_value:
  52. - :ref:`int<class_int>` **controller_value**
  53. +-----------+-----------------------------+
  54. | *Default* | 0 |
  55. +-----------+-----------------------------+
  56. | *Setter* | set_controller_value(value) |
  57. +-----------+-----------------------------+
  58. | *Getter* | get_controller_value() |
  59. +-----------+-----------------------------+
  60. .. _class_InputEventMIDI_property_instrument:
  61. - :ref:`int<class_int>` **instrument**
  62. +-----------+-----------------------+
  63. | *Default* | 0 |
  64. +-----------+-----------------------+
  65. | *Setter* | set_instrument(value) |
  66. +-----------+-----------------------+
  67. | *Getter* | get_instrument() |
  68. +-----------+-----------------------+
  69. .. _class_InputEventMIDI_property_message:
  70. - :ref:`int<class_int>` **message**
  71. +-----------+--------------------+
  72. | *Default* | 0 |
  73. +-----------+--------------------+
  74. | *Setter* | set_message(value) |
  75. +-----------+--------------------+
  76. | *Getter* | get_message() |
  77. +-----------+--------------------+
  78. .. _class_InputEventMIDI_property_pitch:
  79. - :ref:`int<class_int>` **pitch**
  80. +-----------+------------------+
  81. | *Default* | 0 |
  82. +-----------+------------------+
  83. | *Setter* | set_pitch(value) |
  84. +-----------+------------------+
  85. | *Getter* | get_pitch() |
  86. +-----------+------------------+
  87. .. _class_InputEventMIDI_property_pressure:
  88. - :ref:`int<class_int>` **pressure**
  89. +-----------+---------------------+
  90. | *Default* | 0 |
  91. +-----------+---------------------+
  92. | *Setter* | set_pressure(value) |
  93. +-----------+---------------------+
  94. | *Getter* | get_pressure() |
  95. +-----------+---------------------+
  96. .. _class_InputEventMIDI_property_velocity:
  97. - :ref:`int<class_int>` **velocity**
  98. +-----------+---------------------+
  99. | *Default* | 0 |
  100. +-----------+---------------------+
  101. | *Setter* | set_velocity(value) |
  102. +-----------+---------------------+
  103. | *Getter* | get_velocity() |
  104. +-----------+---------------------+