API SetCursor

Main Menu
WoW API Widget API Macro API Lua functions Events Widget handlers XML UI Changes HOWTOs Snippets UI tech. Category nav.

→ WoW API

Changes the current cursor graphic.

changed = SetCursor("cursor")

Arguments

cursor

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

Returns

changed 

Flag - always 1.

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.
• If called with an invalid argument, the cursor is replaced by a black square.

Patch history

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