2
0

InputEventWithModifiers.xml 1.8 KB

123456789101112131415161718192021222324252627282930313233
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventWithModifiers" inherits="InputEventFromWindow" version="4.0">
  3. <brief_description>
  4. Base class for keys events with modifiers.
  5. </brief_description>
  6. <description>
  7. Contains keys events information with modifiers support like [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See [method Node._input].
  8. </description>
  9. <tutorials>
  10. <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link>
  11. </tutorials>
  12. <members>
  13. <member name="alt_pressed" type="bool" setter="set_alt_pressed" getter="is_alt_pressed" default="false">
  14. State of the [kbd]Alt[/kbd] modifier.
  15. </member>
  16. <member name="command_pressed" type="bool" setter="set_command_pressed" getter="is_command_pressed" default="false">
  17. State of the [kbd]Cmd[/kbd] modifier.
  18. </member>
  19. <member name="ctrl_pressed" type="bool" setter="set_ctrl_pressed" getter="is_ctrl_pressed" default="false">
  20. State of the [kbd]Ctrl[/kbd] modifier.
  21. </member>
  22. <member name="meta_pressed" type="bool" setter="set_meta_pressed" getter="is_meta_pressed" default="false">
  23. State of the [kbd]Meta[/kbd] modifier.
  24. </member>
  25. <member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false">
  26. State of the [kbd]Shift[/kbd] modifier.
  27. </member>
  28. <member name="store_command" type="bool" setter="set_store_command" getter="is_storing_command" default="true">
  29. If [code]true[/code], pressing [kbd]Cmd[/kbd] on macOS or [kbd]Ctrl[/kbd] on all other platforms will both be serialized as [member command_pressed]. If [code]false[/code], those same keys will be serialized as [member meta_pressed] on macOS and [member ctrl_pressed] on all other platforms.
  30. This aids with cross-platform compatibility when developing e.g. on Windows for macOS, or vice-versa.
  31. </member>
  32. </members>
  33. </class>