virtualx-engine/doc/classes/InputEventJoypadButton.xml
2017-11-24 09:16:52 +01:00

65 lines
2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-beta">
<brief_description>
Input event for gamepad buttons.
</brief_description>
<description>
Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion].
</description>
<tutorials>
http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_button_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_pressure" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_button_index">
<return type="void">
</return>
<argument index="0" name="button_index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_pressure">
<return type="void">
</return>
<argument index="0" name="pressure" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@global Scope].
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released.
</member>
<member name="pressure" type="float" setter="set_pressure" getter="get_pressure">
Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code].
</member>
</members>
<constants>
</constants>
</class>