Difference between revisions of "Joystick:getGamepadAxis"
(Created page) |
(→See Also) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{newin|[[0.9.0]]|090|type=function}} | {{newin|[[0.9.0]]|090|type=function}} | ||
− | Gets the direction of a virtual gamepad axis. If the Joystick isn't recognized as a [[Joystick:isGamepad|gamepad]] or isn't connected, | + | Gets the direction of a virtual gamepad axis. If the Joystick isn't recognized as a [[Joystick:isGamepad|gamepad]] or isn't connected, this function will always return 0. |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
Line 10: | Line 10: | ||
=== Returns === | === Returns === | ||
{{param|number|direction|Current value of the axis.}} | {{param|number|direction|Current value of the axis.}} | ||
+ | == Examples == | ||
+ | === Move x and y values based on a gamepad thumbstick === | ||
+ | <source lang="lua"> | ||
+ | function love.load() | ||
+ | x = 0 | ||
+ | y = 0 | ||
+ | p1joystick = nil | ||
+ | end | ||
+ | |||
+ | function love.joystickadded(joystick) | ||
+ | p1joystick = joystick | ||
+ | end | ||
+ | |||
+ | function love.update(dt) | ||
+ | -- Check if joystick connected | ||
+ | if p1joystick ~= nil then | ||
+ | -- getGamepadAxis returns a value between -1 and 1. | ||
+ | -- It returns 0 when it is at rest | ||
+ | |||
+ | x = x + p1joystick:getGamepadAxis("leftx") | ||
+ | y = y + p1joystick:getGamepadAxis("lefty") | ||
+ | end | ||
+ | end | ||
+ | </source> | ||
== See Also == | == See Also == | ||
* [[parent::Joystick]] | * [[parent::Joystick]] | ||
Line 15: | Line 39: | ||
* [[Joystick:isGamepadDown]] | * [[Joystick:isGamepadDown]] | ||
* [[Joystick:isConnected]] | * [[Joystick:isConnected]] | ||
+ | |||
+ | * [[GamepadAxis]] | ||
+ | * [[love.gamepadaxis]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Gets the direction of a virtual gamepad axis.}} | {{#set:Description=Gets the direction of a virtual gamepad axis.}} | ||
+ | |||
== Other Languages == | == Other Languages == | ||
{{i18n|Joystick:getGamepadAxis}} | {{i18n|Joystick:getGamepadAxis}} |
Latest revision as of 11:49, 17 November 2021
Available since LÖVE 0.9.0 |
This function is not supported in earlier versions. |
Gets the direction of a virtual gamepad axis. If the Joystick isn't recognized as a gamepad or isn't connected, this function will always return 0.
Contents
Function
Synopsis
direction = Joystick:getGamepadAxis( axis )
Arguments
GamepadAxis axis
- The virtual axis to be checked.
Returns
number direction
- Current value of the axis.
Examples
Move x and y values based on a gamepad thumbstick
function love.load()
x = 0
y = 0
p1joystick = nil
end
function love.joystickadded(joystick)
p1joystick = joystick
end
function love.update(dt)
-- Check if joystick connected
if p1joystick ~= nil then
-- getGamepadAxis returns a value between -1 and 1.
-- It returns 0 when it is at rest
x = x + p1joystick:getGamepadAxis("leftx")
y = y + p1joystick:getGamepadAxis("lefty")
end
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info