(revision) |
Blamdarot6678@legacy41527957 (talk | contribs) m (→Arguments) |
||
Line 6: | Line 6: | ||
;cursor: String - one of the following graphic descriptors: |
;cursor: String - one of the following graphic descriptors: |
||
:* Path to a cursor graphic. |
:* Path to a cursor graphic. |
||
− | :* " |
+ | :* "XX", where XX is a capitalized version of a filename in the Interface\CURSORS folder. For example, if you are trying to set the cursor to taxi.blp: SetCursor("TAXI.BLP") |
:* Non-existent path; cursor is hidden. |
:* Non-existent path; cursor is hidden. |
||
:* nil; cursor is reset to default. |
:* nil; cursor is reset to default. |
Revision as of 14:32, 16 August 2009
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Changes the current cursor graphic.
changed = SetCursor(cursor);
Arguments
- cursor
- String - one of the following graphic descriptors:
- Path to a cursor graphic.
- "XX", where XX is a capitalized version of a filename in the Interface\CURSORS folder. For example, if you are trying to set the cursor to taxi.blp: 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.
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.