ssCore.Joystick.clearNotify

Disable notification for a previously enabled Joystick plugin event.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

event - The name or ID of the event you no longer want notifications for. Valid values include: onJoyMove,onJoyPOV,onJoySingleButton,onJoyAnyButton,onJoyButtonMask,onJoyCombo.

button - [Optional] - The joystick button id from a previous call to Joystick.setNotify for the onJoySingleButton event.

mask - [Optional] - A button mask from a previous call to Joystick.setNotify for the onJoyCombo event.


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.Joystick.clearNotify( 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.Joystick.clearNotify( paramsObject );


Notes:

See Joystick.setNotify for a description of the events.

                

Examples:

The following example clears a notification setup by ssCore.Joystick.setNotify.

ssCore.Joystick.clearNotify({event:"onJoyMove"});