warp
Puts the party in an area, at one of its waypoints, by the game’s own area transition (DoAreaTransition), with no save there: the area loads and its scripts run as on arriving by its doors, so a cutscene or a fight it starts plays. Use a test save: the area’s plot may not be where its scripts expect, and plot sets flags first.
Pass area, its tag (state’s area gives the one the party is in; resources with type “are” lists them). waypoint, one of the area’s, is where the party arrives; without it, the area’s own arrival. waypoints: true lists the area’s waypoints (tag and position) and jumps nowhere. Both are checked against the area’s file before anything is sent: the game itself puts the party at (0, 0, 0) for a waypoint the area lacks.
It jumps from explore or combat mode, and answers once the party is in the area, or after budgetMs: the area, the party, the mode it arrived in (cutscene, dialog or combat if the area’s scripts started one), with a waypoint where the hero stands (at) and how far from it (fromWaypoint, metres), arrived, and a cursor for the events of the load.
A call may take up to budgetMs milliseconds, 60000 by default.
Arguments
| Name | Type | Required | What |
|---|---|---|---|
area | string | yes | The area’s tag, as pre440ar_tower_level_4 (the Tower of Ishal’s top floor). Without case. |
waypoint | string | One of the area’s waypoints, by tag. Default: the area’s own arrival. | |
waypoints | boolean | List the area’s waypoints and jump nowhere. Default false. | |
budgetMs | integer (≥ 5000, ≤ 180000) | The longest to wait for the area to load, in milliseconds. Default 60000. |
Call it as warp over MCP, or POST /api/tool/warp with the arguments as JSON.