ssEvents.killEvent

Method to stop receiving notifications for events without specifying a particular listener.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

event - String - The name of the event for which you want to stop receiving notifications. All listeners to this event are affected. Valid values include: App.onData, App.onDesktopChange, App.onDeviceChange, App.onDialog, App.onDragDrop, App.onExitWindows, App.onOtherInstance, App.onQuit, App.onSysColorChange, App.onWindow, Browser.onActiveElementChange, Browser.onBlockedPopup, Browser.onBlockedURL, Browser.onDocumentComplete, Browser.onMouseButton, Browser.onNavigate, Browser.onPreview, Browser.onProgress, Browser.onStatus, Browser.onTitle, Browser.onWindowClosing, FTP.onProgress, FileSys.onCopyProgress, HTTP.onProgress, Joystick.onJoyAnyButton, Joystick.onJoyButtonMask, Joystick.onJoyCombo, Joystick.onJoyMove, Joystick.onJoyPOV, Joystick.onJoySingleButton, Keyboard.onHotKey, Keyboard.onKey, MIDI.onRawData, Mouse.onMouseButton, Mouse.onMouseMove, Mouse.onMouseWheel, Popup.onContextMenu, Popup.onTrayMenu, Printer.onComplete, Shell.onShellExecuteFeedback, Splash.onFSCommand, TCP.onConnect, TCP.onDisconnect, TCP.onReceive, TCP.onReceiveError, TCP.onSendError, Tray.onTrayClick, Tray.onTrayDoubleClick, Tray.onTrayHover, UDP.onReceive, UDP.onReceiveBinary, UDP.onReceiveError, WMAudio.onComplete, WMAudio.onError, WMAudio.onIndex, WMAudio.onProgress, WMAudio.onScriptCommand, WMAudio.onStart, WMVideo.onComplete, WMVideo.onError, WMVideo.onIndex, WMVideo.onProgress, WMVideo.onScriptCommand, WMVideo.onStart, Win.onDrag, Win.onFocusChange, Win.onMove, Win.onResize, and Win.onStateChange.


Output Parameters:

No output parameters.


Notes:

Use this method to stop SWF Studio from returning data for the event. This also clears the listener list, so if you had listener objects listening to this event, they will no longer be in the listeners list, and will need to be added again using ssEvents.addEventListener.


Examples:

Example 1:
Here we want to stop a particular event from being triggered. This will remove any listeners and clear the notification for the specified event.

ssEvents.killEvent({event:'App.onDragDrop'});