summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventJoypadMotion.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEventJoypadMotion.xml')
-rw-r--r--doc/classes/InputEventJoypadMotion.xml52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml
new file mode 100644
index 0000000000..8a26007fc1
--- /dev/null
+++ b/doc/classes/InputEventJoypadMotion.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Input event type for joypad motion/axis events.
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_axis" qualifiers="const">
+ <return type="int">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_axis_value" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_axis">
+ <return type="void">
+ </return>
+ <argument index="0" name="axis" type="int">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_axis_value">
+ <return type="void">
+ </return>
+ <argument index="0" name="axis_value" type="float">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="axis" type="int" setter="set_axis" getter="get_axis">
+ Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope].
+ </member>
+ <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value">
+ Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>