Difference between revisions of "Joystick:getID"

(Added second return value)
m
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
id, instance_id = Joystick:getID( )
+
id, instanceid = Joystick:getID( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|number|id|The Joystick's unique identifier.}}
+
{{param|number|id|The Joystick's unique identifier. Remains the same as long as the game is running.}}
{{param|number|instance_id (nil)|Unique identifier which changes every time the Joystick is reconnected. nil if the Joystick is not connected.}}
+
{{param|number|instanceid (nil)|Unique instance identifier. Changes every time the Joystick is reconnected. nil if the Joystick is not connected.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Joystick]]
 
* [[parent::Joystick]]
 
* [[Joystick:isConnected]]
 
* [[Joystick:isConnected]]
* [[Joystick:getProductGUID]]
+
* [[Joystick:getGUID]]
* [[Joystick:getConnectedIndex]]
 
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Gets the joystick's unique identifier.}}
 
{{#set:Description=Gets the joystick's unique identifier.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Joystick:getID}}
 
{{i18n|Joystick:getID}}

Latest revision as of 02:46, 31 August 2013

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Gets the joystick's unique identifier. The identifier will remain the same for the life of the game, even when the Joystick is disconnected and reconnected, but it will change when the game is re-launched.

Function

Synopsis

id, instanceid = Joystick:getID( )

Arguments

None.

Returns

number id
The Joystick's unique identifier. Remains the same as long as the game is running.
number instanceid (nil)
Unique instance identifier. Changes every time the Joystick is reconnected. nil if the Joystick is not connected.

See Also

Other Languages