event.isCommandDown

Type Boolean
Event mouse
Revision Current Public Release (2018.3326)
Keywords mouse, isCommandDown

Overview

Indicates if the command or Windows button was held down at the time the mouse event occurred.

Example

-- Called when a mouse event has been received.
local function onMouseEvent( event )
    if event.isCommandDown then
        -- The command/Windows button is currently pressed down.
    else
        -- The command/Windows button is not being pressed.
    end
end
                             
-- Add the mouse event listener.
Runtime:addEventListener( "mouse", onMouseEvent )