summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2016-01-25 10:59:13 +0100
committerRémi Verschelde <remi@verschelde.fr>2016-01-25 10:59:13 +0100
commitf2e5b0f5fbfe09bdc3e90abb1d55fa50b364f754 (patch)
tree1e6074d475ca890324bea8210a4d20d14a217505
parent6ceb1c3a9f83234e0703fba1ecb42f09e705a02e (diff)
parentde809f3ed941c0d8d2ffacbb31c047245f90590a (diff)
Merge pull request #3422 from Hinsbart/fixjoydoc
replace InputEvent references with GlobalScope in joystick doc
-rw-r--r--doc/base/classes.xml9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 8128771b6a..435be38bc9 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -13724,7 +13724,7 @@ returns:= "username=user&amp;password=pass"
<argument index="1" name="button" type="int">
</argument>
<description>
- Returns true if the joystick button at the given index is currently pressed. Returns false otherwise. (see JOY_* constans in [InputEvent])
+ Returns if the joystick button at the given index is currently pressed. (see JOY_* constans in [@Global Scope])
</description>
</method>
<method name="is_action_pressed">
@@ -13757,7 +13757,7 @@ returns:= "username=user&amp;password=pass"
<argument index="0" name="device" type="int">
</argument>
<description>
- Returns true if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in [InputEvent]. Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
+ Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
</description>
</method>
<method name="get_joy_axis">
@@ -13768,7 +13768,7 @@ returns:= "username=user&amp;password=pass"
<argument index="1" name="axis" type="int">
</argument>
<description>
- Returns the current value of the joystick axis at given index (see JOY_* enum in [InputEvent])
+ Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope])
</description>
</method>
<method name="get_joy_name">
@@ -13853,6 +13853,7 @@ returns:= "username=user&amp;password=pass"
<argument index="1" name="connected" type="bool">
</argument>
<description>
+ Emitted when a joystick device has been connected or disconnected
</description>
</signal>
</signals>
@@ -20232,7 +20233,7 @@ returns:= "username=user&amp;password=pass"
<argument index="1" name="arguments" type="Array" default="Array()">
</argument>
<description>
- Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@GlobalScope] TYPE_*).
+ Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*).
</description>
</method>
<method name="has_user_signal" qualifiers="const">