gui.isKeyboardModifierPressed

Checks the status of the common keyboard modifier keys.

Prototype

  1. bPressed = gui.isKeyboardModifierPressed ( kKeyboardModifier )

Description

Check the gui.kKeyboard* constants for more info.

Parameters

kKeyboardModifier -

Return values

bPressed - true if pressed

Sample

  1. -- check if  CTRL is pressed
  2. if ( gui.isKeyboardModifierPressed ( gui.kKeyboardControlModifier ) ) then
  3.     -- do stuff
  4. else
  5.     -- do something else
  6. end

Available since ShiVa 2.0