src code

instance method Screen#useNativeCursor

Screen#useNativeCursor(cursor) → undefined
  • cursor (String | false)

Changes the mouse icon to one of the specified cursor values. These values correspond to the system native cursors, and those icons will be used.

The allowed cursor values are:

  • default: The default system mouse pointer.

  • hand: A hand that has an index finger pointing to the hot spot.

  • crosshair: A crosshair symbol, or + sign. Could be useful as a gun shoot point.

  • move: Makes arrows point in all directions. Maybe if something is draggable in your UI.

  • text: Makes it look like an element can be typed inside of.

  • wait: A busy icon. Useful for loading script files or other dependencies.

  • none or false: Invisible mouse cursor. Note that all mouse movement and button click event will still be fired. This is very useful if your game doesn't use the mouse, or if your game uses a custom mouse cursor (possibly via a Sprite).