Lens Scripting API
    Preparing search index...

    Class KeyPressEvent

    This event is triggered when the user presses a key.

    function onKeyPress(eventData)
    {
        var key = eventData.key;
    }

    var event = script.createEvent("KeyPressedEvent");
    event.bind(onKeyPress);

    Hierarchy (View Summary)

    Index

    Properties

    enabled key modifiers

    Methods

    bind getSceneObject getTypeName isOfType isSame

    Properties

    enabled: boolean

    If true, the event is able to trigger. If false, the event will not trigger.

    key: Keys

    Returns the key code of the pressed key.

    modifiers: KeyModifiers[]

    Returns the modifier keys active when the key was pressed as a set of enums.

    Methods

    • Binds a callback function to this event.

      Parameters

      • evCallback: (arg1: this) => void

      Returns void

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods