Skip to content

GetModifierFlags.md

Latest commit

 

History

History
41 lines (33 loc) · 896 Bytes

GetModifierFlags.md

File metadata and controls

41 lines (33 loc) · 896 Bytes
Raw

GetModifierFlags

Description

Returns the state of option/alt, cmd/ctrl, shift keys.

PROCEDURE GetModifierFlags(
				VAR optionFlag : BOOLEAN;
				VAR cmdFlag    : BOOLEAN;
				VAR shiftFlag  : BOOLEAN);
def vs.GetModifierFlags():
    return (optionFlag, cmdFlag, shiftFlag)

Parameters

Name Type Description
optionFlag BOOLEAN The state of the option/alt key.
cmdFlag BOOLEAN The state of the cmd/ctrl key.
shiftFlag BOOLEAN The state of the shift key.

Examples

GetModifierFlags(TRUE, FALSE, TRUE);
import vs

# Returns the state of option/alt, cmd/ctrl, shift keys.
optionFlag, cmdFlag, shiftFlag = vs.GetModifierFlags()
vs.Message('GetModifierFlags returned: ' + str((optionFlag, cmdFlag, shiftFlag)))

Version

Availability: from Vectorworks 2025

Category