Enhancement: Roof Layer Interactions with FXMaster Layer

[Dumbhuman]

First off, thank you so much for this Roofs module! I love that it also allows you to use the opacity controls to reveal or not reveal roofs independent of PCs entering/exiting their area and to easily send things back to the tile layer.

I don't know how many people will use both modules, but currently the Roof layer seems to be below the layer used for FXMaster, which could be a bit problematic if using them together.

It would be very nice to have weather effects on top of roof tiles, but I can also think of situations where it would be nice to exclude tiles from the FXMaster layer so ideally it would be an individualized option. Maybe having the roof layer render under FXMaster and adding a "cloud" layer that renders above it?

Even more amazing would be if each individual tile could also have the option to mask the FXMaster layer when the roof is set to the tile layer. So, for example, rain would show over top of a tavern roof, but when the characters enter and the roof is hidden away, the rain no longer falls on that tile, showing just a dry tavern interior. I know that masking might be a bit beyond the scope of this module, but I thought I'd throw it out there as a crazy idea anyway.

[VanceCole]

Thank you for the report.

Roofs renders to a layer directly above tokens, smartly inserting itself at whatever index this happens to be regardless of whether other modules have adjusted the default layer stack.

Unfortunately, FX Master is not so smart and simply inserts itself at index 8, which in a default install would be above the lighting layer and therefore should be above roofs, however in cases where roofs performs its insertion first FXMaster will not account for the layer being added previously and insert itself at the wrong index such that it places itself below roofs.

Ideally FXMaster should fix this on their end as it is a flaw that could also be caused and/or made even worse by any other module inserting layers, so I will send a PR to address the issue, but if they are not open to fixing it themselves I can probably patch it from my module so the two play nicely together.

Regarding the functionality of hiding the effects when the roof is in "interior" state, that is a functionality that I plan to address with my forthcoming "Zones" module, which amongst other things will allow you to mask areas where layers such as global illumination or effects do not apply, f.x. interiors. Roofs will implement automatic functionality to communicate with zones and enable this automatically for roofed areas if both modules are present.

[Dumbhuman]

I should've mentioned that I did my testing with only Roofs and FXMaster (and Tidy UI Settings) enabled, but it sounds like you already have plenty of good ideas for getting things to play even more nicely.

Zones looks very ambitious so I'll be patiently awaiting its unveiling at some point in the future.

[Gedfort]

Also a big thank you from here! I'm also dealing with this, and I can see why it should be the FXMaster guys fixing it, but if they don't and it's not too much, I'd be really grateful for a patch (I think a lot of people will), and I'm also greatly looking forward to your Zones module, both that and roofs are simply features I don't see why anyone would not want and should be part of the core. :) Happy New Years from Denmark and keep up the good work!