SkunkNav

The name, if any, of this route. Defaults to the empty string.

If the route starts with a house or lifestone recall, the @ command that invokes it. Otherwise the empty string.

The number of points in the route, including the final destination.

Returns the i ^th waypoint in the route (where points are numbered starting at zero).

Provides direct access to the array of points in the route. Accessible only from JScript.

The index (counting from zero) of the waypoint from which to resume an interrupted route.

If non-zero, the maximum time in seconds needed to execute this route. If execution takes longer than this, something must have gone astray and the route should be terminated. The default value is zero (no timeout).

Deletes all points from the route and resets it to an empty state.

Adds a point to the route. Use this method to build up your route point by point. i is optional; if present, the new point is inserted before the i ^th waypoint (counting from zero). If omitted, the new point is appended to the end of the route.

Adds your current location to the route. i is optional; if present, the new point is inserted before the i ^th waypoint (counting from zero). If omitted, the new point is appended to the end of the route.

Adds a door to the route. acoDoor is the door to be added, and must be a valid ACO. If the door is closed when your character gets there, route.Go will open it. (If the door is locked, you're on your own; there's no provision here for unlocking it.) i is optional; if present, the new point is inserted before the i ^th waypoint (counting from zero). If omitted, the new point is appended to the end of the route.

Adds a portal to the route. acoPortal is the portal to be added, and must be a valid ACO. When your character gets there, route.Go will portal through and then continue on to the next waypoint following the portal. i is optional; if present, the new point is inserted before the i ^th waypoint (counting from zero). If omitted, the new point is appended to the end of the route.

Deletes the i ^th waypoint from the route.

Appends the points in route2 to the end of this route, concatenating the two routes. route2 is not modified by this method (but this route is).

Returns a new route object representing the concatenation of this route with route2. Neither this route nor route2 is modified by this method. If fOptimize is false, the two routes are concatenated verbatim. If true, redundant points at the juncture of the two routes are pruned away. Thus if route2 is the exact reverse of this route, the concatenation will be empty (if fOptimize is true). If only part of route2 matches the reversal of this route, then only that portion of both routes will be removed, leaving the unique portions intact.

For example, suppose merchant A and merchant B share a shop, or occupy different stalls in the same bazaar. The route in to A will be very similar to the route in to B, except at end where the two routes diverge. The naive way to get from A to B would be to concatenate the reverse of route A with route B, like so:

routeA2B = routeA.RouteReverse().RouteConcat(routeB, false);

While this works, it has the effect of taking your character out of the shop, then turning him around and heading right back in to B. By specifying fOptimize as true, this is avoided; the redundant part of the combined route is removed, and your character backtracks only to the point where the routes diverge before continuing on to B.

Returns a new route object with with the order of the points reversed. Use this method to backtrack along a route. Note that since travel by recall or portal is one-way, using RouteReverse on a route containing a recall or portal may not yield sensible results unless the route defines an explicit reverse route. See Route file format for details.

Saves the route to the file named by szFile. Any previous contents of the file are overwritten.

Loads a route from the file named by szFile. The previous contents of the route object are lost. szFile can be either a simple filename such as "MyFile.route" or a filename followed by a route name in square brackets, such as "MyFile.route[MyRoute]". Use the latter form to load a specific route from a file containing several named routes.

The specified route file can be one created by route.SaveToFile, one you've typed in manually or created using RouteMaker, or one you've exported from AC Explorer Pro. See Route file format for information on how to create routes manually.

If you're going to use route.FromFile to read ACX Pro route files, make sure your ACX Pro terrain data is up to date before calculating and exporting the route. Do this in ACX Pro by choosing "Update terrain..." from the Update menu. Also note that routes calculated in this way are accurate only to about 0.1 map unit (about 40 paces). While they work well on flat or hilly terrain, in rugged mountainous regions you may find your character running along the bottom of a cliff he's supposed to be on top of. There's not much I can do about this without more precise route information from ACX Pro.

Saves the route to an open text stream. Use this method to embed routes in other file types, or to save several routes to a single file. If the route has a name (i.e. if route.szName is nonempty), the route is labelled in the file with its name so it can be found again by route.FromFile. See Route file format for details.

Loads a route from an open text stream. The previous contents of the route object are lost. Use this method to read routes embedded in other files types, or to read several routes consecutively from a single file.

Moves your character from point to point along the route to the endpoint. Where possible, intermediate waypoints are taken at full running speed; where waypoints are close together, you may slow to a walk, or even stop momentarily for sharp turns. If the route includes doors, route.Go will inspect them and open them as needed. If it includes portals, route.Go will Use them and wait for you to emerge from portal space before continuing.

If along the way you get stuck in a corner or something so that no progress is made for ten seconds, route.Go attempts to back out and try again from a different angle. (But don't expect miracles if you get stuck indoors.) If a door slams in your face just as you're about to go through it, route.Go should notice that no progress is being made and try to reopen the door.

route.Go returns when any one of the following conditions is met:

• You arrive within about four paces of the route's endpoint.
• The route takes longer than route.csecTimeout to complete.
• route.StopRoute is called.
• You get killed somewhere along the way (in which case route.Go leaves you standing safely by the lifestone).
• You enter or exit combat mode. (Use this to manually interrupt a wayward route.)

In the first case (safe arrival), route.imaploc will equal route.cmaploc on return from route.Go. In all other cases, imaploc will be less than cmaploc.

Stops execution of a route in progress. Call this from an event handler to interrupt route.Go and return control to the caller of route.Go.

Resumes execution of an interrupted route. This is just like route.Go except that execution starts at route.imaploc instead of at the beginning of the route.