WoW:API SetCursor: Difference between revisions

← Older edit

WoW:API SetCursor (source)

Revision as of 04:47, 15 August 2023

479 bytes added , 15 August 2023

m

Move page script moved page API SetCursor to WoW:API SetCursor without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{wowapi}}
+Changes the current cursor graphic.
+ changed = SetCursor(cursor);
- SetCursor(cursor);
+==Arguments==
+;cursor: String - one of the following graphic descriptors:
+:* Path to a cursor graphic.
+:* "xx.blp", where xx is a filename in the Interface\CURSORS folder. For example, if you are trying to set the cursor to taxi.blp: SetCursor("taxi.blp"). You can also use a capitalized version of the filename: SetCursor("TAXI.BLP").
+:* Non-existent path; cursor is hidden.
+:* nil; cursor is reset to default.
-== Parameters ==
+== Returns ==
+;changed : 1 if cursor graphic is changed, nil otherwise.
-=== Arguments ===
-;cursor: String - Can be one of these:
-:* "ATTACK_CURSOR"
-:* "ATTACK_ERROR_CURSOR"
-:* "BUY_CURSOR"
-:* "BUY_ERROR_CURSOR"
-:* "CAST_CURSOR"
-:* "CAST_ERROR_CURSOR"
-:* "POINT_CURSOR"
-:* "POINT_ERROR_CURSOR"
-:* nil - resets cursor
-:* A path to a 32x32 cursor graphic
+NOTE: after 3.1, this returns true every time regardless of what the graphic was previously and what you tried to change it to.
 == Details ==
 * The option to pass ''nil'' was added in 1.11.
-* For custom textures: The graphic must be an UNCOMPRESSED BLP file
+* For custom textures: The graphic must be an UNCOMPRESSED BLP file; compressed BLP files will only work for software cursors.
-* For custom textures: Compressed BLP files will work for software, but not hardware cursors.
+* 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.