set_event_page
Update an RPG Maker MZ event page's graphic, trigger, priority, movement, and flags in a single call, keeping its command list intact. Includes validation and force override.
Instructions
Update an existing event page's graphic and behavior in one call, without rebuilding the whole page or touching its command list: sprite (characterName/characterIndex/direction/pattern or a tileId), trigger, priority, movement (type/speed/frequency/route), and the through/walkAnime/stepAnime/directionFix flags. Graphic fields merge onto the current image; warns (never blocks) on an unknown characterName. Refuses the write if the change would leave the event unreachable (an action-button page with priority below on an impassable tile) — pass force: true to override.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Write even if validation finds structural problems (wrong parameter count, unterminated command list). Off by default: such a write is refused and nothing is written. Advisory warnings never block regardless. | |
| mapId | Yes | The ID of the map | |
| dryRun | No | Preview only: return a diff of what would change without writing to disk. | |
| indent | No | (unused; page-level tool) | |
| tileId | No | Use a tile as the graphic instead of a sprite (0 = none) | |
| eventId | Yes | The ID of the event | |
| pattern | No | Sprite animation frame 0–2 (1 = idle) | |
| through | No | Let the player/others pass through the event | |
| trigger | No | What starts the page | |
| verbose | No | Echo the full written record instead of the default summary. Off by default: the response reports identity, counts and command-list shape, which is what you would assert on, and omits the parameters/conditions you would only re-read. Read the full record with the matching get_* tool. | |
| moveType | No | Autonomous movement (custom uses moveRoute) | |
| priority | No | Stacking vs. the player: below/same/above characters (same = solid) | |
| direction | No | Facing direction of the sprite | |
| moveRoute | No | Autonomous move route (from create_move_route); pairs with moveType "custom" | |
| moveSpeed | No | Movement speed 1–6 (4 = normal) | |
| pageIndex | Yes | Zero-based page index | |
| stepAnime | No | Animate in place while stopped | |
| walkAnime | No | Animate the walk cycle while moving | |
| directionFix | No | Lock the facing direction | |
| characterName | No | Sprite sheet basename (from list_assets("characters")); "" = no sprite | |
| moveFrequency | No | Movement frequency 1–5 (3 = normal) | |
| characterIndex | No | Sprite index 0–7 in the sheet |