Show / Hide Table of Contents

Method mouse.waitForCursor(+ 1 overload)


Overload

Waits for a standard mouse cursor (pointer) visible.

public static bool waitForCursor(Seconds timeout, MCursor cursor, bool not = false)
Parameters
timeout  (Seconds)

Timeout, seconds. Can be 0 (infinite), >0 (exception) or <0 (no exception). More info: Wait timeout.

cursor  (MCursor)

Id of a standard cursor.

not  (bool)

Wait until this cursor disappears.

Returns
bool

Returns true. On timeout returns false if timeout is negative; else exception.

Exceptions
TimeoutException

timeout time has expired (if > 0).


Overload(top)

Waits for a nonstandard mouse cursor (pointer) visible.

public static bool waitForCursor(Seconds timeout, long cursorHash, bool not = false)
Parameters
timeout  (Seconds)

Timeout, seconds. Can be 0 (infinite), >0 (exception) or <0 (no exception). More info: Wait timeout.

cursorHash  (long)

Cursor hash, as returned by MouseCursor.Hash.

not  (bool)

Wait until this cursor disappears.

Returns
bool

Returns true. On timeout returns false if timeout is negative; else exception.

Exceptions
TimeoutException

timeout time has expired (if > 0).