create_transfer
Create a complete map-transfer event in RPG Maker MZ using action-button or player-touch triggers. Handles destination, facing, and fade in one call.
Instructions
Create a complete, placed map-transfer event in one call, using whichever of the two working idioms you pick. idiom: "action_button" (default) makes a priority-same event the player faces and presses — the right shape for a solid landmark (building, dungeon mouth, door); idiom: "player_touch" makes an invisible priority-below doormat the player walks onto — for interior exits and map-edge gaps. direction is the facing the player lands with, fade the screen transition. Throws if the destination map does not exist; warns if the destination tile is outside that map, if the characterName is unknown, or if the event can never fire from where it sits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | X tile position of the trigger | |
| y | Yes | Y tile position of the trigger | |
| fade | No | Screen fade during the transfer; default "black" | |
| name | No | Event name (editor label); default "Transfer" | |
| 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. | |
| idiom | No | action_button = face a solid landmark and press (priority same, default); player_touch = walk onto a doormat (priority below) | |
| mapId | Yes | The ID of the map the trigger is placed on | |
| dryRun | No | Preview only: return a diff of what would change without writing to disk. | |
| targetX | Yes | X tile the player lands on | |
| targetY | Yes | Y tile the player lands on | |
| direction | No | Facing after the transfer; default "retain" | |
| targetMapId | Yes | The ID of the destination map | |
| characterName | No | Optional sprite basename (a doormat is normally left invisible) | |
| characterIndex | No | Sprite index 0-7 in the sheet |