InputEventKey.xml 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Input event type for keyboard events.
  5. </brief_description>
  6. <description>
  7. </description>
  8. <tutorials>
  9. </tutorials>
  10. <demos>
  11. </demos>
  12. <methods>
  13. <method name="get_scancode" qualifiers="const">
  14. <return type="int">
  15. </return>
  16. <description>
  17. </description>
  18. </method>
  19. <method name="get_scancode_with_modifiers" qualifiers="const">
  20. <return type="int">
  21. </return>
  22. <description>
  23. </description>
  24. </method>
  25. <method name="get_unicode" qualifiers="const">
  26. <return type="int">
  27. </return>
  28. <description>
  29. </description>
  30. </method>
  31. <method name="set_echo">
  32. <return type="void">
  33. </return>
  34. <argument index="0" name="echo" type="bool">
  35. </argument>
  36. <description>
  37. </description>
  38. </method>
  39. <method name="set_pressed">
  40. <return type="void">
  41. </return>
  42. <argument index="0" name="pressed" type="bool">
  43. </argument>
  44. <description>
  45. </description>
  46. </method>
  47. <method name="set_scancode">
  48. <return type="void">
  49. </return>
  50. <argument index="0" name="scancode" type="int">
  51. </argument>
  52. <description>
  53. </description>
  54. </method>
  55. <method name="set_unicode">
  56. <return type="void">
  57. </return>
  58. <argument index="0" name="unicode" type="int">
  59. </argument>
  60. <description>
  61. </description>
  62. </method>
  63. </methods>
  64. <members>
  65. <member name="echo" type="bool" setter="set_echo" getter="is_echo">
  66. Echo state of the key, i.e. whether it's a repeat event or not.
  67. </member>
  68. <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
  69. Pressed state of the key.
  70. </member>
  71. <member name="scancode" type="int" setter="set_scancode" getter="get_scancode">
  72. Scancode of the key, one of the KEY_* constants in [@Global Scope].
  73. </member>
  74. <member name="unicode" type="int" setter="set_unicode" getter="get_unicode">
  75. Unicode identifier of the key (when relevant).
  76. </member>
  77. </members>
  78. <constants>
  79. </constants>
  80. </class>