https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASetHardwareCursorAPI:SetHardwareCursor - Revision history2026-10-17T12:05:24ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SetHardwareCursor&diff=30722&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:49:04Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Interface}}<br />
Switches the mouse pointer to one of the client's built-in cursor shapes.<br />
<br />
<pre><br />
SetHardwareCursor(cursorId)<br />
</pre><br />
<br />
== Arguments ==<br />
;cursorId : <code>number</code> – Cursor number, 0 to 21. Use the <code>SystemData.Cursor</code> values. Fractions are dropped.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The client loads the cursor image for that number from its own resources (some numbers are animated cursors) and makes it the Windows mouse pointer of the game window.<br />
* 0 is the normal arrow.<br />
* Numbers outside 0–21 are ignored without an error.<br />
* If the pointer already has the requested number, the shape is not reloaded.<br />
* 15 has no cursor image in the client: the pointer is set to no image.<br />
* The stock UI uses it to show the resize cursor while a window is being resized; [[API:ClearCursor|ClearCursor]] sets the arrow back.<br />
* The function needs at least one argument and only reads the last one.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>WindowUtils.BeginResize</code> in <code>easystem_windowutils/source/windowutils.lua</code>:<br />
<pre><br />
WindowUtils.resizeEndCallback = endCallback<br />
SetHardwareCursor(SystemData.Cursor.RESIZE2)<br />
</pre><br />
<br />
== See also ==<br />
* [[API:ClearCursor|ClearCursor]]<br />
* [[API:SetCursor|SetCursor]]</div>Maintenance script