mouse Module

Read the current mouse position in screen coordinates.

The mouse module is exported from the system module.

import { mouse } from "system";

Table of Contents

• mouse.clientX()
  • Return Value
• mouse.clientY()
  • Return Value
• Example

mouse.clientX()

Returns the current cursor X coordinate.

Return Value

• Type: number
• Description: Cursor X position. Returns 0 if unavailable.

mouse.clientY()

Returns the current cursor Y coordinate.

Return Value

• Type: number
• Description: Cursor Y position. Returns 0 if unavailable.

Example

import { mouse } from "system";

const x = mouse.clientX();
const y = mouse.clientY();

console.log("Mouse:", x, y);