EasyUO Documentation

Table of Contents

Preface

Introduction

Revision History

Credits

1. Getting Started

Introduction

What is EasyUO?

What can EasyUO do?

A simple tutorial

What do I need?

Your first EasyUO script

Something useful

What's next?

Installation

2. Language Reference

Variables

Basics

Standard Variables

Namespace Variables and Scope

Persistent Variables

System Variables

Variable Scope

Expressions

Operators

Arithmetic Operators

Comparison Operators

Code Formatting Operators

Logical Operators

String Operators

Array Operators

Precedence and associativity

Control Structures

if

else

for

Subs

gosub

return

goto

Labels

I. Command Reference

I. Control-flow commands

call - Transfers execution to another script file

cmpPix - Compares a current pixel to a previously saved pixel.

exit - Stops the execution of the current script

for - Creates a counting loop

gosub - Transfers execution to the matching sub.

goto - Moves execution to another part of the script given by a label.

halt - Ends the script.

if - Executes code based on the evaluation of an expression.

pause - Temporarily stops the execution of the current script.

return - Returns from a sub.

stop - Ends the script.

II. Client commands

chooseSkill - Reads the current skill value/lock status for a specific skill

click - Clicks at a specific position in the UO client.

contPos - Moves the active topmost gump to a new position.

deleteJournal - Forgets the contents of the journal buffer.

findItem - Finds items, monsters, players, NPCs based on object ID or object type.

getUOTitle - Gets the text on the title bar of the client.

hideItem - Removes an items graphic from the client.

ignoreItem - Removes items from the list searched by findItem.

key - Sends a key-stroke to the client.

move - Moves the character to a specified location.

msg - Sends a string to the client as keystrokes.

nextCPos - Denotes where the next opened container/gump will open.

onHotKey - Performs a line of code if a specific key is pressed.

savePix - Saves the color of a pixel in a specified location.

setUOTitle - Sets the text on the title bar of the client.

scanJournal - Scans the users journal and stores the string for examination.

sleep - Waits a specified amount of time.

target - Waits for a target cursor to appear.

terminate - Terminates the current client.

uoXL - Start/manage clients.

wait - Waits a specified amount of time.

III. Event commands

event Drag - Drags an object

event ExMsg - Shows a message over the object given by the ID.

event Macro - Performs a UO internal macro.

event PathFind - Moves you to a specified position if it is possible.

event Property - Reads the property description of an item.

event SkillLock - Changes the skill locks on the different skills.

event Sleep - Suspends the client for a specified time.

event SysMessage - Outputs text to the client as a system message.

initEvents - Initializes all event commands.

IV. Shop Commands

getShopInfo - Retrieves information from the client about the currently shown top entry on a shopping gump.

setShopItem - Sets the number of items to purchase given by ID.

V. Menu Commands

menu Activate - Activates a window element in the EasyUO menu window.

menu Button - Creates a button at position x/y with specified size on the EasyUO menu window.

menu Check - Creates a checkbox at position x/y with specified size on the EasyUO menu window.

menu Clear - Clears all window elements from the EasyUO menu window.

menu Combo - Creates a combobox at position x/y with specified size on the EasyUO menu window or adds entires to the combobox.

menu Delete - Deletes a window element from the EasyUO menu window.

menu Edit - Creates a edit field at position x/y with specified width in the EasyUO menu window.

menu Font Align - Changes the font alignment in the EasyUO menu window.

menu Font BGColor - Changes the font background color in the EasyUO menu window.

menu Font Color - Changes the font color in the EasyUO menu window.

menu Font Name - Changes the font in the EasyUO menu window.

menu Font Size - Changes the font size in the EasyUO menu window.

menu Font Style - Changes the font style in the EasyUO menu window.

menu Font Transparent - Sets the transparency of the background color of the font.

menu Get - Returns the value associated with a control in the EasyUO menu window.

menu GetNum - Returns the number in an edit field in the EasyUO menu window.

menu Hide - Hides the EasyUO menu window.

menu HideEUO - Hides the main EasyUO window.

menu List - Creates a listbox at position x/y with specified size on the EasyUO menu window or adds entires to the listbox.

menu Set - Sets the text of a control.

menu Shape - Creates a shape in the EasyUO menu window.

menu Show - Shows the EasyUO menu window.

menu Text - Creates a label at the specifed postion in the EasyUO menu window.

menu Window Color - Changes the color of the EasyUO menu window.

menu Window Size - Changes the size of the EasyUO menu window.

menu Window Title - Changes the title of the EasyUO menu window.

VI. Namespace commands

nameSpace {local | global} - Defines the current namespace and its scope.

nameSpace clear - Clears every variables within the current namespace.

nameSpace {push | pop} - Store and restore the current namespace name and scope.

nameSpace copy - Copy variables from one namespace to another.

VII. Miscellaneous commands

deleteVar - Sets a variable to an empty string

display - Shows a message

execute - Executes an external program.

linesPerCycle - Sets the execution speed.

playCD - Starts playing an audio CD in a CD-Rom drive.

set - sets a variable to a value (variable assignment).

send - Sends a HTTP request to a server and runs the code that is returned.

shutDown - Shuts your computer down.

sound - Plays a wave file or the SystemDefault beep.

str - performs a operation on a string.

tile - retrieves information about tiles.

II. System Variable Reference

VIII. Character Info System Variables

#charPosX - (readonly) Determines the characters world X-coordinate.

#charPosY - (readonly) Determines the characters world Y-coordinate.

#charPosZ - (readonly) Determines the characters world Z-coordinate.

#charDir - (readonly) Determines the direction the character is facing.

#charStatus - (readonly) Determines different states that the character can be in.

#charID - (readonly) Determines the id of the character.

#charGhost - (readonly) Determines if your character is dead.

IX. Status Bar System Variables

#charName - (readonly) Determines the name of the character.

#str - (readonly) Determines the strength of the character.

#hits - (readonly) Determines the current number of hitpoints of the character.

#maxHits - (readonly) Determines the maximum number of hitpoints of the character.

#dex - (readonly) Determines the dexterity of the character.

#stamina - (readonly) Determines the current stamina level or the character.

#maxStam - (readonly) Determines the maximum stamina level or the character.

#int - (readonly) Determines the inteligence of the character.

#mana - (readonly) Determines the current mana pool for the character.

#maxMana - (readonly) Determines the maximum mana pool for the character.

#maxStats - (readonly) Determines the current maximum stats of the character.

#sex - (readonly) Determines the sex of the character.

#AR - (readonly) Determines the Armor Rating of the character.

#FR - (readonly) Determines the Fire Resist of the character.

#CR - (readonly) Determines the Cold Resist of the character.

#PR - (readonly) Determines the Poison Resist of the character.

#ER - (readonly) Determines the Energy Resist of the character.

#gold - (readonly) Determines the amount of gold on the character.

#weight - (readonly) Determines the current weight of the character.

#maxWeight - (readonly)Determines the maximum weight of the character.

#followers - (readonly) Determines the current number of followers of the character.

#maxFol - (readonly) Determines the maximum number of followers of the character.

#luck - (readonly) Determines the current luck of the character.

#minDmg - (readonly) Determines the minimum damage done with the currently yielded weapon.

#maxDmg - (readonly) Determines the maximum damage done with the currently yielded weapon.

X. Container Info System Variables

#nextCPosX - (read/write) Determines the x-coordinate of where the next containter/gump will open.

#nextCPosY - (read/write) Determines the y-coordinate of where the next containter/gump will open.

#contSize - (readonly) Determines the size of the currently selected container/gump.

#contPosX - (read/write) Determines the x-coordinate of the currently selected container/gump.

#contPosY - (read/write) Determines the y-coordinate of the currently selected container/gump.

#contKind - (readonly) Determines the kind of the currently selected container/gump.

#contID - (readonly) Determines the id of the currently selected container/gump.

#contType - (readonly) Determines the object type of the currently selected container/gump.

#contName - (readonly) Determines the name of currently selected container/gump.

XI. Last Action System Variables

#lObjectID - (read/write) Determines the id of the last used object.

#lObjectType - (readonly) Determines the type of the last used object.

#lTargetID - (read/write) Determines the id of the last target used.

#lTargetX - (read/write) Determines the world x-coordinate of the last target used.

#lTargetY - (read/write) Determines the world y-coordinate of the last target used.

#lTargetZ - (read/write) Determines the world z-coordinate of the last target used.

#lTargetKind - (read/write) Determines the kind of what was last targeted.

#lTargetTile - (read/write) Determines the tile last targeted.

#lLiftedID - (readonly) Determines the id of the object last dragged/lifted.

#lLiftedType - (readonly) Determines the type of the object last dragged/lifted.

#lLiftedKind - (readonly) Determines if an object is being dragged/lifted.

#lSkill - (read/write) Determines the skill last used.

#lSpell - (read/write) Determines the last spell cast.

XII. FindItem System Variables

#findID - (readonly) Determines the id of the object returned by findItem.

#findType - (readonly) Determines the type of the object returned by findItem.

#findX - (readonly) Determines the x-coordinate of the object returned by findItem.

#findY - (readonly) Determines the y-coordinate of the object returned by findItem.

#findZ - (readonly) Determines the z-coordinate of the object returned by findItem.

#findDist - (readonly) Determines the distance from the character to the object returned by findItem.

#findKind - (readonly) Determines the kind of the object returned by findItem.

#findStack - (readonly) Determines the number of stacked items in the object returned by findItem.

#findBagID - (readonly) Determines the bag the object returned by findItem is contained in.

#findMod - (read/write) Determines displacement for #findX and #findY.

#findRep - (readonly) Determines the reputation of the object returned by findItem.

#findCol - (readonly) Determines the color of the object returned by findItem.

#findCnt - (readonly) Determines the number of objects that matches what was searched for with the findItem command.

XIII. Shop Info System Variables

#shopCurPos - (readonly) Determines the current position on the shop menu

#shopCnt - (readonly) Determines the total number of lines on the shop menu.

#shopItemType - (readonly) Determines the item type of the current line on the shop menu.

#shopItemID - (readonly) Determines the item ID of the current line on the shop menu.

#shopItemName - (readonly) Determines the name of the item the current line on the shop menu.

#shopItemPrice - (readonly) Determines the price of the current line in the shop menu.

#shopItemMax - (readonly) Determines the number of items in the stack of the current line in the shop menu.

XIV. Extended Info System Variables

#skill - (readonly) Determines the current skill level for a skill chosen with chooseSkill command.

#skillCap - (readonly) Determines the current skill cap for a skill chosen with chooseSkill command.

#skillLock - (readonly) Determines the current lock status of the skill chosen with chooseSkill command.

#journal - (readonly) Determines the journal line selected using the scanJournal command.

#jIndex - (readonly) Determines the index of the current journal entry.

#jColor - (read/write) Determines the color of the text in the journal.

#sysMsg - (readonly) Determines the current system message.

#sysMsgCol - (read/write) Determines the current system message color.

#targCurs - (read/write) Determines if cursor is a target cursor.

#cursKind - (readonly) Determines the facet where the character is.

XV. Client Info System Variables

#cliVer - (readonly) Determines the version of the client.

#cliCnt - (readonly) Determines the number of clients currently running.

#cliNr - (readonly) Determines which client is currently active for EasyUO.

#cliXRes - (read/write) Determines the width of the gameplay window.

#cliYRes - (read/write) Determines the height of the gameplay window.

#cliLeft - (read/write) Determines the X coordinate of the left edge of the gameplay window.

#cliTop - (read/write) Determines the Y coordinate of the top edge of the gameplay window.

#cliLogged - (readonly) Determines if a character is logged into the game.

XVI. Combat Info System Variables

#lHandID - (read/write) Determines the ID of the item to be armed in the left hand.

#rHandID - (read/write) Determines the ID of the item to be armed in the right hand.

#enemyHits - (readonly) Determines the percentage of hit points left on the current enemy.

#enemyID - (readonly) Determines the ID of the current enemy.

XVII. Namespace System Variables

#nsName - (readonly) Determines the name of the currently active namespace.

#nsType - (readonly) Determines the type of the currently active namespace.

XVIII. Miscellaneous System Variables

#shard - (readonly) Determines which shard you are logged into.

#date - (readonly) Determines the local date on your computer.

#time - (readonly) Determines the local time on your computer.

#sysTime - (readonly) Counts the number of milliseconds since 01/Jan/1980 UTC..

#sCnt - (read/write) Timer in seconds since Windows boot.

#sCnt2 - (read/write) Timer in tenths of seconds since Windows boot.

#pixCol - (readonly) Determines the color of the pixel last saved with savePix.

#cursorX - (readonly) Determines the x-coordinate of the cursor.

#cursorY - (readonly) Determines the y-coordinate of the cursor.

#random - (readonly) Holds a random number.

#dispRes - (readonly) Determines button clicked in last call to display.

#menuButton - (read/write) Determines the name of the last menu button clicked.

#menuRes - (readonly) Determines the content of last menu Get or menu GetNum.

#sendHeader - (read/write) Determines http header information for the send command.

#strRes - (read/write) Determines the result of last str command.

#property - (readonly) Determines the result of last event Property command.

#result - (read/write) Determines the result of last return command.

#opts - (readonly) Determines which EasyUO configuration options are active.

#euoVer - (readonly) Determines the current EasyUO version.

#lpc - (read/write) Determines the current linesPerCycle setting.

#tileType - (readonly) Determines the type for the currently read tile.

#tileZ - (readonly) Determines the z-coordinate for the currently read tile.

#tileCnt - (readonly) Determines the number of tiles in the currently read position.

#tileName - (readonly) Determines the name for the currently read tile.

#tileFlags - (readonly) Determines the flags for the currently read tile.

XIX. Constants System Variables

#dot - (readonly) A constant that represents a dot character.

#false - (readonly) A constant that represents boolean false.

#smc - (readonly) A constant that represents semi-colon character.

#spc - (readonly) A constant that represents space character.

#true - (readonly) A constant that represents boolean true.

A. Design Hotkey Manager

B. GNU Free Documentation License

PREAMBLE

APPLICABILITY AND DEFINITIONS

VERBATIM COPYING

COPYING IN QUANTITY

MODIFICATIONS

COMBINING DOCUMENTS

COLLECTIONS OF DOCUMENTS

AGGREGATION WITH INDEPENDENT WORKS

TRANSLATION

TERMINATION

FUTURE REVISIONS OF THIS LICENSE