6. Tools & API

Cinematic Cut-ins provides powerful tools to look "under the hood" of your chat messages and a robust API for programmatic control.

🔍 Cinematic Analysis Tool (Debugger)

Are you trying to set up a specific Dice Check or Keyword Trigger, but it just won't fire? The Cinematic Analysis tool is designed to solve exactly this problem.

How to Use

Locate a Message: Find the chat message (attack roll, item card, etc.) you want to analyze in the Chat Log.
Right-Click: Right-click on the message to open the context menu.
Select Analysis: Click the "Cinematic Analysis" option (Magifying Glass Icon 🔍).

Understanding the Report

A dialog will appear with three sections:

Actor Detection:
- Confirm which Actor the module thinks "owns" this message.
- Troubleshooting: If this shows "Failed," the module cannot trigger an effect because it doesn't know who rolled the dice. Ensure a token is selected or the user character is assigned.
Keyword Analysis:
- Shows the "Clean Content" of the message. This is the exact text string the module checks against your Keyword triggers.
Dice Analysis:
- Crucial for "Dice Check" Triggers.
- It breaks down every roll in the message, showing the Index (0, 1, 2...), the Formula, the Total, and the individual Die Results.
- Example: You want to trigger on a d20 roll of 20. The analysis confirms if the roll is at Index 0 or 1 (common in systems like D&D 5e with dual rolls).

⚡ The Macro API

You can trigger cut-ins programmatically using the module's API. This allows you to integrate cut-ins into macros, script triggers, or other systems like Tile Triggers or Monk's Active Tile Triggers.

Accessing the API

The API is exposed globally at:

game.modules.get("cinematic-cut-ins").api