Difference between revisions of "love.keyboard.isScancodeDown"

m (Fixed heading.)
m (Added table variant available since 0.10.2)
Line 12: Line 12:
 
{{param|Scancode|scancode|A Scancode to check.}}
 
{{param|Scancode|scancode|A Scancode to check.}}
 
{{param|Scancode|...|Additional Scancodes to check.}}
 
{{param|Scancode|...|Additional Scancodes to check.}}
 +
=== Returns ===
 +
{{param|boolean|down|True if any supplied Scancode is down, false if not.}}
 +
 +
== Function ==
 +
{{newin|[[0.10.2]]|102|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
down = love.keyboard.isScancodeDown({ scancode, ... })
 +
</source>
 +
=== Arguments ===
 +
{{param|table|scancodes|Table of Scancodes to check.}}
 +
{{subparam|Scancode|scancode|A Scancode to check.}}
 +
{{subparam|Scancode|...|Additional Scancodes to check.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|down|True if any supplied Scancode is down, false if not.}}
 
{{param|boolean|down|True if any supplied Scancode is down, false if not.}}

Revision as of 13:12, 7 December 2022

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

Checks whether the specified Scancodes are pressed. Not to be confused with love.keypressed or love.keyreleased.

Unlike regular KeyConstants, Scancodes are keyboard layout-independent. The scancode "w" is used if the key in the same place as the "w" key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are.

Function

Synopsis

down = love.keyboard.isScancodeDown( scancode, ... )

Arguments

Scancode scancode
A Scancode to check.
Scancode ...
Additional Scancodes to check.

Returns

boolean down
True if any supplied Scancode is down, false if not.

Function

Available since LÖVE 0.10.2
This variant is not supported in earlier versions.

Synopsis

down = love.keyboard.isScancodeDown({ scancode, ... })

Arguments

table scancodes
Table of Scancodes to check.
Scancode scancode
A Scancode to check.
Scancode ...
Additional Scancodes to check.

Returns

boolean down
True if any supplied Scancode is down, false if not.

Examples

Standard WASD or arrow keys for movement

function love.update(dt)
	local up    = love.keyboard.isScancodeDown('w', 'up')
	local down  = love.keyboard.isScancodeDown('s', 'down')
	local left  = love.keyboard.isScancodeDown('a', 'left')
	local right = love.keyboard.isScancodeDown('d', 'right')
end

See Also

Other Languages