util.input.is_pressed

Syntax

local result = util.input.is_pressed(
    key
)

Parameters

Type	Name	Description
`util.input.key`	key	Key or button to query

Returns

Type	Name	Description
`bool`	result	`true` if the key or button is currently held down, `false` otherwise

Examples

Check if the W key is held

if util.input.is_pressed(util.input.key.W) then
    core.engine.print("info", "W is held")
end

Check if the left mouse button is held

if util.input.is_pressed(util.input.key.MOUSE_LEFT) then
    core.engine.print("info", "Left mouse button is held")
end

Check multiple keys for a sprint condition

local moving = util.input.is_pressed(util.input.key.W)
local sprinting = moving and util.input.is_pressed(util.input.key.SHIFT)

core.engine.print("info", "Sprinting:", sprinting)

Syntax

Parameters

Returns

Examples

On this page