Run a macro
execute-macroRun a Foundry VTT macro in the Gamemaster's browser and retrieve its result or error. Requires the macroExecution world setting enabled for chat or script macros.
Instructions
Run a macro in the Gamemaster's browser and report its result or error. Off by default: the world setting "macroExecution" must be "chat" for chat macros or "all" for script macros. A SCRIPT MACRO CAN DO ANYTHING a Gamemaster can, including deleting documents, and cannot be undone; read its command with list-macros first. A chat macro only posts to the chat.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| args | No | Named values a script macro receives as variables and as scope | |
| alias | No | Name shown as the speaker; defaults to the token or actor name | |
| macroId | Yes | Id or exact name of the macro | |
| sceneId | No | Scene id or exact name that holds speakerToken, when the id is on several scenes | |
| speakerActor | No | Speak as this actor: its id or exact name | |
| speakerToken | No | Speak as this token: its uuid ("Scene.<id>.Token.<id>") or its id; never its name |