We use cookies on this site to enhance your user experience
Collapse Sidebar


This function sets the state of the calling plugin to activated. Activating the plugin allows mouse control through the Plugin/GetMouse method.

At any given time there are either 0 or 1 Activated Plugins. Activating a plugin will deactivate all other plugins (they will receive a Plugin/Deactivation event).

See also

  • Plugin/IsActivatedWithExclusiveMouse, returns true if this plugin is currently active with an exclusive mouse, after having been activated via this function
  • Plugin/Unloading, fires immediately before the plugin is unloaded or reloaded via uninstallation, deactivation, or updating


Name Type Default Description

A boolean specifying whether to activate the plugin with exclusive mouse. If true, a PluginMouse can be retrieved via Plugin/GetMouse


Return Type Summary

No return