Difference between revisions of "Lua:isKeyPressed"
Jump to navigation
Jump to search
m (moved isKeyPressed to Lua:isKeyPressed) |
m (Added CodeBox Template.) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
| − | '''function''' isKeyPressed('' | + | {{CodeBox|'''function''' isKeyPressed(''Key'') ''':''' Boolean}} |
| − | Returns true if the | + | Returns true if the specified key is currently pressed. |
===Function Parameters=== | ===Function Parameters=== | ||
| − | {|width="85%" cellpadding="10 | + | {|width="85%" cellpadding="10%" cellspacing="0" border="0" |
!align="left"|Parameter | !align="left"|Parameter | ||
!align="left"|Type | !align="left"|Type | ||
| − | !style="width: | + | !style="width: 60%;background-color:white;" align="left"|Description |
|- | |- | ||
| − | | | + | |Key |
| − | |[[Virtual-Key Code]] | + | |Integer or [[Virtual-Key Code]] |
| − | |The | + | |The virtual key code of the key to check (e.g., <code>VK_F1</code>, <code>VK_SHIFT</code>). |
|} | |} | ||
| + | ===Returns=== | ||
| + | Boolean — true if the key is pressed, false otherwise. | ||
| + | |||
| + | ===Examples=== | ||
| + | <pre> | ||
| + | if isKeyPressed(VK_SPACE) then | ||
| + | print("Spacebar is currently pressed!") | ||
| + | end | ||
| + | |||
| + | if isKeyPressed(VK_LSHIFT) then | ||
| + | print("Left Shift is pressed") | ||
| + | end | ||
| + | </pre> | ||
{{LuaSeeAlso}} | {{LuaSeeAlso}} | ||
| − | + | {{KeyboardMouse}} | |
| − | |||
Latest revision as of 23:55, 4 December 2025
| <> Function function isKeyPressed(Key) : Boolean |
Returns true if the specified key is currently pressed.
Function Parameters[edit]
| Parameter | Type | Description |
|---|---|---|
| Key | Integer or Virtual-Key Code | The virtual key code of the key to check (e.g., VK_F1, VK_SHIFT).
|
Returns[edit]
Boolean — true if the key is pressed, false otherwise.
Examples[edit]
if isKeyPressed(VK_SPACE) then
print("Spacebar is currently pressed!")
end
if isKeyPressed(VK_LSHIFT) then
print("Left Shift is pressed")
end
See also[edit]
| Lua |
| Script Engine |
Related Functions[edit]
| getMousePos |
| setMousePos |
| isKeyPressed |
| keyDown |
| keyUp |
| doKeyPress |
| mouse_event |
| setGlobalKeyPollInterval |
| setGlobalDelayBetweenHotkeyActivation |
