API:ClearCursor

UI Lua API · Interface functions
Version: WAR 1.4.8

Sets the mouse pointer back to the normal arrow.

ClearCursor()

Arguments

None.

Returns

Nothing.

Details

• Only the shape of the Windows mouse pointer is changed. Nothing that the UI keeps on the cursor (such as Cursor.Data for a picked-up item) is touched; the stock Cursor code clears that itself before calling ClearCursor.
• If the pointer is already the arrow, nothing happens.
• Arguments are not checked; anything passed is ignored.

Errors

None.

Example

From default/ea_cursor/source/cursor.lua:

Cursor.Data = nil
Cursor.PendingData = nil
Cursor.ClearTargetingData()
ClearCursor()