Skip to content

Commit

Permalink
fix: remove lies about setCursor (#390)
Browse files Browse the repository at this point in the history
  • Loading branch information
lajbel authored Sep 5, 2024
1 parent e124928 commit af9f717
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2277,15 +2277,24 @@ export interface KAPLAYCtx<
*/
getGamepads(): KGamepad[];
/**
* Set cursor style (check Cursor type for possible values). Cursor will be reset to "default" every frame so use this in an per-frame action.
* Set cursor style.
*
* @since v3000.0
*
* @example
* ```js
* // Change between cursor styles
*
* // Reset cursor to default at start of every frame
* onUpdate(() => setCursor("default"));
*
* button.onHover((c) => {
* // change cursor to pointer when hovering over button
* setCursor("pointer")
* })
*
* // Hide the only cursor at start (useful for fakeMouse)
* setCursor("none");
* ```
*
* @group Info
Expand Down

0 comments on commit af9f717

Please sign in to comment.