SetCursor

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Blizzard Docs  Townlong Yak  Offline /api  Wowprogramming  GitHub Search
Info
Added in 1.0.0 / 1.13.2

Sets the current cursor texture.

changed = SetCursor(cursor)

Arguments

cursor

string|nil - cursor to switch to; either a built-in cursor identifier (like "ATTACK_CURSOR"), path to a cursor texture (e.g. "Interface/Cursor/Taxi"), or explicitly nil to reset to a default cursor.

Returns

changed

boolean? - Seems to return false when the given cursor string argument was different from the previous one, otherwise returns true.

Details

• If the cursor is hovering over WorldFrame, the SetCursor function will have no effect - cursor is locked to reflect what the player is currently pointing at.
• Texture paths may be suffixed by ".crosshair" to offset the position of the texture such that it will be centered on the cursor.
• If called with an invalid argument, the cursor is replaced by a black square.

Patch changes

Patch 3.1.0 (2009-04-14): Now always returns 1.
Patch 1.11.0 (2006-06-19): Now accepts a nil argument to reset to default cursor.