WoW:API SetCursor: Difference between revisions

WoW:API SetCursor (source)

887 bytes added , 15 August 2023

m

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

Anonymous user

@@ Line 1: / Line 1: @@
-"cursor" can be one of these.
+{{wowapi}}
+Changes the current cursor graphic.
+ changed = SetCursor(cursor);
-ATTACK_ERROR_CURSOR
+==Arguments==
-BUY_ERROR_CURSOR
+;cursor: String - one of the following graphic descriptors:
-CAST_ERROR_CURSOR
+:* Path to a cursor graphic.
-POINT_ERROR_CURSOR
+:* "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").
-ATTACK_CURSOR
+:* Non-existent path; cursor is hidden.
-BUY_CURSOR
+:* nil; cursor is reset to default.
-CAST_CURSOR
-POINT_CURSOR
+== Returns ==
+;changed : 1 if cursor graphic is changed, nil otherwise.
+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; compressed BLP files will only work for software 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.