Variable cursorConst

cursor: {
    isActive: boolean;
    activate(): void;
    deactivate(): void;
    subscribe(listener: (() => void)): (() => void);
} = ...

A cursor activation status controller.

Type declaration

  • isActive: boolean

    true if cursor interactions are enabled.

  • activate:function
    • Enables interactions with cursor.

      Returns void

  • deactivate:function
    • Disables interactions with cursor.

      Returns void

  • subscribe:function
    • Subscribes a listener to cursor activation status changes.

      Parameters

      • listener: (() => void)

        A listener to call when cursor activation status has changed.

          • (): void
          • Returns void

      Returns (() => void)

      A callback that unsubscribes a listener.

        • (): void
        • Returns void