Commands
Every command a script can use. Type in the box to filter by name or description, pick a category, or show only the commands that are new or changed in Reforged. Press Ctrl K anywhere to search the whole site.
| Name | Description | Category |
|---|---|---|
Break | Leaves the loop it is in and goes on after the loop. | Flow control |
Call | Runs another script file, then comes back when it exits. | Flow control |
ChooseSkill | Selects the skill that #Skill, #SkillCap and #SkillLock report. | Client |
Click | Clicks the mouse at a position in the client window. | Client |
CmpPix | Runs a line or block depending on whether a saved pixel still has the same colour. | Client |
Continue | Skips the rest of the loop body and goes on with the next round of the loop. | Flow control |
ContPos | Moves the top gump to a position on the screen. | Client |
DeleteJournal | Hides the journal lines read so far from later scanjournal calls. | Client |
DeleteVarobsolete | Obsolete: empties a % variable; set %x with no value does the same. | Obsolete |
Display | Shows a message box and waits for the user; the answer goes to #DispRes. | Miscellaneous |
Else | Runs a line or a block when the if before it was false. | Flow control |
Event | Makes the client do something with its own internal functions: macros, dragging, messages and more. | Event |
event ContTop | Brings a gump to the front, counted from the top gump. | Event |
event Drag | Picks up an item, as if you dragged it with the mouse. | Event |
event ExMsg | Shows a message above an object, in a chosen font and colour. | Event |
event Macro | Runs one of the client's built-in macros: speech, gumps, skills, spells, targeting, dress sets, potions. | Event |
event PathFind | Walks to a nearby spot, letting the client find a way around obstacles. | Event |
event Property | Reads the property tooltip of an item or character into #Property. | Event |
event SkillLock | Sets the lock of a skill, or of all skills; the same as exevent SkillLock. | Event |
event Sleep | Not implemented in EasyUO Reforged: accepted, but does nothing. | Event |
event StatBar | Opens the health bar of a character by its ID. | Event |
event SysMessage | Shows a system message in the client; only you see it. | Event |
Execute | Opens a program, file or web address, as if you had double-clicked it. | Miscellaneous |
ExEvent | Sends actions straight to the server as packets: drag, drop, context menus, locks and more. | ExEvent |
exevent Drag | Picks up an item, or a given amount of a stack, through the server. | ExEvent |
exevent DropC | Drops the held item into a container, or onto a stack to combine them. | ExEvent |
exevent DropG | Drops the held item on the ground at a world position. | ExEvent |
exevent DropPD | Puts the held item on: drops it on your paperdoll. | ExEvent |
exevent Equip | Asks the server to equip one or more items by ID, in one request. | ExEvent |
exevent PopUp | Opens the context menu of an item or character. | ExEvent |
exevent RenamePet | Renames one of your pets. | ExEvent |
exevent SkillLock | Sets the lock of a skill, or of all skills. | ExEvent |
exevent StatLock | Sets the lock of strength, dexterity or intelligence. | ExEvent |
Exit | Ends a called script, or starts the main script over from the top. | Flow control |
FindItem | Finds items and characters by type or ID and fills the #Find… variables with the first match. | Client |
For | Repeats a line or block while a variable counts from one number to another. | Flow control |
GetShopInfo | Reads the entry shown at the top of the shop gump into the #Shop… variables. | Client |
GetUOTitle | Puts the title of the client window in #StrRes. | Client |
Gosub | Runs a sub and comes back when it returns, optionally passing parameters. | Flow control |
Goto | Jumps to a label; the nearest label with that name wins. | Flow control |
Halt | Stops the script. | Flow control |
HideItem | Hides an item from your screen; nothing changes on the server. | Client |
If | Runs a line or a block only when a condition is true. | Flow control |
IgnoreCont | Makes the #Cont… variables skip a gump, by name or kind; reset empties the list. | Client |
IgnoreItem | Makes FindItem skip items by ID or type; the same call again un-ignores them. | Client |
InitEventsobsolete | Obsolete: event commands set themselves up; the line is ignored. | Obsolete |
Key | Presses a key in the client, optionally with Ctrl, Alt or Shift. | Client |
Label | Marks a line that goto can jump to. | Flow control |
LinesPerCycle | Sets how many lines the script runs before each 50 ms pause; the same as set #LPC. | Miscellaneous |
Menu | Builds a window of buttons, text, fields, lists and images that a script can show and read. | Menu |
menu Activate | Gives a control the keyboard focus. | Menu |
menu Button | Places a button in the menu window; a click puts its name in #MenuButton. | Menu |
menu Check | Places a check box in the menu window. | Menu |
menu Clear | Removes every control from the menu window and resets the font settings. | Menu |
menu Combo | Places a drop-down list in the menu window, and fills or selects its entries. | Menu |
menu Delete | Removes one control from the menu window. | Menu |
menu Edit | Places a one-line text field in the menu window. | Menu |
menu Font Align | Sets how the text of labels and check boxes created after it is aligned. | Menu |
menu Font BGColor | Sets the background colour of the controls created after it. | Menu |
menu Font Color | Sets the text colour of the controls created after it. | Menu |
menu Font Name | Sets the font of the controls created after it. | Menu |
menu Font Size | Sets the font size of the controls created after it. | Menu |
menu Font Style | Sets bold, italic, underline or strikeout for the controls created after it. | Menu |
menu Font Transparent | Draws the labels created after it without a background. | Menu |
menu Form | Creates another menu window, hidden, that the controls created after it go into. | Menu |
menu Get | Reads the value of a control into #MenuRes. | Menu |
menu GetDef | Reads one of the defaults new menu controls are created with into #MenuRes. | Menu |
menu GetNum | Reads a control into #MenuRes, with a default when it is not a number. | Menu |
menu GetProp | Reads a property of a menu control or window, such as its position, text or colour, into #MenuRes. | Menu |
menu Hide | Hides the menu window, as if it had been closed. | Menu |
menu HideEUO | Minimises the EasyUO Reforged window and shows only the menu window. | Menu |
menu Image Create | Places an empty, transparent image in the menu window to draw in. | Menu |
menu Image Ellipse | Draws an ellipse or circle in an image, outlined or filled. | Menu |
menu Image File | Draws a picture file into an image. | Menu |
menu Image FloodFill | Fills an area of one colour in an image with another, like a paint bucket. | Menu |
menu Image Line | Draws a line in an image. | Menu |
menu Image Pix | Paints one pixel of an image. | Menu |
menu Image PixLine | Paints a row of pixels of an image from a compact text code. | Menu |
menu Image Pos | Moves an image, and optionally resizes it, stretching what is drawn in it. | Menu |
menu Image Rectangle | Draws a rectangle in an image, outlined or filled. | Menu |
menu List | Places a list box in the menu window, and fills or selects its entries. | Menu |
menu Memonew | Creates a multi-line, scrollable text field in the EasyUO menu window. | Menu |
menu Panel | Creates a borderless area that holds other controls; the controls created after it go into it. | Menu |
menu PopDef | Brings back defaults for new menu controls saved by menu PushDef. | Menu |
menu PushDef | Saves a copy of the current defaults for new menu controls, for menu PopDef to bring back. | Menu |
menu Radio | Creates a radio button; checking one unchecks the others in the same window or panel. | Menu |
menu Reforge IncludeCallnew | Makes Reforged's choice of MENU system look at the files the script calls, too. | Menu |
menu Reforge Modenew | Chooses which MENU system the script runs under: EasyUO 1.5's or 1.6's. | Menu |
menu Set | Changes the text or state of a control. | Menu |
menu SetDef | Changes one of the defaults new menu controls are created with, such as the window or panel they go into. | Menu |
menu SetProp | Changes a property of a menu control or window: show or hide it, move it, recolour it, give it a tooltip. | Menu |
menu Shape | Draws a rectangle, circle or other shape in the menu window. | Menu |
menu Show | Shows the menu window, optionally at a position on the screen. | Menu |
menu Text | Places a label in the menu window; $ starts a new line. | Menu |
menu Window Color | Sets the background colour of the menu window. | Menu |
menu Window Size | Sets the size of the menu window. | Menu |
menu Window Title | Sets the title of the menu window. | Menu |
menu Window Transparent | Makes the whole menu window see-through, from 0 to 100 percent opaque. | Menu |
Move | Walks the character towards a position with the arrow keys; no pathfinding. | Client |
Msg | Types text into the client as if on the keyboard; $ presses Enter. | Client |
Namespace | Switches the set of ! variables a script uses: private to the script, or shared with other scripts. | Namespace |
namespace clear | Deletes every ! variable of the current namespace. | Namespace |
namespace copy | Copies variables matching a pattern between the current namespace and another. | Namespace |
namespace global | Makes a global namespace, shared with every running script, the current one. | Namespace |
namespace local | Makes a local namespace, private to this script, the current one. | Namespace |
namespace pop | Goes back to the namespace last remembered with namespace push. | Namespace |
namespace push | Remembers the current namespace, to come back to it with namespace pop. | Namespace |
NextCPos | Sets where the next gump will open. | Client |
OnHotKey | Runs a line or block only if a key is held down at that moment. | Client |
Pathnew | Plans a walking route across the map, around walls, water and buildings, with stairs and bridges, and walks it. | Pathfinding |
path Avoidnew | Marks an area routes should go around if they can: a guarded zone, a spawn. | Pathfinding |
path Blocknew | Marks a place or a rectangle that routes must never use. | Pathfinding |
path Cannew | Says whether a character can stand at a place, and at what height. | Pathfinding |
path Checknew | Asks the client itself whether the character can take a step, and at what height it lands. | Pathfinding |
path Clearnew | Forgets the path blocks, avoid areas, links and refused places, or one kind of them. | Pathfinding |
path Findnew | Plans a walking route from your character to a place on the same facet. | Pathfinding |
path Fromnew | Plans routes from another place instead of your character's position. | Pathfinding |
path Getnew | Loads one step of the last planned route into #PathX, #PathY, #PathZ and #PathDir. | Pathfinding |
path Gonew | Plans a route to a place and walks it, waiting until the character gets there. | Pathfinding |
path Linknew | Adds a teleporter, gate or ladder that routes may use: a one-way jump between two places. | Pathfinding |
path Setnew | Changes an option of the pathfinder: accuracy, search limits, how to walk, doors, creatures and more. | Pathfinding |
path Stepnew | Moves a walk on and returns at once, so the script can do other things while the character walks. | Pathfinding |
path Stopnew | Ends the walk that path step is moving on. | Pathfinding |
path Unblocknew | Removes the path blocks that cover a place or a rectangle. | Pathfinding |
path Walknew | Walks the route the last path find planned, waiting until the character gets there. | Pathfinding |
Pause | Pauses the script until Play is pressed. | Flow control |
PlayCDobsolete | Obsolete: a leftover from early EasyUO versions that does nothing. | Obsolete |
Repeat … Until | Repeats lines until a condition is true, testing it after each round. | Flow control |
Return | Ends a sub and goes back to the line after its gosub, optionally with a value. | Flow control |
SavePix | Reads the colour of a pixel into #PixCol and a numbered slot for cmppix. | Client |
ScanBuffsnew | Reads the client's buff bar into the #Buff… variables, optionally only one buff icon. | Client |
ScanJournal | Reads one journal line into #Journal and #JColor. | Client |
Send | Sends an HTTP POST request and runs the reply as an EasyUO script. | Miscellaneous |
Set | Gives a variable a value, or the result of an expression. | Miscellaneous |
SetShopItem | Sets how many of an item to buy in the shop’s buy list. | Client |
SetUOTitle | Sets the title of the client window. | Client |
ShutDown | Shuts down and powers off the computer. | Miscellaneous |
Sleep | Pauses the script for a number of milliseconds. | Flow control |
Sound | Plays a .wav file, or the Windows default beep. | Miscellaneous |
SQLnew | Keeps data in an SQLite database file: raw SQL, or a quick save and load of variables. | Data (SQL) |
sql Closenew | Closes the database; an open transaction is rolled back. | Data (SQL) |
sql Deletenew | Removes saved variables from the database. | Data (SQL) |
sql Execnew | Runs one SQL statement and discards any rows it returns. | Data (SQL) |
sql Loadnew | Restores % and ! variables saved with sql save. | Data (SQL) |
sql Opennew | Opens an SQLite database file, creating it if needed. | Data (SQL) |
sql Querynew | Runs one SQL statement, keeps its rows and loads row 1 into variables. | Data (SQL) |
sql Rownew | Loads one row of the last sql query into variables. | Data (SQL) |
sql Savenew | Stores the values of % and ! variables in the database. | Data (SQL) |
Stop | Stops the script; exactly the same as halt. | Flow control |
StopCDobsolete | Obsolete: a leftover from early EasyUO versions that does nothing. | Obsolete |
Str | Works on a piece of text (length, position, part, case, insert, delete, count); the result goes to #StrRes. | Miscellaneous |
Sub | Starts a named block of lines that gosub can call. | Flow control |
Target | Waits until a target cursor appears, or the timeout passes. | Client |
Terminate | Closes the client, or the EasyUO Reforged window. | Client |
Tile | Reads the map: how many tiles are at a spot, and the type, height, name and flags of each. | Miscellaneous |
UOXL | Starts another client, or switches the script to the next running one. | Client |
Wait | Pauses the script for a time, in 50 ms ticks or seconds, plus an optional random extra. | Flow control |
While | Repeats a line or block as long as a condition is true, testing it first. | Flow control |