Add a way for javascript to call back to the overlay plugin.

[danakj]

This adds an overlayMessage() function to the OverlayPluginApi object,
which will call a virtual OverlayMessage() function on OverlayBase.
Plugins can override it and parse the string to do whatever they wish,
such as Text-to-Speech for example.

The sendMessage() function takes 2 arguments, which are the |name| of
the overlay plugin to send it to, and the |message| string to send.
overlayMessage() takes the same 2 arguments.

In order to send the overlayMessage() to the same plugin which is
running the javascript, the name of the plugin needs to be known,
but it is user defined. So we also add an |overlayName| readonly
string to the OverlayPluginApi object, that has the name of the
overlay plugin. Then the javascript may do the following to send
a string to its c# plugin:

OverlayPluginApi.overlayMessage(OverlayPluginApi.overlayName, 'hello');

[danakj]

Hello! I'm working to add text-to-speech in cactbot (https://github.com/quisquous/cactbot/) but we need a way to get a message from JS to C#. The sendMessage() function almost works but has 2 problems:

1. The function in OverlayBase is not virtual, so we can't override it, and it's meant for sending the message back to javascript anyhow.
2. The name of the plugin isn't known in js to sendMessage() to it.

This should solve both of those, with a new function to not make sendMessage do different things for different plugins - whereas overlayMessage() will do something specific to that overlay plugin.

Thanks!

[ezsoftware]

I'm curious, what events are being handled in the client side (javascript inside chromium) that the server side (ACT plugin) isn't aware of that requires the client side to send a request back to the server-side code to process for TTS?

From my quick review of your pull request, I don't see any issues with the implementation, I'm just curious about how the need for it arose.

Also, is there any problem with me including Cactpot as part of the installer bundle with OverlayPlugin, OverlayPlugin-Themes, and Enmity addon?

[danakj]

The JS processes log events, and has complex logic that we don't want to express in the c# plugin. It decides to show things on screen, play sounds, or in this case read text-to-speech. You can have a look at the cactbot readme (the link above) to see more about the built-in UIs it provides.

Also, is there any problem with me including Cactpot as part of the installer bundle with OverlayPlugin, OverlayPlugin-Themes, and Enmity addon?

There's no problem IMO, it'd be exciting to see it in more hands. We've been gearing up to the point of getting it out to more people and we feel it's in pretty good shape (the TTS will really help for people who expect that from other ACT interactions tho). But pls spell it "Cactbot" :)

[quisquous]

I'm curious, what events are being handled in the client side (javascript inside chromium) that the server side (ACT plugin) isn't aware of

Largely, this is for expressing more complicated triggers, e.g. https://github.com/quisquous/cactbot/blob/master/ui/raidboss/data/triggers/susano-ex.js#L60. Other plugins like triggernometry or the built in custom triggers in ACT do this all in C#, but cactbot does it in javascript.

Also, is there any problem with me including Cactpot as part of the installer bundle with OverlayPlugin, OverlayPlugin-Themes, and Enmity addon?

I'd be excited to see cactbot included with the OverlayPlugin bundle too, as long as there's a link to https://github.com/quisquous/cactbot/ somewhere in the installer bundle documentation so users know how to set up cactbot.

The only downside I can think of is that it could make distribution a little bit more awkward for the bundle. It means that the cactbot that comes with the bundle might be outdated (or might not even work properly with the latest ffxiv plugin). I don't want to force the bundle to have to release just because cactbot does. cactbot does have a version check though and will tell users to go update, so maybe that's good enough?

[hibiyasleep]

This will be included in 0.3.4.0, thanks for great work!

[danakj]

Thanks :D

[ezsoftware]

@quisquous

Its not a problem, I already do it for enmity plugin (and to a lesser extent themes as well, though themes generally doesn't have any breaking changes between non-expansion updates) and I try to streamline my custom build scripts to automate the process as much as possible.

The enmity plugin has the update notices too, so I think that will work well. People who don't want to wait for me to update the bundle can grab the updates manually, otherwise they can wait for the bundle, so it shouldn't be too big of an issue.

I'll work on getting it integrated this weekend.

[danakj]

@hibiyasleep Do you have any plans about when 0.3.4.0 will be happening? We're excited to give people TTS :)

[hibiyasleep]

I'm currently on travel. I'll release within 3-4 days, sorry for much delay :(

[danakj]

Oh no problem, thanks! That's really great news.

[hibiyasleep]

@danakj @ezsoftware now released, sorry I'm too late (._.

[danakj]

Thanks very much :)