Implement intransient plugins

[IntelOrca]

Add initial functionality for intransient plugins. Intransient plugins are a new type of plugin that will start when OpenRCT2 launches, and remain loaded until shutdown. This provides plugins with the ability to hook map change and provide functionality on other screens such as the title menu.

Example:

registerPlugin({
    type: 'intransient',
   ...
});

The title sequence editor will be an intransient plugin so that it can be used from the title screen like the built in one.

Three new APIs have been introduced alongside this.

• context.mode
• context.subscribe('map.change', callback)
• ui.registerToolboxMenuItem(text, callback)

First two commits are other PRs, will rebase when they are merged.

Modified title editor plugin for testing:
title-editor.zip

[tupaschoal]

It got me thinking whether we should still have two types of scripts, but with different execution policies. Intransient seems to be a different characteristic than the other two, so maybe it should be something like: Transient or Intransient, Local or Remote?

Not sure it makes sense, but something was bothering me here :P

[IntelOrca]

@tupaschoal the problem is that I don't think I want to allow an "intransient + remote" script. Remote scripts need to be sent to the clients when they connect, so they could only ever be intransient for the server, and it I think it simplifies things if it is consistent. Remote intransient scripts would also have to be unloaded when a client connects to a sever.

If the two characteristics were split, then it would need to error if you specify both intransient and remote.

[tupaschoal]

@tupaschoal the problem is that I don't think I want to allow an "intransient + remote" script. Remote scripts need to be sent to the clients when they connect, so they could only ever be intransient for the server, and it I think it simplifies things if it is consistent. Remote intransient scripts would also have to be unloaded when a client connects to a sever.

If the two characteristics were split, then it would need to error if you specify both intransient and remote.

Ok, just wanted to see whether you had considered it, but I'm alright with this direction.

[Broxzier]

Tested by messing around with a dummy script and everything works as expected.

registerPlugin({
    name: 'My Test Plugin',
    version: '1.0',
    authors: ['Broxzier'],
    type: 'intransient',
    licence: 'MIT',
    targetApiVersion: 34,
    main: function() {
        context.subscribe('map.changed', function() {
            console.log("The newly loaded park is: " + park.name);
        });

        var callback = function() {
            console.log("beep");
            map.getAllEntities("car").forEach(function(car) {car.mass /= 2; car.poweredAcceleration=1000;});
        };
        ui.registerToolboxMenuItem("New button", callback);
        ui.registerToolboxMenuItem("Another button but it does the same", callback);

        console.log("My Test plugin is initialized!");
    }
});

My only remark is that an additional 'map.beforeChange' hook (or 'preChange' or whatever a good name may be) might be useful for plug-ins that want to do something right before the map gets changed.