InputEventJoypadButton.xml 1.3 KB

1234567891011121314151617181920212223242526272829
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="InputEventJoypadButton" inherits="InputEvent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Input event for gamepad buttons.
  5. </brief_description>
  6. <description>
  7. Input event type for gamepad buttons. For gamepad analog sticks and joysticks, see [InputEventJoypadMotion].
  8. </description>
  9. <tutorials>
  10. <link>$DOCS_URL/tutorials/inputs/inputevent.html</link>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" default="0">
  16. Button identifier. One of the [enum JoystickList] button constants.
  17. </member>
  18. <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
  19. If [code]true[/code], the button's state is pressed. If [code]false[/code], the button's state is released.
  20. </member>
  21. <member name="pressure" type="float" setter="set_pressure" getter="get_pressure" default="0.0">
  22. Represents the pressure the user puts on the button with their finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code].
  23. [b]Note:[/b] This property is never set by the engine and is always [code]0[/code].
  24. </member>
  25. </members>
  26. <constants>
  27. </constants>
  28. </class>