What's new in Reforged

EasyUO Reforged is a port of EasyUO 1.5 from Delphi 7 to Lazarus / Free Pascal, as a native 64-bit Windows application. The language is the same and existing .euo scripts are meant to run unchanged: every command, every #variable and the quirks scripts rely on (tick timing, GOTO / GOSUB resolution, EXIT restarting the script, …) are kept on purpose.

What it adds is listed below. Reference pages mark these with New in Reforged or Changed in Reforged, and the command and variable lists can filter on both.

New commands and variables

• Path: plan a walking route anywhere on the facet, around walls and water, over bridges and up stairs, from the client’s own map files, and walk it.
  • path go and path walk walk a route and wait; path step and path stop let a script heal or fight meanwhile.
  • The walker walks step by step, or drives the client’s own pathfinder a stretch at a time. It sees the items, doors, creatures and house walls your client holds, opens doors, and goes round what it finds in the way.
  • It asks the client itself about the next 12 tiles of the route, so it goes round a house it can’t read before stepping into it. path check asks the same from a script.
  • With path block, path avoid and path link a script adds what the map doesn’t know.
  • Whether a step is a walk or a run is the client’s choice; Running shows how a script can make it run. On a mount, steps go out fast enough for a full-speed run.
  • Results come back in #PathState, #PathCnt, #PathX, #PathY, #PathZ and #PathDir.
• SQL: keep data in an SQLite database file, with raw SQL or a quick save / load of variables. Results come back in #SqlRes, #SqlCnt, #SqlChanges and #SqlLastID. See Using SQL.
• ScanBuffs: read the buff bar, with names, descriptions and timers, through #BuffCnt, #BuffIndex, #BuffID, #BuffCliloc, #BuffName, #BuffDesc, #BuffTime and #BuffBarOpen.
• EasyUO 1.6’s menu: besides the menu of EasyUO 1.5, Reforged runs the rewritten one of EasyUO 1.6, so scripts written for 1.6 show their windows. Each script runs under one or the other, picked from the sub-commands it uses.
  • The sub-commands only 1.6 has: menu Form, menu Panel, menu Radio, menu GetProp, menu SetProp, menu GetDef, menu SetDef, menu PushDef and menu PopDef.
  • menu Reforge Mode sets the system for a script; menu Reforge IncludeCall makes the automatic choice read the files the script calls.
• #MountID and #MountType: the ID and type of the mount item your character rides, N/A on foot.
• #FindLayer: the layer a character wears the object FindItem selected in.
• menu Memo: a multi-line, scrollable text field for menu windows.
• #ReforgedVer: the build version of EasyUO Reforged. #EUOVer still returns 1_50_00, so existing version checks keep working.

Changed behaviour

• FindItem also fills #FindLayer. Nothing else it does has changed.
• Tile reads the .uop map files of newer client installs directly; there is no need to extract them to the old .mul format first.
• Tile reads current maps correctly: Trammel from its own files instead of Felucca’s, Felucca and Trammel up to x 7167 instead of 6143, and Ter Mur from the right place in its files. Scripts can see different tiles there than in EasyUO 1.5. Plain tile init also works on installs that lack some of the map patch files, instead of stopping the script.

uo.dll

• uo.dll is a 64-bit build, for 64-bit programs. Its API is unchanged, plus ScanBuffs, GetBuff and BuffBarOpen for the buff bar, and the pathfinder for external programs: GetPath plans a route, PathCan and PathCheck check a tile or a step, and PathSet, PathBlock, PathUnblock, PathAvoid, PathLink and PathClear set its options and rules. They plan; they don’t walk.
• MountID and MountType read the mount, as #MountID and #MountType (0 on foot), and GetItemLayer the equip layer of an item of the ScanItems list, as #FindLayer. GetItem’s results are unchanged.
• BlockInfo no longer crashes client.exe 7.0.117.1: EasyUO 1.5 passed the client’s function one argument too few. Its page now says what the two bytes per tile mean.

The editor

• Line numbers and Ctrl+Space autocomplete (it knows the sub-commands of menu, sql, event and the others, and the property names of menu GetProp).
• The status bar shows which menu system a script runs, and a message tells you when a script needs the other one.
• A Find and Replace window with regular expressions, wrap-around, a match count, every match highlighted, search in a selection or in all open scripts, search history, and F3 / Shift+F3.
• Code folding for subs, { } blocks and repeat, with Fold All / Unfold All.
• Format Script (Ctrl+Shift+F) re-indents a script in one step.
• Breakpoints, conditional breakpoints, step into / over / out, run to cursor and a live call stack.

See Editing and debugging.

The MENU Designer

• The MENU Designer (EUOMenuDesigner.exe, in the release zip): lays out EasyUO 1.6 menu windows on a canvas, with alignment tools and snapping, and writes their script, one sub per window. It opens scripts too, including ones it did not write, and reads their menu lines back into windows you can go on editing.

Not in Reforged

• event Sleep is accepted but does nothing.
• PlayCD, StopCD and InitEvents do nothing, as in EasyUO 1.5.

See also the known limitations.