Class Cursor

Allows you to manipulate the platform cursor in various ways.

Note

Thread safe.

Index

Constructors

Accessors

isCursorHidden screenPosition

Methods

clearCursorIcon clipDisable clipToRectangle hide setCursor setCursorIcon show

Constructors

constructor

new Cursor(): Cursor
Returns Cursor

Accessors

`Static`isCursorHidden

get isCursorHidden(): boolean
Determines if the cursor is hidden.

Returns boolean

`Static`screenPosition

get screenPosition(): Immutable<Vector2>
Moves the cursor to the specified screen position.

Returns Immutable<Vector2>
set screenPosition(value): void
Parameters
- value: Immutable<Vector2>
Returns void

Methods

`Static`clearCursorIcon

clearCursorIcon(options): void
Removes a custom cursor icon and releases any data associated with it.
Parameters
- options: {
  name: string;
  } | {
  type: EnumValue<CursorType, number>;
  }
  Options object for the function call.
Returns void

`Static`clipDisable

clipDisable(): void
Disables cursor clipping that was set using any of the clipTo* methods.

Returns void

`Static`clipToRectangle

clipToRectangle(screenRect): void
Limit cursor movement to specific area on the screen.
Parameters
- screenRect: Immutable<Rect2>
Returns void

`Static`hide

hide(): void
Hides the cursor.

Returns void

`Static`setCursor

setCursor(options): void
Sets a cursor icon. Uses one of the built-in cursor types.
Parameters
- options: {
  type: EnumValue<CursorType, number>;
  } | {
  name: string;
  }
  Options object for the function call.
Returns void

`Static`setCursorIcon

setCursorIcon(options): void
Registers a new custom cursor icon you can then set by calling "setCursor".
Parameters
- options: {
      hotSpot: Immutable<Vector2>;
      name: string;
      pixelData: PixelData;
  } | {
      hotSpot: Immutable<Vector2>;
      pixelData: PixelData;
      type: EnumValue<CursorType, number>;
  }
  Options object for the function call.
Returns void
Note
Stores an internal copy of the pixel data. Clear it by calling removeCursorIcon(). If a custom icon with the same name already exists it will be replaced.

`Static`show

show(): void
Shows the cursor.

Returns void