create-roblox-ts-script/template/assets/types/input.d.ts

CLI tool for creating Roblox scripts using TypeScript.

// https://github.com/unified-naming-convention/NamingStandard/tree/main/api/input

/**
 * Returns whether the game's window is in focus. Must be true for other input
 * functions to work.
 * @returns Window focus.
 */
declare function isrbxactive(): boolean;
/**
 * @alias isrbxactive
 * @hidden
 */
declare const isgameactive: typeof isrbxactive | undefined;

/**
 * Simulates a left mouse button click.
 */
declare function mouse1click(): void;

/**
 * Simulates a left mouse button press.
 */
declare function mouse1press(): void;

/**
 * Simulates a left mouse button release.
 */
declare function mouse1release(): void;

/**
 * Simulates a right mouse button click.
 */
declare function mouse2click(): void;

/**
 * Simulates a right mouse button press.
 */
declare function mouse2press(): void;

/**
 * Simulates a right mouse button release.
 */
declare function mouse2release(): void;

/**
 * Moves the mouse to the given coordinates.
 * @param x The x coordinate.
 * @param y The y coordinate.
 */
declare function mousemoveabs(x: number, y: number): void;

/**
 * Adjusts the mouse position by the given amount.
 * @param x The x offset.
 * @param y The y offset.
 */
declare function mousemoverel(x: number, y: number): void;

/**
 * Simulates a mouse scroll by `pixels`.
 */
declare function mousescroll(pixels: number): void;