Difference between revisions of "cock.getJoystickDeadzone"

(Created page with "Gets joystick deadzone. == Synopsis == === Function === <source lang="Lua">threshold = cock.getJoystickDeadzone ( self, joystick, axis )</source> === Arguments === {{param|table|...")
 
m
Line 5: Line 5:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|table|self|An object to use.}}
 
{{param|table|self|An object to use.}}
{{param|number|joystick|Internal joystick number.}}
+
{{param|number|joystick|Optional. Internal joystick number. Will use 1 if not provided.}}
{{param|string|joystick|Internal joystick name.}}
+
{{param|string|joystick|Optional. Internal joystick name.}}
{{param|number|axis|Optional. LÖVE joystick axis.}}
+
{{param|number|axis|Optional. LÖVE joystick axis. Will use 1 if not provided.}}
 
{{param|string|axis|Optional. [[Common Organization of Controls Kit Input keys|Axis]] name.}}
 
{{param|string|axis|Optional. [[Common Organization of Controls Kit Input keys|Axis]] name.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|number|threshold|Deadzone threshold.}}
 
{{param|number|threshold|Deadzone threshold.}}
== Remarks ==
 
Axis parameter is optional. If not provided, function will return threshold for axis #1.
 
 
==See also==
 
==See also==
 
*[[cock.setJoystickDeadzone]]
 
*[[cock.setJoystickDeadzone]]

Revision as of 18:17, 1 September 2013

Gets joystick deadzone.

Synopsis

Function

threshold = cock.getJoystickDeadzone ( self, joystick, axis )

Arguments

table self
An object to use.
number joystick
Optional. Internal joystick number. Will use 1 if not provided.
string joystick
Optional. Internal joystick name.
number axis
Optional. LÖVE joystick axis. Will use 1 if not provided.
string axis
Optional. Axis name.

Returns

number threshold
Deadzone threshold.

See also