WoW:API SetCursor: Difference between revisions
Jump to navigation
Jump to search
(Just added settings, didn't format the page propperly.) |
m (Move page script moved page API SetCursor to API SetCursor without leaving a redirect) |
||
| (7 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} | |||
Changes the current cursor graphic. | |||
changed = 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. | |||
== 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. | |||
Latest revision as of 04:47, 15 August 2023
Changes the current cursor graphic.
changed = 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.
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.