MATT Trigger Methods - ironmonk88/monks-module-wiki GitHub Wiki
Trigger Methods
You can select multiple trigger methods on one tile; to have different sets of actions run based on what method was used to trigger the tile, see auto-landings.
If a tile has multiple trigger methods, any that have their requirements met will occur; this can result in double triggers. This is mainly an issue when a tile has both enter
and stop within tile
, or exit
and movement
at the same time. Pick one or the other, or use auto-landings.
Enter
This triggers when a token enters the tile.
$\color{yellow}{\textsf{Important}}$: This does NOT include the triggering token when used with "Tokens Within Tile" as your first action's target unless you add a small delay before the first action. The token is entering, the tile triggers, and it hasn't fully finished entering yet without the delay.
$\color{yellow}{\textsf{Important}}$: This trigger doesn't work if the token's endpoint is adjacent to the edge of the scene canvas. The easiest fix is just leave scene padding on and don't put tiles near the edge of the scene.
Exit
This triggers when a token exits the tile.
Movement
This is triggered by a token starting their movement from within the tile.
Stop Within Tile
This is triggered when a token stops within a tile.
Elevation Change
This will trigger when a token within the tile changes elevation.
Rotation
This will trigger when a token within the tile is rotated.
Clicks
You can use single-click or double-click on a tile, but not together. Using both with auto-landings will result in the double-click not triggering and just triggering the click twice.
None of the various click triggers can be triggered by clicking a tile beneath a token; clicking the token takes priority.
Click
The tile is triggered from a user clicking within the tile.
Right-Click
The tile is triggered from a user right-clicking within the tile.
This includes when right-clicking when trying to pan the canvas around.
Don't set up a right-click trigger tile that deletes your entire combat encounter and just put it in the middle of the map like someone I know. -Crow
Double-Click
The tile is triggered from a user double-clicking within the tile.
Double Right-Click
The tile is triggered from a user double right-clicking within the tile.
Token Create
The tile is triggered whenever a token is created within the tile.
$\color{yellow}{\textsf{Important}}$: This trigger method doesn't respect the game paused settings, and can be triggered regardless of whether its allowed.
$\color{red}{\textsf{Warning}}$: I personally recommend against having this trigger on any tile that creates tokens. See infinite loops. If your loop results in an instantaneous Foundry crash and bloats your world with token data, you may be in trouble.
Hover In
Any mouse-over entering triggers the tile.
Hover Out
Any mouse-over exiting triggers the tile.
Combat Start
Combat starting on the scene triggers the tile.
Combat Round
This triggers the tile every time a new combat round starts.
Combat Turn Start
This triggers the tile every time a new turn starts during a combat encounter.
Combat Turn End
This triggers the tile every time a turn ends during a combat encounter.
Combat End
This triggers a tile after combat is ended.
Scene Change
Runs the tile actions when the scene is loaded by a player. If the scene is activated, it will trigger for each player loading in without any extra filtering.
$\color{red}{\textsf{Warning}}$: I personally recommend against having this trigger on any tile that runs an infinite loop. If your loop results in an instantaneous Foundry crash, you may be in trouble.
Manually Activate
This can be triggered in several ways. Technically it's just a trigger method with no hook event; it can still have other trigger methods as well. It's recommended to use this if you just need it to be triggered by one of the following:
- By right-clicking the tile and clicking the button that looks like a power button.
- Via another tile's Trigger Tile action.
- Via a door trigger.
- Via a journal trigger.
- Via a macro trigger.
- Via a scene region.
Door Trigger
This one is specifically used with the Tiles Under Door
targeting option of door triggers.
Lighting Change
This triggers whenever the scene's global lighting value changes.
$\color{Yellow}{\textsf{Important}}$: This will trigger for each player logged in; use a user restriction or Redirect Based on Player Type to limit it.
Time Change
This triggers whenever the world's time clock changes. You will likely need a separate module to adjust this, unless you're on PF2E, which has the world clock integrated.
Page Last Updated
- Foundry 12.327
- MATT 12.01