ssCore.Mouse.lock

Restrict mouse movement to your application window.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

None.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Mouse.lock( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Mouse.lock( paramsObject );


Notes:

If you switch focus to another application (e.g. by using ALT+TAB) the mouse lock will be cancelled. The best way around this is to enable kiosk mode at the same time to prevent application switching.

Examples:

ssCore.Mouse.lock();