Editor Scripting API
    Preparing search index...

    Class MouseEvent

    Event object containing mouse interaction data.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    button buttons globalX globalY modifiers x y

    Methods

    accept getTypeName ignore isOfType isSame

    Constructors

    Properties

    button: MouseButton

    The specific mouse button that triggered the event

    buttons: MouseButton

    All mouse buttons currently pressed (flags)

    globalX: number

    The x-coordinate of the mouse position relative to the widget

    globalY: number

    The y-coordinate of the mouse position relative to the widget

    modifiers: KeyboardModifier

    The keyboard modifiers pressed during the mouse event (Shift, Ctrl, Alt, etc.).

    x: number

    The absolute x-coordinate of the mouse position on screen

    y: number

    The absolute y-coordinate of the mouse position on screen

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object refers to the same instance as the given object.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods