Scene Specific Messages
A module for foundryvtt that renders chat messages on a per-scene basis.
- Includes settings to flag OOC messages and whispers. Only messages that have been made with these settings enabled can be sorted, as OOC messages and whispers are not inherently marked with their originating scene.
- Includes a setting to mark and filter OOC messages. Note: this cannot retroactively filter OOC messages made without the setting to flag OOC messages on on). These settings are on by default, so if you have no wish to sort OOC messages or whispers in the future, please disable them to prevent unnecessary data from being added.
- Includes a setting to sort whispers in the same manner as above. Includes a functionality that allows you to mark new scenes with the old one's ID (without overwriting its actual ID) to let chat messages be sorted into that scene--see API for more.
API
game.modules.get("scenemessage").api.load() will bring up a dialog allowing you to load a number of chat messages of your choice (or the next 100 if you hit the 💯 button). This can be useful if your scene does not have enough messages sorted into it to allow scrolling, thus allowing you to access chat logs from older than the most recent 100 messages. Clientside, available to users. I considered adding sockets to allow the GM to do this for all users on the currently viewed scene, but because normal chat scroll is left to the user, I thought this should be as well.
game.modules.get("scenemessage").api.global() will set a flag that marks the currently viewed scene to show all chat messages. Useful if no scenes with ids that match messages exist, or whatever. Use it again to restore original module behavior. GM Only.
game.modules.get("scenemessage").api.inherit() will bring up a dialog allowing you to mark the currently viewed scene with an id. Messages that were created on a scene with a matching id will then appear in the scene that has inherited the id as if they were created in them (they will no longer appear in the original scene without a reload). This is not intended to allow messages to appear in two scenes at once: rather, this is intended to allow messages to carry over to a new scene should it need to be recreated or revisted after losing its original id. To facilitate this, please enabled "Allow Inherited Scene IDs" in the settings. GM Only. ※ Get your scene id by left clicking the compendium icon in the header when you open it with Configure. Keep track of your scene IDs if you plan to make use of this feature!
※ Execute these in the console (F12) or add them to 'script' type macros to execute.
System Specific Functions
This is a system agnostic module, but I am willing to add support for system specific messages that are not being correctly sorted, but should be. I mostly use foundry for dnd5e—users of other systems are free to make an issue asking for specific support (please provide necessary details). The current state of the module should cover most use cases, so please be specific in cases where it does not.
Known Limitations
Because foundry only loads the last 100 chat messages, scenes which have fewer than a scrollbar's worth of chat messages flagged to appear in them in the last 100 cannot scroll up, and because of that they cannot load any older messages. Please use the first API method to overcome this if needed: for best results, do not load more than you need, though loading large numbers may not be able to be avoided if you have a world with many messages.
ALPHA TESTING PERIOD
Please let me know if you encounter any issues (report them in Issues).
Technical Details
Scope: Compares currently viewed scene (game.scenes.viewed.id) with message.speaker.scene on chat messages, and adds the latter to the chat message's dataset (on render) for culling via display: none on scene change. If OOC sort is on, accomplishes the same by adding message.speaker.scene to the normally empty message.speaker object of OOC chat messages.
License: MIT License.
Additional Info: Thanks to mxzf for help with the css.