Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Cursor.SetCursor(Texture2D,CursorMode)

Description

Change the mouse cursor to the set texture OnMouseEnter.

Reset the cursor to default OnMouseExit.

	var cursorTexture : Texture2D;
	var cursorMode : CursorMode = CursorMode.Auto;
	var hotSpot : Vector2 = Vector2.zero;

function OnMouseEnter () { Cursor.SetCursor(cursorTexture, hotSpot, cursorMode); }

function OnMouseExit () { Cursor.SetCursor(null, Vector2.zero, cursorMode); }

static function SetCursor(texture: Texture2D, hotspot: Vector2, cursorMode: CursorMode): void;
static void SetCursor(Texture2D texture, Vector2 hotspot, CursorMode cursorMode);
static def SetCursor(texture as Texture2D, hotspot as Vector2, cursorMode as CursorMode) as void

Parameters

textureThe texture to use for the cursor.
hotspotThe offset from the top left of the texture to use as the target point (must be within the bounds of the cursor).
cursorModeAllow this cursor to render as a hardware cursor on supported platforms, or force software cursor.

Description

Specify a custom cursor that you wish to use as a cursor.