Path

path plans a route from your character to a place anywhere on the facet, around walls, rivers and buildings, over bridges, up and down stairs, and walks it. It reads the map from the client’s own files, so it knows the whole facet, not only what is on screen.

path go 1823 2821            ; from here to Trinsic, on foot
if #PathState <> arrived
  display ok Did not get there: #PathState
halt

To look at the route first, plan it with path find, then walk it:

path find 1823 2821
if #PathState <> ok
{
  display ok No route: #PathState
  halt
}
for %i 1 #PathCnt
{
  path get %i
  ; #PathX #PathY #PathZ is where step %i ends, #PathDir its direction
}
path walk
halt

Sub-commands

Command	What it does
path go	Plans a route to a place and walks it.
path walk	Walks the route path find planned.
path step	Moves a walk on and returns at once, so the script can do other things meanwhile.
path stop	Ends the walk path step is moving on.
path find	Plans a route from your character (or from path from) to a place.
path get	Loads one step of the route into #PathX, #PathY, #PathZ, #PathDir.
path can	Says whether a character can stand at a place, and at what height.
path check	Asks the client itself whether the character can take a step of the route, or onto a place.
path from	Plans from another place instead of your character.
path set	Changes an option: accuracy, search limits, how to walk, doors, creatures, …
path block	Marks places the route must never use.
path unblock	Removes blocked places.
path avoid	Marks areas the route should go around if it can.
path link	Adds a teleporter, gate or ladder the route may use.
path clear	Forgets blocks, avoid areas, links and the places where a step was refused.

A path line never stops the script. #PathState says how the last path command went: ok or arrived, or what went wrong.

What the route knows about

The route is planned from the map designers’ world: terrain and water, town buildings and walls, trees, bridges, stairs and dungeons. The map files don’t have the dynamic world: player houses, items players placed, open or closed doors, and creatures. Your client only learns about those when they come within about 18 tiles.

So path adds what your client holds around the character: items on the ground, doors, creatures, and the walls and floors of player houses (on client.exe 7.0.117.1 and client_beta.exe 7.0.117.31, and on other builds where EasyUO Reforged finds them). While walking, it also asks the client itself about the next 12 tiles of the route (path check), which covers whatever is left: custom houses, or a build where it can’t read house pieces. A route is right everywhere about the map, and right near the character about the rest. Farther away it can lead into a house or a crowd the client hasn’t shown yet; the walker sees those as it gets near, and goes round them (see How it walks). Use path block for places you know about.

The options, blocks, avoid areas, links and the places where a step was refused last until the script is started again.

Running

The walker walks with the client’s own walk macro, and the client decides whether each step is a walk or a run. It runs a step when either of these holds:

• Always Run is on in the client’s options.
• The mouse pointer rests away from the character, more than about 213 pixels to the side or 160 pixels up or down from the middle of the game view (#CliLeft, #CliTop, #CliXRes, #CliYRes). It is the real pointer that counts: the client reads it itself many times a second. So if you leave the mouse beside the game window while a walk runs, the character runs; with the mouse over the character, it walks.

Neither holds at very low stamina: the client walks then. path doesn’t change either setting: running is your choice. A mounted character’s steps go out twice as fast as on foot, so a run on a mount gets its full speed (#MountID says whether you ride).

A script can switch Always Run on for a walk. event Macro 32 is the client’s Always Run toggle, and the client answers it in the journal with “Always Run is now on.” or “Always Run is now off.” (the same English text in every client language). This switches it on, walks, and puts it back as it was:

gosub ToggleAlwaysRun
set %switched #false
if %run = on
  set %switched #true        ; it was off: switch it back off after the walk
if %run = off
  gosub ToggleAlwaysRun      ; it was on already: switch it back on, and leave it on
path go 2505 552
if %switched = #true
{
  gosub ToggleAlwaysRun
  if %run = on
    gosub ToggleAlwaysRun    ; it had been switched off meanwhile: off again
}
halt

; Toggles Always Run. %run becomes on or off, as the client's answer in the journal says, or none
; when no answer came within a second.
sub ToggleAlwaysRun
  set %next #JIndex + 1
  set %run none
  set %tries 0
  event macro 32 0
  repeat
    wait 1
    set %tries %tries + 1
    while %next <= #JIndex
    {
      scanjournal %next
      if Always_Run_is_now_on in #Journal
        set %run on
      if Always_Run_is_now_off in #Journal
        set %run off
      set %next %next + 1
    }
  until %run <> none || %tries >= 20
return

A script can also park the mouse pointer away from the character, at a corner of the game view. click with n doesn’t press anything, and mc moves the real pointer there:

set %x #CliLeft + 20
set %y #CliTop + 20
click %x %y n mc             ; the pointer moves to the game view's top-left corner, without a click
path go 2505 552             ; leave the mouse there until the walk ends
halt

click … dmc can’t do this: it leaves the real pointer where it is, and the client goes by the real pointer. Moving the mouse back near the character during the walk makes the next steps walk.

Reforged notes

path and the #Path… variables are new in EasyUO Reforged. event PathFind, Move and Tile are unchanged; the walker uses event PathFind and the walk and Open Door macros itself.

The step rules (how high a character can climb, how much head room it needs, how stairs and bridges work) are those of the ClassicUO client.

Programs that drive the client through uo.dll get the planning too: GetPath returns a whole route in one call, and PathCan, PathCheck, PathSet, PathBlock, PathUnblock, PathAvoid, PathLink and PathClear match the sub-commands. There is no walker in uo.dll.

The first route on a facet loads that facet’s map files, which takes a moment. Current clients ship Felucca and Trammel as .uop files, which use about 90 MB of memory each once loaded. A long route takes under a second: Britain to Minoc, about 1,500 steps, took 0.7 s on the developer’s PC.

See also

• path Go
• path Find
• event PathFind
• Move
• Tile