// It is recommended to bind these to the last engine to avoid contention with other
// scripts still executing. S+ starts with the first engine, then works toward the
// last, so using the last engine increases the chances that it is not currently
// executing - though it is still possible. 

// If the last engine is executing while synchronous events are being used 
// S+ may hang, Windows will evict the Mouse/Keyboard hook, and S+ will need to 
// be restarted. This is only recommended for advanced users.

// Only bind this event in the last script engine by name
if(__spEngineWrapper.Engine.Name == sp.EngineList().Last().Engine.Name)
{
    var keyboardEventObj = sp.GetStoredObject("keyboardEvent");
    if(!keyboardEventObj.GetType().FullName.includes('EventConnection'))
    {
        //Bind to the synchronous event
        var keyboardEvent = KeyboardHook.OnKeyboardHookEvent.connect(
            function (sender, keyboardHookEvent) {
                //Wrap all code in try/catch, exceptions will crash S+, such as calling clip.SetText with a null value
                try
                {
                    if(keyboardHookEvent.Key == vk.VK_Z)
                    {
                        if(keyboardHookEvent.KeyState == KeyState.Up)
                        {
                            sp.MessageBox("Z key release\n\n _spEngineName: " + __spEngineWrapper.Engine.Name, "ZU");
                        }
                        //Consume the event, so Windows/apps do not see the keypress
                        keyboardHookEvent.Consume = true;
                    }
                }
                catch {}
            });
        sp.StoreObject("keyboardEvent", keyboardEvent);
    }
}

__spEngineWrapper.Engine [V8ScriptEngine - see https://microsoft.github.io/ClearScript/Reference/html/T_Microsoft_ClearScript_V8_V8ScriptEngine.htm]https://microsoft.github.io/ClearScript/Reference/html/T_Microsoft_ClearScript_V8_V8ScriptEngine.htm]
__spEngineWrapper.IsExecuting [bool - note, is not true during event execution]
__spEngineWrapper.Execute([string])
__spEngineWrapper.Interrupt()

//This toggles on and off an asynchronous keyboard hook event subscription
//If event already bound, disconnect
var keyboardEventObj = sp.GetStoredObject("keyboardEvent");
if(keyboardEventObj.GetType().FullName.includes('EventConnection'))
{
    keyboardEventObj.disconnect();
    sp.DeleteStoredObject("keyboardEvent");
} 
else
{
    //Otherwise, create the event binding
    var keyboardEvent = KeyboardHook.OnKeyboardHookEventAsync.connect(
        function (sender, keyboardHookEvent) {
            //Wrap all code in try/catch, exceptions will crash S+, such as calling clip.SetText with a null value
            try
            {
                if(keyboardHookEvent.Key == vk.VK_Z && keyboardHookEvent.KeyState == KeyState.Up)
                {
                    sp.MessageBox("Z up", "ZU");
                }
            }
            catch {}
        });
    //Note that on S+ reload, events in Stored Object list have disconnect called on them
    sp.StoreObject("keyboardEvent", keyboardEvent);
}

//This toggles on and off a synchronous mouse button hook event subscription
//If event already bound, disconnect
var mouseButtonEventObj = sp.GetStoredObject("mouseButtonEvent");
if(mouseButtonEventObj.GetType().FullName.includes('EventConnection'))
{
    mouseButtonEventObj.disconnect();
    sp.DeleteStoredObject("mouseButtonEvent");
} 
else
{
    //Otherwise, create the event binding
    //bind to synchronous event
    var mouseButtonEvent = MouseHook.OnMouseHookButtonEvent.connect(
        function (sender, mouseHookEvent) {
            //Wrap all code in try/catch, exceptions will crash S+, such as calling clip.SetText with a null value
            try
            {
                if(mouseHookEvent.Button == MouseButtons.Middle))
                {
                    //Consume all middle click events
                    mouseHookEvent.Consume = true;
                }
                else if(mouseHookEvent.Button == MouseButtons.Left && mouseHookEvent.ButtonState == ButtonState.Up)
                {
                    //Do something when the left mouse button is released, but don't consume
                }
            }
            catch{}
        });
    //Note that on S+ reload, events in Stored Object list have disconnect called on them
    sp.StoreObject("mouseButtonEvent", mouseButtonEvent);
}

//This toggles on and off an asynchronous mouse button hook event subscription
//If event already bound, disconnect
var mouseMoveEventObj = sp.GetStoredObject("mouseMoveEvent");
if(mouseMoveEventObj.GetType().FullName.includes('EventConnection'))
{
    mouseMoveEventObj.disconnect();
    sp.DeleteStoredObject("mouseMoveEvent");
} 
else
{
    //Otherwise, create the async event binding
    var mouseMoveEvent = MouseHook.OnMouseHookMoveEventAsync.connect(
        function (sender, mouseHookEvent) {
            //Wrap all code in try/catch, exceptions will crash S+, such as calling clip.SetText with a null value
            try
            {
                if(mouseHookEvent.Button == MouseButtons.Left && mouseHookEvent.ButtonState == ButtonState.Down)
                {
                    //Do something when mouse move is happening and left button is down
                }
                else
                {
                    //Do something otherwise, just a mouse movement or other button combinations
                }
            }
            catch {}
        });
    //Note that on S+ reload, events in Stored Object list have disconnect called on them
    sp.StoreObject("mouseMoveEvent", mouseMoveEvent);
}