SolarStrike wiki - User contributions [en]

RoM Custom Scripting

2011-08-08T17:04:46Z

Pumbatoo:

* [[RoM Heal Yourself|How To: Heal yourself with the Bot]]
* [[RoM Working with profile events|How To: Working with profile events]]
* [[RoM Harvest|How To: Harvest]]
* [[RoM Leveling|How To: Automatic Leveling e.g. Level 1-10]] - Connect waypoint files, level up skills, open bags and equipt items
* [[RoM Working with waypoint files|How To: Working with waypoint files]]
* [[RoM Auto repair|How To: Auto Repair and Auto Sell]]
* [[RoM Fight Support Only|How To: Use the Bot as Fight Support Only]]
* [[RoM Looting Issues|How To: Looting Issues, Lootfilter, Problems ...]]
* [[RoM Click in foreground|How To: Use mouseclick on foreground window]]
* [[RoM DailyLevel1Elves|Example Script: Daily Quest Tal der Vorbereitung (German Labels)]]

RoM Waypoint file

2011-08-08T17:01:26Z

Pumbatoo: moved RoM Waypoinf files to RoM Waypoint file: typo correction

= Create a new waypoint file =
Start MicroMacro and execute the rom/createpath.lua script by entering
rom/createpath.lua
into your MM window. You need a valid profile for your ingame charactername and have to set the dummy macro ingame. You could also execute the script with a forced profile
rom/createpath.lua profile:default

You just walk to each point you want in your waypoint list (try to avoid walking near any trees, fences, steep hills, etc.), and press NUMPAD 1. Once you've made your round (the waypoints should loop back and bring you near the start), press NUMPAD 3. Now type in the name you want to save it as (example: 'boars' would be good enough. Don't include any slashes, and the .xml extension is automatically applied).

The new created waypointfile boars.xml will look like:

<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-791" z="-8322"></waypoint>
<waypoint x="-637" z="-8155"></waypoint>
<waypoint x="-552" z="-8251"></waypoint>
<waypoint x="-640" z="-8412"></waypoint>
<waypoint x="-800" z="-8308"></waypoint>
</waypoints></source>

= Waypoint types =

You can determine the targeting and attacking behaviour of the bot by using waypoint types. You can add the 'type' option at the top of the waypoint file or separately for each waypoint. The default value is 'NORMAL'. If you don't specify a type at the waypoint, the waypoint will inherit the type from the <WAYPOINTS> tag at the top of the file

<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-791" z="-8322"></waypoint>
<waypoint x="-637" z="-8155" type="RUN"></waypoint>
<waypoint x="-552" z="-8251"></waypoint>
</waypoints></source>In this example, the waypoints #1 and #3 have the type 'TRAVEL' and the waypoints #2 have the type 'RUN'.

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | NORMAL
| style="border-bottom:1px dotted #000000;" | Default value for waypoints. The bot will try to target new mobs and attack them.
|-
| style="border-bottom:1px dotted #000000;" | RUN
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs but will fight back against aggressive enemies.

This should be used when attempting to run through groups of enemies and only bothering with those that attack you, such as when you are running out to your farming spot.
|-
| style="border-bottom:1px dotted #000000;" | TRAVEL
| style="border-bottom:1px dotted #000000;" | The bot will not targeting mobs and will not stop if he gets aggro. He will just run until he reach a waypoint with one of the other waypoint types or get a stop command within the waypoint coding.

This should be used to travel to "safe" locations (ie. town).
|}

= Using LUA code within your waypoint files =
You can use you own lua code '''within''' the <waypoint></waypoint> tags. By doing that you can do nearly everything.
The lua code will be executed after you reach that waypoint. It would look like:
<source lang="xml">
<waypoint x="-2462" z="-9625"></waypoint>
<waypoint x="-2391" z="-9639">
if( player.Level > 2 ) then
loadPaths("1-10Pioneers/l3t_3-4_bear");
end
</waypoint>
<waypoint x="-2144" z="-9585"></waypoint>
</source>

You may also make use of an onLoad event for this waypoint script. This Lua code will be executed when the waypoint script is loaded (either automatically or by calling __WPL:load()).
<source lang="xml">
<waypoints>
<onLoad>
printf("Waypoint onLoad event test.\n");
</onLoad>
<waypoint x="-2462" z="-9625"></waypoint>
</waypoints>
</source>

See the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions list of functions] that you can use for your own coding.

= The included 'RBAssist.xml' waypoint file =

This file does not move your character, only heals, buffs and attacks monsters. It can be used to help you when you are playing manually.

It has 3 'modes' that can be set by the user by changing the 'attackMode' variable at the top of the file.
The 3 modes are:
{|
|- style="padding: 8px;" |
| style="width: 80px;" | ''''trigger''''
| = Have to trigger each attack with the "go" macro.
|-
| style="width: 80px;" | ''''auto''''
| = Auto attacks targeted monsters. "go" macro toggles it on and off.
|-
| style="width: 80px;" | ''''disabled''''
| = Only heal and buff. Never attacks. "go" macro does nothing.
|}

By default it is set to mode ''''auto'''' and is switched 'on' so it is ready to attack automatically when you target a monster even without using the trigger. So in the default mode, using the 'trigger' is optional.

If you wish to use the trigger, create a macro with the command
/script RBTrigger = "go"
and add it to your action bar. Then when you press it, the script will receive the trigger and act accordingly.

RoM Waypoinf files

2011-08-08T17:01:26Z

Pumbatoo: moved RoM Waypoinf files to RoM Waypoint file: typo correction

#REDIRECT [[RoM Waypoint file]]

RoM Waypoint files

2011-08-08T17:00:04Z

Pumbatoo: Blanked the page

Del:RoM Waypoint files

2011-08-08T16:58:06Z

Pumbatoo: moved RoM Waypoint files to Del:RoM Waypoint files

RoM Waypoint files

2011-08-08T16:58:06Z

Pumbatoo: moved RoM Waypoint files to Del:RoM Waypoint files

#REDIRECT [[Del:RoM Waypoint files]]

RoM Waypoint file

2011-08-08T16:57:31Z

Pumbatoo:

Del:RoM Waypoint files

2011-08-08T16:57:15Z

Pumbatoo: Created page with '= Create a new waypoint file = Start MicroMacro and execute the rom/createpath.lua script by entering rom/createpath.lua into your MM window. You need a valid profile for your i…'

Talk:RoM Working with waypoint files

2011-08-08T16:51:01Z

Pumbatoo: Redundance and non How Tos

The only How Tos on this page are the last two sections:
* 'How to use the bot for running between the and NPC <-> blackboard for delivering of daily quests', and
* 'Automatic leveling with the Bot'.

The two sections above were still described on other places:
* The first section 'LUA code within a waypoint file' is already in the official Waypoint File Page. (see [http://www.solarstrike.net/wiki/index.php5?title=RoM_Waypoinf_files#Using_LUA_coding_with_your_waypoint_files])
* The second section 'List of functions' highly increase redundance and produce defects. It represents a copy of functions already described on page RoM Functions [http://www.solarstrike.net/wiki/index.php5?title=RoM_Functions#Waypoint_File_Functions].

User:Pumbatoo

2011-08-08T13:58:11Z

Pumbatoo: Created page with '== RoM bot Wiki Stuff == * Waypoint files - All you need to know about waypoint files'

== RoM bot Wiki Stuff ==
* [[RoM Waypoint files|Waypoint files]] - All you need to know about waypoint files

RoM Functions

2011-08-08T13:53:05Z

Pumbatoo: /* Waypoint File Functions */ Added __WPL:getFileName() description

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

changeProfileSkill(_skill, _option, _value)
Change a profile skill option and print a message in the micromacro window. Especially useful for skill options that don't normally change and can't be changed in the skills section of the profile eg. CastTime or Cooldown.

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

getQuestStatus( _questname )
This will return the status of the quest. It will return 'complete' if the quest is completed and ready to be turned in, 'incomplete' if you have accepted the quest but haven't completed it yet and 'not accepted' if you have not accepted the quest. The use of this function requires that the ingamefunctions folder be installed in the games addon folder.

waitForLoadingScreen( [_maxWaitTime] )
Waits for the loading screen to appear then disappear. Used after starting a teleport, entering your house, loading a new character, etc. Basically after any action that would cause the loading screen to appear. Replaces the need to add an overly large yrest(nnnnn). If the optional argument _maxWaitTime is specified and that many seconds has passed without the loading screen appearing, then it will stop waiting and return 'false', else it will return 'true'.

distance(x1, z1, y1, x2, z2, y2)
distance(x1, z1, x2, z2)
Returns the distance between 2 points. Both forms of the command will work. If all 6 arguments are used then it will do a 3 dimensional calculation ie. will take into account the height of the points otherwise it will do a 2 dimensional calculation.

== Event Monitor Functions ==
EventMonitorStart(monitorName, event [,filter])
Tells the in-game-function's addon to start monitoring event "event" and saving them to a log under the name of "monitorName". "monitorName" is just a name to identify the event monitor. If a filter is included then only events that pass the filter will be saved.

eg.
EventMonitorStart("LeaderChat", "CHAT_MSG_PARTY",",,,MyLeaderName")
This will monitor party chat and save any events that have the word "MyLeaderName" in the 4th argument which happens to be the chat senders name.

EventMonitorStop(monitorName)
This will stop monitoring events for "monitorName" and remove any log entries under that name.

EventMonitorPause(monitorName)
This will pause the event monitor. It will not save any events under that name while paused. You can still retrieve the log entries saved under that name while it is paused.

EventMonitorResume(monitorName)
This will resume a paused monitor and start saving events again under that name.

local time, moreToCome, arg1, arg2, arg3, arg4, arg5, arg6 = EventMonitorCheck(monitorName[, returnFilter][, lastEntryOnly])
Use this to return data of an event saved under the name of "monitorName". This function only returns data of 1 event at a time. By default it returns the first log entry under this name and then deletes it from the log. You can use the returnFilter to only return the event arguments you are interested in. If you only want the latest event and are not interested in older events then you can set lastEntryOnly = true. Then only the last entry in the log under that name will be returned and all other entries will be erased.

The returned values are:

'''time''' - The time the event occurred. I used os.time() to get this value but rombots version of this command returns a different value so I'm not sure how you can use this but I thought it needed to be included. Maybe it can be changed to a better format in the future.

'''moreToCome''' - Is 'true' if there are more log entries under that name and 'false' if not. This would be useful to iterate though all the messages to collect them all.

'''arg1, arg2, ... argn''' - These are the arguments returned by the event. If no returnFilter was specified then all arguments will be returned. If the returnFilter was used then only the requested arguments will be returned in the order requested.

eg.
local time, moreToCome, name, msg = EventMonitorCheck("LeaderChat", "4,1")
This will return the next "LeaderChat" log entry. Note that I only want the 4th and 1st argument. The 4th argument is the sender and will be stored in the 'name' variable and the 1st argument is the message and will be stored in the 'msg' variable.

== Player Functions ==
player:harvest([id]);
Use 'player:harvest()' to scan that waypoint for a harvest node and harvest that ie. wood, herbs and ore. For backward compatibility you can use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id but you should use player:target_Object() instead as it has more options related to opening objects.
Note: 'player:harvest("test")' is no longer supported, use 'rom/getid.lua' instead.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

player:cast("skill"|skill);
This function accepts either a skill name (ie. "MAGE_FIREBALL") or a skill object (ie. settings.profile.skills["MAGE_FIREBALL"]). If the parameter is a string, it must be listed in the players' profile.

player:checkSkills(_only_friendly);
This will check all skills that the player has loaded in his profile for those that are appropriate to use. _only_friendly should be either true or false. If true, it will only use helpful skills, such as healing, even while in combat. This is generally ''not'' needed by the end-user.

player:checkPotions();
This is similar to player:checkSkills(). It will check if the player needs to use any potions and use them accordingly. This is generally ''not'' needed by the end-user.

player:hasBuff(_buffname);
This will return true if your player has the buff, false if not. Run player:updatebuffs() first if you need to be sure your buff list is up-to date.
Can also be used to check buffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasBuff("buffname") then
etc...

player:hasDebuff(_debuffname);
This will return true if your player has the debuff, false if not. Run player:updatebuffs() first if you need to be sure your debuff list is up-to date.
Can also be used to check debuffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasDebuff("debuffname") then
etc...

player:fight();
If the player has an enemy target, it will engage that target in combat. This is generally ''not'' needed by the end-user.

player:loot();
If the player has a dead enemy target, it will attempt to loot the corpse. This is generally ''not'' needed by the end-user.

player:lootAll();
Will attempt to loot all nearby lootable bodies. This is generally ''not'' needed by the end-user.

success, reason = player:moveTo(waypoint, ignoreCycleTargets);
This will attempt to move the player to the given waypoint. If ignoreCycleTarget is true, it will not attempt to target and engage nearby enemies while on the move. 'waypoint' may also be a unit (such as player.Target - to move to the player's target). If you have raw coordinates, such as 100,200 that you want to move to, use CWaypoint(100,200) for your 'waypoint'.

This function will return whether or not it was successful and, if unsuccessful, the reason. 'success' will either be true or false, and 'reason' will be WF_TARGET(we abandoned movement because we've got a target), WF_COMBAT(we abandoned movement because we entered combat [typically; pulled an aggressive monster]), WF_DIST(for some reason or other, we actually started moving away from the waypoint [slid down a hill?]), or WF_STUCK(got stuck on something in the terrain).

player:waitForAggro();
This function causes the player to stop and wait for a maximum of 5 seconds for aggressive enemies to engage in combat with the player. This is typically not needed by the end-user.

player:faceDirection(angle);
This will rotate the character to face the specified direction in ''radians''('''not''' degrees!). This is typically not needed by the end-user.

player:turnDirection(angle);
This will rotate the character some amount rather than face a specific direction. If 'angle' is negative, the character will rotate 'left', and if 'angle' is positive, then the character will rotate 'right'. 'angle' should be specified in radians.

player:unstick();
Attempts to get the player out of being stuck on something. This is generally not needed by the end-user.

player:haveTarget();
Returns true if the player has a valid, attackable target.

player:update();
This causes the player to update all information (hp/mp/etc. from the game client). This should be used after causing the player to enter their home, teleport, log out and back in, etc.

player:clearTarget();
Causes the player to drop their current target.

player:isFriend(pawn);
Returns true if the given pawn (such as player.Pet or player.Target) are on the player's friend list inside their profile.

player:isInMobs(pawn);
Exactly like player:isFriend(), only it checks if the pawn is in the 'mobs' section of their profile.

player:logout(fc_shutdown);
Causes the player to attempt to log out of the game and, optionally, shut down their computer (if available). If fc_shutdown is true, it will attempt to shut down your computer after logging off.

player:findTarget();
Attempts to locate a nearby target, returning true if it does, otherwise false.

player:merchant(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. It will then buy, sell and repair based on the characters profile settings. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:openStore(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. You can then issue your own buy and/or sell commands. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:target_NPC(_npcname);
This will attempt to target a nearby NPC with the name given by '_npcname' but not interact with them.

player:target_Object(_objname, _waittime, _harvestall, _donotignore, _evalFunc);
This will target an object similarly to target_NPC but this function has more options to cater for the different behaviors of different objects.

_objname = name or id of object to target. Accepts partial names or a table of names and ids.(Required)

_waittime = time to wait if the object takes time to action, in ms. By default will wait until casting bar is gone. Only really necessary if you want it to wait longer than it takes to collect.(Optional)

_harvestall = true if you wish to collect all in the immediate area. Only use if the object disappears once collected. (Default is false ie. opens/collects only once)

_donotignore = If false, will target an object once then move onto the next object. If true, will continue to target object until it disappears or moves away. Only set to true if the target disappears or moves away or you might end up in an infinite loop.(if _harvestall = true then the default is false, else it is true).

_evalFunc = A user created custom function that can be used to evaluate whether objects are valid or not. Should except an address as an argument and return true or false. (Optional)

Examples:

'''player:target_Object ("Mailbox")''' -- Targets 'Mailbox' with no wait time afterward.

'''player:target_Object ("Ranch Hen", 8000)''' -- Encourage hen to lay then wait 8 seconds even though the cast bar only appears for a couple of seconds. Done only once.

'''player:target_Object ("Ranch Hen", nil, true, true)''' -- Feed all nearby hens, waiting until the cast bar ends. And do not ignore the current hen when searching for the next closest.

The example below targets all hens in the coop by checking their Z coordinate, with no ignoring.
<source lang="lua">-- The evaluate function
function henInCoop (address)
if CObject(address).Z > 3240 then
return true
else
return false
end
end

-- The target hen command
player:target_Object("Ranch Hen", nil, true, true, henInCoop);</source>

player:findNearestNameOrId(_objnameorid, _evalFunc)
Finds the nearest object without targeting it. Accepts the items name or id as argument or a table of items and ids to search for. Returns the closest objects table or nil if not found. For a description on how to use _evalFunc, please read the description for player:target_Object() above.

player:mount();
Finds the first ''permanent'' mount in your ''known inventory'' (typically slots 1-60; item shop bag not checked) and, if found, mounts it. You may also check if player.Mounted is true or false if you want to know whether the player is mounted or not. Will respond to aggro if mounting is interrupted but will still mount once aggro is dealt with.

== Inventory and Item Functions ==

inventory:itemTotalCount(itemNameOrId, range)
Get the total quantity of an item in your inventory. You can use the item-id or the name of the item. As a second argument you can specify where to look. Accepted values for ''range'' are; 'all', 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. By default it searches just the 'bags'.

example:
if( inventory:itemTotalCount(214536) > 25 ) then
loadPaths("deliver_quest");
end

inventory:getItemCount(itemNameOrId, range)
This function is obsolete. It is kept for backward compatibility. It is functionally the same as using inventory:itemTotalCount(itemNameOrId, range)

inventory:findItem(itemNameOrId, range)
Finds the first item in your inventory by name or id and returns the item object. If it is a stackable item it will return the smallest stack of that item. As a second argument you can specify where to look. Please consult the 'inventory:itemTotalCount' entry for excepted values for 'range'. By default it will search 'all' the inventory.

inventory:useItem(itemNameOrId)
Finds an item in the inventory by name or id then uses it.

inventory:getMainHandDurability()
Returns the durability of the main-hand weapon as a percent value from 1 to 100.

inventory:update()
Update the whole inventory from the games client.

inventory:storeBuyItem(nameIdOrIndex, quantity)
Buys 'quantity' of items from a store by name, id or store index. Assumes store is already open. If 'quantity' is not specified then it will buy 1 by default.

Examples:
inventory:storeBuyItem("Gold-wrapped Belt") -- Buy by item name
inventory:storeBuyItem(221544, 1) -- Buy by item id
inventory:storeBuyItem(3, 1) -- Buy by store index
All of these examples will do the same thing, buy 1 'Gold-wrapped Belt'.

item:moveTo(bag)
Moves the item to the specified bag. Accepted values for ''bag'' are; 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. If possible it will try to merge stackable items. This is particularly useful for moving itemshop items to the itemshop bag.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );
Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them.
Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

__WPL:setWaypointIndex( number);
Set the waypoint # 'number' as next waypoint to reach

__WPL:getNearestWaypoint(player.X, player.Z);
Get back the number of the closest waypoint.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

<source lang="lua">__WPL:getFileName();</source>Returns the name of the waypoint file as string (e.g. "l1t_start.xml"). The string will not contain any information about the path of the file.

== RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. For a complete list of RoM API functions, go to http://theromwiki.com/index.php/List_of_Functions

Here are some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

== User Functions ==
Since version r413 users are able to use a userfunctions.lua file in the Rombot root directory to hold all of their own custom functions.

If you find that you repeat a particular set of code in your waypoint files, you can create your own function with that code in the userfunctions.lua file and use it anywhere with a simple call to that function.

eg.
<source lang="lua">------------------------------------------------
-- CancelBuff Script
-- buffname = name of buff as appears in player buffs
-- returns 'true' if buff was removed or 'false' if did not have buff.
------------------------------------------------
function CancelBuff(buffname)
if buffname == nil then
cprintf(cli.yellow,"No buff specified. Please use 'CancelBuff(buffname)'.\n")
return false
end
local buffnum=1
local buff=RoMScript("UnitBuff('player',"..buffnum..")");
while buff ~= nil do
if buff == buffname then
sendMacro("CancelPlayerBuff("..buffnum..");")
return true
end
buffnum=buffnum+1
buff=RoMScript("UnitBuff('player',"..buffnum..")");
end
return false
end</source>
With this function in my userfunctions.lua file I can cancel a buff with a 1 line command. For example, every time I want to dismount my Brown Horse I use
<source lang="lua">CancelBuff("Brown Horse")</source>

To use, simply create a text file in the rombot root directory named userfunctions.lua and place your functions within it.

Some user created custom functions can be found here: [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1125 New Feature: Userfunctions.lua]

RoM Working with waypoint files

2011-08-08T13:40:09Z

Pumbatoo: /* List of functions */ Added __WPL:getFileName() description

Here some examples how to work with waypoint files. It shows examples for different types of waypoint files and some special solutions.

== LUA code within a waypoint file ==
You can use you own lua code within the <waypoint></waypoint> tags. By doing that you can do nearly everything. And there are some prefabricated functions:

To use some of that functions, simply put them into the waypoint tag:<source lang="xml"><waypoint x="799" z="-426">player:restrnd(20, 1, 10);</waypoint>
</source>

'''Caution!!! You must place the codes within the '<waypoint></waypoint>' tag. Not before and not after.'''

'''This is wrong:'''
<source lang="xml"><waypoints type="TRAVEL" >player:harvest();
<waypoint x="-2060" z="-8216"></waypoint>
</waypoints>
</source>

== List of functions ==

<source lang="lua">player:harvest();</source>Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground)

<source lang="lua">load_paths( [path] [,returnpath] );</source>Load a new waypoint file and if available the default return path to that file. e.g. 'load_paths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

<source lang="lua">if( player.Level > 9 ) then
printf("do some other coding stuff");
end;
</source>Do something only if you have a given level. Can be usefull to load a new waypoint file only after you get that level.

<source lang="lua">__WPL:reverse();</source>Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

<source lang="lua">__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );</source>Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them. Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

<source lang="lua">__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);</source>Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

<source lang="lua">player:restrnd([probability [, minrest [, maxrest]]]);</source>e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player.sleep()'.

<source lang="lua">player:rest( minrest [, maxrest[, time|full[, restaddrnd]]])</source>

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
_resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
_restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:<source lang="lua"><option name="HP_REST" value="15" />
<option name="MP_REST" value="15" /></source>
Default value if not defined is 15% each.

e.g.
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

<source lang="lua">stopPE();</source>Pause the bot at that waypoint. The bot will not react anymore. Press DEL if you want to resume the bot. Similar functions are 'player.restrnd()' and 'player.sleep()'.

<source lang="lua">player:sleep();</source>Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

<source lang="lua">player:logout([true])</source>Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

<source lang="lua">if( os.difftime(os.time(), player.BotStartTime) > 3600 ) then
printf("do some other coding stuff");
end;
</source>Do something, if the bot is running for more then 1 hour (= 3600 seconds). If you pause the bot, the BotStartTime will be reseted.

<source lang="lua">player:target_NPC( [npc_name] );</source>It will try to target the NPC 'npc_name' and open the dialog window. If it is a merchant and you have a ingame autorepair addon (e.g. [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]), it will autorepair.

<source lang="lua">player:mouseclickL(x, y [RoM window wide, RoM window high]);</source>Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

<source lang="lua">__WPL:getFileName();</source>Returns the name of the waypoint file as string (e.g. "l1t_start.xml"). The string will not contain any information about the path of the file.

== How to use the bot for running between the and NPC <-> blackboard for delivering of daily quests ==
It starts in Harf. There you have the quest 'Winterspinnenarten' from the blackboard where you deliver 10 winter spider body liquids to the 'Lager im Winternachttal'.

The waypoints are from the blackbard in Harf up to the camp. After each end of the waypoint file is a PAUSE. So you can handle with the NPC/blackboard and after that press 'DEL' to reverse the waypoints and run back.<source lang="xml"><waypoints type="RUN">
<waypoint x="-14389" z="-380" type="TRAVEL">__WPL:setDirection( WPT_FORWARD );
player:sleep();</waypoint>
<waypoint x="-14531" z="-253"></waypoint>
...
<waypoint x="-18500" z="-2516 type="TRAVEL" >__WPL:setDirection( WPT_BACKWARD );
player:sleep();
</waypoint>
</waypoints></source>
The type of the waypoints is 'RUN' so the bot will not stop and not fight back, if getting aggro. Only the first an the last WP has type TRAVEL to fight back still sticking mobs.

Some hints: If you deliver the quest with a low level char, than set your loot option (<option name="LOOT" value="true" />) in your profile to 'false'. That will prevent from coming closer to mob groups while looting. It also could be helpful, to reduce your option 'WAYPOINT_DEVIATION' or set it to 0 (and set back to a higher value for normal botting).

== Automatic leveling with the Bot ==
Thats an example how to start with level 1 and change the botting place depending from your level.

We start at the spawn point:<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>At the last waypoint, we load the waypoint path file 'l2-3.xml' and if available the default returnpath 'l2-3_return.xml" and go to the closest waypoint from that waypoint file. We use waypoint type TRAVEL to not targeting mobs while moving to our area (not really neccessary here :-) )

Now we are at that place:
<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-2206" z="-9648"></waypoint>
<waypoint x="-2133" z="-9796">player:restrnd(20, 1, 10);</waypoint>
<waypoint x="-2224" z="-9882">player:restrnd(20, 1, 10);</waypoint>
...
<waypoint x="-2391" z="-9639">
if( player.Level > 4 ) then
load_paths("l5_goto_6.xml");
end;
</waypoint>
</waypoints>
</source>
If we reach level 5, we load the next waypoint file. Read here for more Informations about [http://www.solarstrike.net/wiki/index.php5?title=RoM_Leveling automatic leveling]

Read here for further informations [http://www.solarstrike.net/wiki/index.php5?title=RoM_Auto_repair about autorepair].

RoM Functions

2011-08-08T08:43:38Z

Pumbatoo: /* Player Functions */ using <source lang="lua"> for code highlighting

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

changeProfileSkill(_skill, _option, _value)
Change a profile skill option and print a message in the micromacro window. Especially useful for skill options that don't normally change and can't be changed in the skills section of the profile eg. CastTime or Cooldown.

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

getQuestStatus( _questname )
This will return the status of the quest. It will return 'complete' if the quest is completed and ready to be turned in, 'incomplete' if you have accepted the quest but haven't completed it yet and 'not accepted' if you have not accepted the quest. The use of this function requires that the ingamefunctions folder be installed in the games addon folder.

waitForLoadingScreen( [_maxWaitTime] )
Waits for the loading screen to appear then disappear. Used after starting a teleport, entering your house, loading a new character, etc. Basically after any action that would cause the loading screen to appear. Replaces the need to add an overly large yrest(nnnnn). If the optional argument _maxWaitTime is specified and that many seconds has passed without the loading screen appearing, then it will stop waiting and return 'false', else it will return 'true'.

distance(x1, z1, y1, x2, z2, y2)
distance(x1, z1, x2, z2)
Returns the distance between 2 points. Both forms of the command will work. If all 6 arguments are used then it will do a 3 dimensional calculation ie. will take into account the height of the points otherwise it will do a 2 dimensional calculation.

== Event Monitor Functions ==
EventMonitorStart(monitorName, event [,filter])
Tells the in-game-function's addon to start monitoring event "event" and saving them to a log under the name of "monitorName". "monitorName" is just a name to identify the event monitor. If a filter is included then only events that pass the filter will be saved.

eg.
EventMonitorStart("LeaderChat", "CHAT_MSG_PARTY",",,,MyLeaderName")
This will monitor party chat and save any events that have the word "MyLeaderName" in the 4th argument which happens to be the chat senders name.

EventMonitorStop(monitorName)
This will stop monitoring events for "monitorName" and remove any log entries under that name.

EventMonitorPause(monitorName)
This will pause the event monitor. It will not save any events under that name while paused. You can still retrieve the log entries saved under that name while it is paused.

EventMonitorResume(monitorName)
This will resume a paused monitor and start saving events again under that name.

local time, moreToCome, arg1, arg2, arg3, arg4, arg5, arg6 = EventMonitorCheck(monitorName[, returnFilter][, lastEntryOnly])
Use this to return data of an event saved under the name of "monitorName". This function only returns data of 1 event at a time. By default it returns the first log entry under this name and then deletes it from the log. You can use the returnFilter to only return the event arguments you are interested in. If you only want the latest event and are not interested in older events then you can set lastEntryOnly = true. Then only the last entry in the log under that name will be returned and all other entries will be erased.

The returned values are:

'''time''' - The time the event occurred. I used os.time() to get this value but rombots version of this command returns a different value so I'm not sure how you can use this but I thought it needed to be included. Maybe it can be changed to a better format in the future.

'''moreToCome''' - Is 'true' if there are more log entries under that name and 'false' if not. This would be useful to iterate though all the messages to collect them all.

'''arg1, arg2, ... argn''' - These are the arguments returned by the event. If no returnFilter was specified then all arguments will be returned. If the returnFilter was used then only the requested arguments will be returned in the order requested.

eg.
local time, moreToCome, name, msg = EventMonitorCheck("LeaderChat", "4,1")
This will return the next "LeaderChat" log entry. Note that I only want the 4th and 1st argument. The 4th argument is the sender and will be stored in the 'name' variable and the 1st argument is the message and will be stored in the 'msg' variable.

== Player Functions ==
player:harvest([id]);
Use 'player:harvest()' to scan that waypoint for a harvest node and harvest that ie. wood, herbs and ore. For backward compatibility you can use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id but you should use player:target_Object() instead as it has more options related to opening objects.
Note: 'player:harvest("test")' is no longer supported, use 'rom/getid.lua' instead.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

player:cast("skill"|skill);
This function accepts either a skill name (ie. "MAGE_FIREBALL") or a skill object (ie. settings.profile.skills["MAGE_FIREBALL"]). If the parameter is a string, it must be listed in the players' profile.

player:checkSkills(_only_friendly);
This will check all skills that the player has loaded in his profile for those that are appropriate to use. _only_friendly should be either true or false. If true, it will only use helpful skills, such as healing, even while in combat. This is generally ''not'' needed by the end-user.

player:checkPotions();
This is similar to player:checkSkills(). It will check if the player needs to use any potions and use them accordingly. This is generally ''not'' needed by the end-user.

player:hasBuff(_buffname);
This will return true if your player has the buff, false if not. Run player:updatebuffs() first if you need to be sure your buff list is up-to date.
Can also be used to check buffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasBuff("buffname") then
etc...

player:hasDebuff(_debuffname);
This will return true if your player has the debuff, false if not. Run player:updatebuffs() first if you need to be sure your debuff list is up-to date.
Can also be used to check debuffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasDebuff("debuffname") then
etc...

player:fight();
If the player has an enemy target, it will engage that target in combat. This is generally ''not'' needed by the end-user.

player:loot();
If the player has a dead enemy target, it will attempt to loot the corpse. This is generally ''not'' needed by the end-user.

player:lootAll();
Will attempt to loot all nearby lootable bodies. This is generally ''not'' needed by the end-user.

success, reason = player:moveTo(waypoint, ignoreCycleTargets);
This will attempt to move the player to the given waypoint. If ignoreCycleTarget is true, it will not attempt to target and engage nearby enemies while on the move. 'waypoint' may also be a unit (such as player.Target - to move to the player's target). If you have raw coordinates, such as 100,200 that you want to move to, use CWaypoint(100,200) for your 'waypoint'.

This function will return whether or not it was successful and, if unsuccessful, the reason. 'success' will either be true or false, and 'reason' will be WF_TARGET(we abandoned movement because we've got a target), WF_COMBAT(we abandoned movement because we entered combat [typically; pulled an aggressive monster]), WF_DIST(for some reason or other, we actually started moving away from the waypoint [slid down a hill?]), or WF_STUCK(got stuck on something in the terrain).

player:waitForAggro();
This function causes the player to stop and wait for a maximum of 5 seconds for aggressive enemies to engage in combat with the player. This is typically not needed by the end-user.

player:faceDirection(angle);
This will rotate the character to face the specified direction in ''radians''('''not''' degrees!). This is typically not needed by the end-user.

player:turnDirection(angle);
This will rotate the character some amount rather than face a specific direction. If 'angle' is negative, the character will rotate 'left', and if 'angle' is positive, then the character will rotate 'right'. 'angle' should be specified in radians.

player:unstick();
Attempts to get the player out of being stuck on something. This is generally not needed by the end-user.

player:haveTarget();
Returns true if the player has a valid, attackable target.

player:update();
This causes the player to update all information (hp/mp/etc. from the game client). This should be used after causing the player to enter their home, teleport, log out and back in, etc.

player:clearTarget();
Causes the player to drop their current target.

player:isFriend(pawn);
Returns true if the given pawn (such as player.Pet or player.Target) are on the player's friend list inside their profile.

player:isInMobs(pawn);
Exactly like player:isFriend(), only it checks if the pawn is in the 'mobs' section of their profile.

player:logout(fc_shutdown);
Causes the player to attempt to log out of the game and, optionally, shut down their computer (if available). If fc_shutdown is true, it will attempt to shut down your computer after logging off.

player:findTarget();
Attempts to locate a nearby target, returning true if it does, otherwise false.

player:merchant(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. It will then buy, sell and repair based on the characters profile settings. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:openStore(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. You can then issue your own buy and/or sell commands. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:target_NPC(_npcname);
This will attempt to target a nearby NPC with the name given by '_npcname' but not interact with them.

player:target_Object(_objname, _waittime, _harvestall, _donotignore, _evalFunc);
This will target an object similarly to target_NPC but this function has more options to cater for the different behaviors of different objects.

_objname = name or id of object to target. Accepts partial names or a table of names and ids.(Required)

_waittime = time to wait if the object takes time to action, in ms. By default will wait until casting bar is gone. Only really necessary if you want it to wait longer than it takes to collect.(Optional)

_harvestall = true if you wish to collect all in the immediate area. Only use if the object disappears once collected. (Default is false ie. opens/collects only once)

_donotignore = If false, will target an object once then move onto the next object. If true, will continue to target object until it disappears or moves away. Only set to true if the target disappears or moves away or you might end up in an infinite loop.(if _harvestall = true then the default is false, else it is true).

_evalFunc = A user created custom function that can be used to evaluate whether objects are valid or not. Should except an address as an argument and return true or false. (Optional)

Examples:

'''player:target_Object ("Mailbox")''' -- Targets 'Mailbox' with no wait time afterward.

'''player:target_Object ("Ranch Hen", 8000)''' -- Encourage hen to lay then wait 8 seconds even though the cast bar only appears for a couple of seconds. Done only once.

'''player:target_Object ("Ranch Hen", nil, true, true)''' -- Feed all nearby hens, waiting until the cast bar ends. And do not ignore the current hen when searching for the next closest.

The example below targets all hens in the coop by checking their Z coordinate, with no ignoring.
<source lang="lua">-- The evaluate function
function henInCoop (address)
if CObject(address).Z > 3240 then
return true
else
return false
end
end

-- The target hen command
player:target_Object("Ranch Hen", nil, true, true, henInCoop);</source>

player:findNearestNameOrId(_objnameorid, _evalFunc)
Finds the nearest object without targeting it. Accepts the items name or id as argument or a table of items and ids to search for. Returns the closest objects table or nil if not found. For a description on how to use _evalFunc, please read the description for player:target_Object() above.

player:mount();
Finds the first ''permanent'' mount in your ''known inventory'' (typically slots 1-60; item shop bag not checked) and, if found, mounts it. You may also check if player.Mounted is true or false if you want to know whether the player is mounted or not. Will respond to aggro if mounting is interrupted but will still mount once aggro is dealt with.

== Inventory and Item Functions ==

inventory:itemTotalCount(itemNameOrId, range)
Get the total quantity of an item in your inventory. You can use the item-id or the name of the item. As a second argument you can specify where to look. Accepted values for ''range'' are; 'all', 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. By default it searches just the 'bags'.

example:
if( inventory:itemTotalCount(214536) > 25 ) then
loadPaths("deliver_quest");
end

inventory:getItemCount(itemNameOrId, range)
This function is obsolete. It is kept for backward compatibility. It is functionally the same as using inventory:itemTotalCount(itemNameOrId, range)

inventory:findItem(itemNameOrId, range)
Finds the first item in your inventory by name or id and returns the item object. If it is a stackable item it will return the smallest stack of that item. As a second argument you can specify where to look. Please consult the 'inventory:itemTotalCount' entry for excepted values for 'range'. By default it will search 'all' the inventory.

inventory:useItem(itemNameOrId)
Finds an item in the inventory by name or id then uses it.

inventory:getMainHandDurability()
Returns the durability of the main-hand weapon as a percent value from 1 to 100.

inventory:update()
Update the whole inventory from the games client.

inventory:storeBuyItem(nameIdOrIndex, quantity)
Buys 'quantity' of items from a store by name, id or store index. Assumes store is already open. If 'quantity' is not specified then it will buy 1 by default.

Examples:
inventory:storeBuyItem("Gold-wrapped Belt") -- Buy by item name
inventory:storeBuyItem(221544, 1) -- Buy by item id
inventory:storeBuyItem(3, 1) -- Buy by store index
All of these examples will do the same thing, buy 1 'Gold-wrapped Belt'.

item:moveTo(bag)
Moves the item to the specified bag. Accepted values for ''bag'' are; 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. If possible it will try to merge stackable items. This is particularly useful for moving itemshop items to the itemshop bag.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );
Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them.
Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

__WPL:setWaypointIndex( number);
Set the waypoint # 'number' as next waypoint to reach

__WPL:getNearestWaypoint(player.X, player.Z);
Get back the number of the closest waypoint.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. For a complete list of RoM API functions, go to http://theromwiki.com/index.php/List_of_Functions

Here are some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

== User Functions ==
Since version r413 users are able to use a userfunctions.lua file in the Rombot root directory to hold all of their own custom functions.

If you find that you repeat a particular set of code in your waypoint files, you can create your own function with that code in the userfunctions.lua file and use it anywhere with a simple call to that function.

eg.
<source lang="lua">------------------------------------------------
-- CancelBuff Script
-- buffname = name of buff as appears in player buffs
-- returns 'true' if buff was removed or 'false' if did not have buff.
------------------------------------------------
function CancelBuff(buffname)
if buffname == nil then
cprintf(cli.yellow,"No buff specified. Please use 'CancelBuff(buffname)'.\n")
return false
end
local buffnum=1
local buff=RoMScript("UnitBuff('player',"..buffnum..")");
while buff ~= nil do
if buff == buffname then
sendMacro("CancelPlayerBuff("..buffnum..");")
return true
end
buffnum=buffnum+1
buff=RoMScript("UnitBuff('player',"..buffnum..")");
end
return false
end</source>
With this function in my userfunctions.lua file I can cancel a buff with a 1 line command. For example, every time I want to dismount my Brown Horse I use
<source lang="lua">CancelBuff("Brown Horse")</source>

To use, simply create a text file in the rombot root directory named userfunctions.lua and place your functions within it.

Some user created custom functions can be found here: [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1125 New Feature: Userfunctions.lua]

RoM Working with waypoint files

2011-08-08T08:33:08Z

Pumbatoo: /* How to use the bot for running between the and NPC blackboard for delivering of daily quests */ replaced __WPL:reverse() by __WPL:setDirection(..)

Here some examples how to work with waypoint files. It shows examples for different types of waypoint files and some special solutions.

== LUA code within a waypoint file ==
You can use you own lua code within the <waypoint></waypoint> tags. By doing that you can do nearly everything. And there are some prefabricated functions:

To use some of that functions, simply put them into the waypoint tag:<source lang="xml"><waypoint x="799" z="-426">player:restrnd(20, 1, 10);</waypoint>
</source>

'''Caution!!! You must place the codes within the '<waypoint></waypoint>' tag. Not before and not after.'''

'''This is wrong:'''
<source lang="xml"><waypoints type="TRAVEL" >player:harvest();
<waypoint x="-2060" z="-8216"></waypoint>
</waypoints>
</source>

== List of functions ==

<source lang="lua">player:harvest();</source>Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground)

<source lang="lua">load_paths( [path] [,returnpath] );</source>Load a new waypoint file and if available the default return path to that file. e.g. 'load_paths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

<source lang="lua">if( player.Level > 9 ) then
printf("do some other coding stuff");
end;
</source>Do something only if you have a given level. Can be usefull to load a new waypoint file only after you get that level.

<source lang="lua">__WPL:reverse();</source>Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

<source lang="lua">__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );</source>Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them. Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

<source lang="lua">__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);</source>Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

<source lang="lua">player:restrnd([probability [, minrest [, maxrest]]]);</source>e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player.sleep()'.

<source lang="lua">player:rest( minrest [, maxrest[, time|full[, restaddrnd]]])</source>

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
_resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
_restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:<source lang="lua"><option name="HP_REST" value="15" />
<option name="MP_REST" value="15" /></source>
Default value if not defined is 15% each.

e.g.
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

<source lang="lua">stopPE();</source>Pause the bot at that waypoint. The bot will not react anymore. Press DEL if you want to resume the bot. Similar functions are 'player.restrnd()' and 'player.sleep()'.

<source lang="lua">player:sleep();</source>Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

<source lang="lua">player:logout([true])</source>Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

<source lang="lua">if( os.difftime(os.time(), player.BotStartTime) > 3600 ) then
printf("do some other coding stuff");
end;
</source>Do something, if the bot is running for more then 1 hour (= 3600 seconds). If you pause the bot, the BotStartTime will be reseted.

<source lang="lua">player:target_NPC( [npc_name] );</source>It will try to target the NPC 'npc_name' and open the dialog window. If it is a merchant and you have a ingame autorepair addon (e.g. [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]), it will autorepair.

<source lang="lua">player:mouseclickL(x, y [RoM window wide, RoM window high]);</source>Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== How to use the bot for running between the and NPC <-> blackboard for delivering of daily quests ==
It starts in Harf. There you have the quest 'Winterspinnenarten' from the blackboard where you deliver 10 winter spider body liquids to the 'Lager im Winternachttal'.

The waypoints are from the blackbard in Harf up to the camp. After each end of the waypoint file is a PAUSE. So you can handle with the NPC/blackboard and after that press 'DEL' to reverse the waypoints and run back.<source lang="xml"><waypoints type="RUN">
<waypoint x="-14389" z="-380" type="TRAVEL">__WPL:setDirection( WPT_FORWARD );
player:sleep();</waypoint>
<waypoint x="-14531" z="-253"></waypoint>
...
<waypoint x="-18500" z="-2516 type="TRAVEL" >__WPL:setDirection( WPT_BACKWARD );
player:sleep();
</waypoint>
</waypoints></source>
The type of the waypoints is 'RUN' so the bot will not stop and not fight back, if getting aggro. Only the first an the last WP has type TRAVEL to fight back still sticking mobs.

Some hints: If you deliver the quest with a low level char, than set your loot option (<option name="LOOT" value="true" />) in your profile to 'false'. That will prevent from coming closer to mob groups while looting. It also could be helpful, to reduce your option 'WAYPOINT_DEVIATION' or set it to 0 (and set back to a higher value for normal botting).

== Automatic leveling with the Bot ==
Thats an example how to start with level 1 and change the botting place depending from your level.

We start at the spawn point:<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>At the last waypoint, we load the waypoint path file 'l2-3.xml' and if available the default returnpath 'l2-3_return.xml" and go to the closest waypoint from that waypoint file. We use waypoint type TRAVEL to not targeting mobs while moving to our area (not really neccessary here :-) )

Now we are at that place:
<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-2206" z="-9648"></waypoint>
<waypoint x="-2133" z="-9796">player:restrnd(20, 1, 10);</waypoint>
<waypoint x="-2224" z="-9882">player:restrnd(20, 1, 10);</waypoint>
...
<waypoint x="-2391" z="-9639">
if( player.Level > 4 ) then
load_paths("l5_goto_6.xml");
end;
</waypoint>
</waypoints>
</source>
If we reach level 5, we load the next waypoint file. Read here for more Informations about [http://www.solarstrike.net/wiki/index.php5?title=RoM_Leveling automatic leveling]

Read here for further informations [http://www.solarstrike.net/wiki/index.php5?title=RoM_Auto_repair about autorepair].

RoM Working with waypoint files

2011-08-08T08:30:00Z

Pumbatoo: /* List of functions */ added function __WPL:setDirection(..)

Here some examples how to work with waypoint files. It shows examples for different types of waypoint files and some special solutions.

== LUA code within a waypoint file ==
You can use you own lua code within the <waypoint></waypoint> tags. By doing that you can do nearly everything. And there are some prefabricated functions:

To use some of that functions, simply put them into the waypoint tag:<source lang="xml"><waypoint x="799" z="-426">player:restrnd(20, 1, 10);</waypoint>
</source>

'''Caution!!! You must place the codes within the '<waypoint></waypoint>' tag. Not before and not after.'''

'''This is wrong:'''
<source lang="xml"><waypoints type="TRAVEL" >player:harvest();
<waypoint x="-2060" z="-8216"></waypoint>
</waypoints>
</source>

== List of functions ==

<source lang="lua">player:harvest();</source>Scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground)

<source lang="lua">load_paths( [path] [,returnpath] );</source>Load a new waypoint file and if available the default return path to that file. e.g. 'load_paths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

<source lang="lua">if( player.Level > 9 ) then
printf("do some other coding stuff");
end;
</source>Do something only if you have a given level. Can be usefull to load a new waypoint file only after you get that level.

<source lang="lua">__WPL:reverse();</source>Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

<source lang="lua">__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );</source>Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them. Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

<source lang="lua">__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);</source>Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

<source lang="lua">player:restrnd([probability [, minrest [, maxrest]]]);</source>e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player.sleep()'.

<source lang="lua">player:rest( minrest [, maxrest[, time|full[, restaddrnd]]])</source>

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
_resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
_restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:<source lang="lua"><option name="HP_REST" value="15" />
<option name="MP_REST" value="15" /></source>
Default value if not defined is 15% each.

e.g.
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

<source lang="lua">stopPE();</source>Pause the bot at that waypoint. The bot will not react anymore. Press DEL if you want to resume the bot. Similar functions are 'player.restrnd()' and 'player.sleep()'.

<source lang="lua">player:sleep();</source>Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

<source lang="lua">player:logout([true])</source>Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

<source lang="lua">if( os.difftime(os.time(), player.BotStartTime) > 3600 ) then
printf("do some other coding stuff");
end;
</source>Do something, if the bot is running for more then 1 hour (= 3600 seconds). If you pause the bot, the BotStartTime will be reseted.

<source lang="lua">player:target_NPC( [npc_name] );</source>It will try to target the NPC 'npc_name' and open the dialog window. If it is a merchant and you have a ingame autorepair addon (e.g. [http://rom.curse.com/downloads/rom-addons/details/streamline.aspx Streamline]), it will autorepair.

<source lang="lua">player:mouseclickL(x, y [RoM window wide, RoM window high]);</source>Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

== How to use the bot for running between the and NPC <-> blackboard for delivering of daily quests ==
It starts in Harf. There you have the quest 'Winterspinnenarten' from the blackboard where you deliver 10 winter spider body liquids to the 'Lager im Winternachttal'.

The waypoints are from the blackbard in Harf up to the camp. After each end of the waypoint file is a PAUSE. So you can handle with the NPC/blackboard and after that press 'DEL' to reverse the waypoints and run back.<source lang="xml"><waypoints type="RUN">
<waypoint x="-14389" z="-380" type="TRAVEL">__WPL:reverse();
player:sleep();</waypoint>
<waypoint x="-14531" z="-253"></waypoint>
...
<waypoint x="-18500" z="-2516 type="TRAVEL" >__WPL:reverse();
player:sleep();
</waypoint>
</waypoints></source>
The type of the waypoints is 'RUN' so the bot will not stop and not fight back, if getting aggro. Only the first an the last WP has type TRAVEL to fight back still sticking mobs.

Some hints: If you deliver the quest with a low level char, than set your loot option (<option name="LOOT" value="true" />) in your profile to 'false'. That will prevent from coming closer to mob groups while looting. It also could be helpful, to reduce your option 'WAYPOINT_DEVIATION' or set it to 0 (and set back to a higher value for normal botting).

== Automatic leveling with the Bot ==
Thats an example how to start with level 1 and change the botting place depending from your level.

We start at the spawn point:<source lang="xml"><waypoints type="TRAVEL" >
<waypoint x="-3779" z="-8480"></waypoint>
...
<waypoint x="-3034" z="-9034">load_paths("l2-3.xml");</waypoint>
</waypoints></source>At the last waypoint, we load the waypoint path file 'l2-3.xml' and if available the default returnpath 'l2-3_return.xml" and go to the closest waypoint from that waypoint file. We use waypoint type TRAVEL to not targeting mobs while moving to our area (not really neccessary here :-) )

Now we are at that place:
<source lang="xml"><waypoints type="NORMAL" >
<waypoint x="-2206" z="-9648"></waypoint>
<waypoint x="-2133" z="-9796">player:restrnd(20, 1, 10);</waypoint>
<waypoint x="-2224" z="-9882">player:restrnd(20, 1, 10);</waypoint>
...
<waypoint x="-2391" z="-9639">
if( player.Level > 4 ) then
load_paths("l5_goto_6.xml");
end;
</waypoint>
</waypoints>
</source>
If we reach level 5, we load the next waypoint file. Read here for more Informations about [http://www.solarstrike.net/wiki/index.php5?title=RoM_Leveling automatic leveling]

Read here for further informations [http://www.solarstrike.net/wiki/index.php5?title=RoM_Auto_repair about autorepair].

RoM Functions

2011-08-08T08:16:48Z

Pumbatoo: /* Waypoint File Functions */ added function __WPL:setDirection(..)

== General Functions ==
loadPaths( [path] [,returnpath] );
Load a new waypoint file and if available the default return path to that file. e.g. 'loadPaths("l7-9");' will load the waypoint path 'l7-9.xml' and if available the return path 'l7-9_return.xml'.

changeProfileOption(_option, _value);
change profile options and print values in MM protocol

changeProfileSkill(_skill, _option, _value)
Change a profile skill option and print a message in the micromacro window. Especially useful for skill options that don't normally change and can't be changed in the skills section of the profile eg. CastTime or Cooldown.

levelupSkill(_skillname [, _times] )

Levelup a Single Skill by Name. For the skillname look into the file /database/skills.xml. You can use that function only for skill, which have maintent the skilltab and skillnum values within the skills.xml entry. If the don't have that values, please look yourself for them and use the manual way.

levelupSkills1To10( ["loadonly"] );

That function will levelup a internal given selection of useful skills on your way from 1-10. The selection of the skills is hard coded within functions.lua. That function will also load the skill into your profile skill list and use that skill via the MACRO function. If you restart the bot and want also want to use that skills and don't want to enter them manual into the profile skill list, then just use that function with the parameter 'loadonly' within the onLoad event:

openGiftbags1To10( [[_player_level] , _maxslot] );
open the level 1-10 giftbags and equipt the items.

addMessage( message );
Send a message to the ingame system chat channel.

<source lang="lua">RoMScript( _script );

example:
local ret1, ret2 = RoMScript( "GetPlayerWorldMapPos();" );</source>
Send a macro to the client and execute it ingame by pressing the MACRO hotkey. There are up to 10 return values possible.

sendMacro( _script );
Same as "RoMScript. Additionally you will see a message in the MM window.

getQuestStatus( _questname )
This will return the status of the quest. It will return 'complete' if the quest is completed and ready to be turned in, 'incomplete' if you have accepted the quest but haven't completed it yet and 'not accepted' if you have not accepted the quest. The use of this function requires that the ingamefunctions folder be installed in the games addon folder.

waitForLoadingScreen( [_maxWaitTime] )
Waits for the loading screen to appear then disappear. Used after starting a teleport, entering your house, loading a new character, etc. Basically after any action that would cause the loading screen to appear. Replaces the need to add an overly large yrest(nnnnn). If the optional argument _maxWaitTime is specified and that many seconds has passed without the loading screen appearing, then it will stop waiting and return 'false', else it will return 'true'.

distance(x1, z1, y1, x2, z2, y2)
distance(x1, z1, x2, z2)
Returns the distance between 2 points. Both forms of the command will work. If all 6 arguments are used then it will do a 3 dimensional calculation ie. will take into account the height of the points otherwise it will do a 2 dimensional calculation.

== Event Monitor Functions ==
EventMonitorStart(monitorName, event [,filter])
Tells the in-game-function's addon to start monitoring event "event" and saving them to a log under the name of "monitorName". "monitorName" is just a name to identify the event monitor. If a filter is included then only events that pass the filter will be saved.

eg.
EventMonitorStart("LeaderChat", "CHAT_MSG_PARTY",",,,MyLeaderName")
This will monitor party chat and save any events that have the word "MyLeaderName" in the 4th argument which happens to be the chat senders name.

EventMonitorStop(monitorName)
This will stop monitoring events for "monitorName" and remove any log entries under that name.

EventMonitorPause(monitorName)
This will pause the event monitor. It will not save any events under that name while paused. You can still retrieve the log entries saved under that name while it is paused.

EventMonitorResume(monitorName)
This will resume a paused monitor and start saving events again under that name.

local time, moreToCome, arg1, arg2, arg3, arg4, arg5, arg6 = EventMonitorCheck(monitorName[, returnFilter][, lastEntryOnly])
Use this to return data of an event saved under the name of "monitorName". This function only returns data of 1 event at a time. By default it returns the first log entry under this name and then deletes it from the log. You can use the returnFilter to only return the event arguments you are interested in. If you only want the latest event and are not interested in older events then you can set lastEntryOnly = true. Then only the last entry in the log under that name will be returned and all other entries will be erased.

The returned values are:

'''time''' - The time the event occurred. I used os.time() to get this value but rombots version of this command returns a different value so I'm not sure how you can use this but I thought it needed to be included. Maybe it can be changed to a better format in the future.

'''moreToCome''' - Is 'true' if there are more log entries under that name and 'false' if not. This would be useful to iterate though all the messages to collect them all.

'''arg1, arg2, ... argn''' - These are the arguments returned by the event. If no returnFilter was specified then all arguments will be returned. If the returnFilter was used then only the requested arguments will be returned in the order requested.

eg.
local time, moreToCome, name, msg = EventMonitorCheck("LeaderChat", "4,1")
This will return the next "LeaderChat" log entry. Note that I only want the 4th and 1st argument. The 4th argument is the sender and will be stored in the 'name' variable and the 1st argument is the message and will be stored in the 'msg' variable.

== Player Functions ==
player:harvest([id]);
Use 'player:harvest()' to scan that waypoint for a harvest node and harvest that ie. wood, herbs and ore. For backward compatibility you can use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id but you should use player:target_Object() instead as it has more options related to opening objects.
Note: 'player:harvest("test")' is no longer supported, use 'rom/getid.lua' instead.

player:restrnd([probability [, minrest [, maxrest]]]);
e.g. 'player:restrnd(30, 3, 10);' Rest with a probability from 30% at that waypoint for between 3 and 10 seconds. The bot will fight back if attacked while resting and continue after that. Similar functions are 'stopPE()' and 'player:sleep()'.

player:rest( minrest [, maxrest[, time|full[, restaddrnd]]]);

minrest ( min time to rest in sec)
maxrest ( max time to in sec)
resttype ( time | full ) time = rest the given time | full = stop resting after being full / default = time
restaddrnd ( max random addition after being full in sec)

If using type 'full', the bot will only rest if HP or MP is below a defined level. You define that level in your profile with the options:
Code:
<option name="HP_REST" value="15" />
<option name="MP_REST" value="15" />

Default value if not defined is 15% each.

examples:
player:rest(20) will rest for 20 seconds.
player:rest(60, 20) will rest between 60 and 80 seconds.
player:rest(90, 40, "full") will rest up to between 90 and 130 seconds, and stop resting if being full
player:rest(90, 40, "time") will rest up to between 90 and 130 seconds, and not stop resting if being full
player:rest(20, 40, "full, 20") will rest up to between 20 and 60 seconds, and stop resting if being full, and wait after that between 1-20 seconds

player:sleep();
Pause the bot at that waypoint in a sleep mode. The bot will still fight back attackers and sleep again after doing that. Press DEL if you want to continue. Similar functions are 'player.restrnd()' and 'stopPE()'.

player:logout([true]);
Logout from RoM. With 'player:logout(true)' you will also shutdown your pc after loging out.

player:mouseclickL(x, y [RoM window wide, RoM window high]);
Left click a screen point and by that, interact with a NPC. x, y is relative to the RoM window. So it is your fiddly task to find the right values to click the right buttons. Remember the RoM windows size for that click positions. By doing that, we can later recalculate the mouse click points if we run the bot in a different RoM windows size.

player:cast("skill"|skill);
This function accepts either a skill name (ie. "MAGE_FIREBALL") or a skill object (ie. settings.profile.skills["MAGE_FIREBALL"]). If the parameter is a string, it must be listed in the players' profile.

player:checkSkills(_only_friendly);
This will check all skills that the player has loaded in his profile for those that are appropriate to use. _only_friendly should be either true or false. If true, it will only use helpful skills, such as healing, even while in combat. This is generally ''not'' needed by the end-user.

player:checkPotions();
This is similar to player:checkSkills(). It will check if the player needs to use any potions and use them accordingly. This is generally ''not'' needed by the end-user.

player:hasBuff(_buffname);
This will return true if your player has the buff, false if not. Run player:updatebuffs() first if you need to be sure your buff list is up-to date.
Can also be used to check buffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasBuff("buffname") then
etc...

player:hasDebuff(_debuffname);
This will return true if your player has the debuff, false if not. Run player:updatebuffs() first if you need to be sure your debuff list is up-to date.
Can also be used to check debuffs on target. You may need to create the target object first.
For example:
local target = player:getTarget();
target:updateBuffs()
if target:hasDebuff("debuffname") then
etc...

player:fight();
If the player has an enemy target, it will engage that target in combat. This is generally ''not'' needed by the end-user.

player:loot();
If the player has a dead enemy target, it will attempt to loot the corpse. This is generally ''not'' needed by the end-user.

player:lootAll();
Will attempt to loot all nearby lootable bodies. This is generally ''not'' needed by the end-user.

success, reason = player:moveTo(waypoint, ignoreCycleTargets);
This will attempt to move the player to the given waypoint. If ignoreCycleTarget is true, it will not attempt to target and engage nearby enemies while on the move. 'waypoint' may also be a unit (such as player.Target - to move to the player's target). If you have raw coordinates, such as 100,200 that you want to move to, use CWaypoint(100,200) for your 'waypoint'.

This function will return whether or not it was successful and, if unsuccessful, the reason. 'success' will either be true or false, and 'reason' will be WF_TARGET(we abandoned movement because we've got a target), WF_COMBAT(we abandoned movement because we entered combat [typically; pulled an aggressive monster]), WF_DIST(for some reason or other, we actually started moving away from the waypoint [slid down a hill?]), or WF_STUCK(got stuck on something in the terrain).

player:waitForAggro();
This function causes the player to stop and wait for a maximum of 5 seconds for aggressive enemies to engage in combat with the player. This is typically not needed by the end-user.

player:faceDirection(angle);
This will rotate the character to face the specified direction in ''radians''('''not''' degrees!). This is typically not needed by the end-user.

player:turnDirection(angle);
This will rotate the character some amount rather than face a specific direction. If 'angle' is negative, the character will rotate 'left', and if 'angle' is positive, then the character will rotate 'right'. 'angle' should be specified in radians.

player:unstick();
Attempts to get the player out of being stuck on something. This is generally not needed by the end-user.

player:haveTarget();
Returns true if the player has a valid, attackable target.

player:update();
This causes the player to update all information (hp/mp/etc. from the game client). This should be used after causing the player to enter their home, teleport, log out and back in, etc.

player:clearTarget();
Causes the player to drop their current target.

player:isFriend(pawn);
Returns true if the given pawn (such as player.Pet or player.Target) are on the player's friend list inside their profile.

player:isInMobs(pawn);
Exactly like player:isFriend(), only it checks if the pawn is in the 'mobs' section of their profile.

player:logout(fc_shutdown);
Causes the player to attempt to log out of the game and, optionally, shut down their computer (if available). If fc_shutdown is true, it will attempt to shut down your computer after logging off.

player:findTarget();
Attempts to locate a nearby target, returning true if it does, otherwise false.

player:merchant(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. It will then buy, sell and repair based on the characters profile settings. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:openStore(_npcname, _option);
Attempts to open the store of a nearby NPC with the name given by '_npcname'. You can then issue your own buy and/or sell commands. If the 'open shop' option is not the first in the npc dialog, eg. house npcs, you can specify which option it is in the second argument '_option'. '_option' is optional and will default to 1 which is correct for most merchants.

player:target_NPC(_npcname);
This will attempt to target a nearby NPC with the name given by '_npcname' but not interact with them.

player:target_Object(_objname, _waittime, _harvestall, _donotignore, _evalFunc);
This will target an object similarly to target_NPC but this function has more options to cater for the different behaviors of different objects.

_objname = name or id of object to target. Accepts partial names or a table of names and ids.(Required)

_waittime = time to wait if the object takes time to action, in ms. By default will wait until casting bar is gone. Only really necessary if you want it to wait longer than it takes to collect.(Optional)

_harvestall = true if you wish to collect all in the immediate area. Only use if the object disappears once collected. (Default is false ie. opens/collects only once)

_donotignore = If false, will target an object once then move onto the next object. If true, will continue to target object until it disappears or moves away. Only set to true if the target disappears or moves away or you might end up in an infinite loop.(if _harvestall = true then the default is false, else it is true).

_evalFunc = A user created custom function that can be used to evaluate whether objects are valid or not. Should except an address as an argument and return true or false. (Optional)

Examples:

'''player:target_Object ("Mailbox")''' -- Targets 'Mailbox' with no wait time afterward.

'''player:target_Object ("Ranch Hen", 8000)''' -- Encourage hen to lay then wait 8 seconds even though the cast bar only appears for a couple of seconds. Done only once.

'''player:target_Object ("Ranch Hen", nil, true, true)''' -- Feed all nearby hens, waiting until the cast bar ends. And do not ignore the current hen when searching for the next closest.

The example below targets all hens in the coop by checking their Z value, with no ignoring.
-- The evaluate function
function henInCoop (address)
if CObject(address).Z > 3240 then
return true
else
return false
end
end

-- The target hen command
player:target_Object("Ranch Hen", nil, true, true, henInCoop)

player:findNearestNameOrId(_objnameorid, _evalFunc)
Finds the nearest object without targeting it. Accepts the items name or id as argument or a table of items and ids to search for. Returns the closest objects table or nil if not found. For a description on how to use _evalFunc, please read the description for player:target_Object() above.

player:mount();
Finds the first ''permanent'' mount in your ''known inventory'' (typically slots 1-60; item shop bag not checked) and, if found, mounts it. You may also check if player.Mounted is true or false if you want to know whether the player is mounted or not. Will respond to aggro if mounting is interrupted but will still mount once aggro is dealt with.

== Inventory and Item Functions ==

inventory:itemTotalCount(itemNameOrId, range)
Get the total quantity of an item in your inventory. You can use the item-id or the name of the item. As a second argument you can specify where to look. Accepted values for ''range'' are; 'all', 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. By default it searches just the 'bags'.

example:
if( inventory:itemTotalCount(214536) > 25 ) then
loadPaths("deliver_quest");
end

inventory:getItemCount(itemNameOrId, range)
This function is obsolete. It is kept for backward compatibility. It is functionally the same as using inventory:itemTotalCount(itemNameOrId, range)

inventory:findItem(itemNameOrId, range)
Finds the first item in your inventory by name or id and returns the item object. If it is a stackable item it will return the smallest stack of that item. As a second argument you can specify where to look. Please consult the 'inventory:itemTotalCount' entry for excepted values for 'range'. By default it will search 'all' the inventory.

inventory:useItem(itemNameOrId)
Finds an item in the inventory by name or id then uses it.

inventory:getMainHandDurability()
Returns the durability of the main-hand weapon as a percent value from 1 to 100.

inventory:update()
Update the whole inventory from the games client.

inventory:storeBuyItem(nameIdOrIndex, quantity)
Buys 'quantity' of items from a store by name, id or store index. Assumes store is already open. If 'quantity' is not specified then it will buy 1 by default.

Examples:
inventory:storeBuyItem("Gold-wrapped Belt") -- Buy by item name
inventory:storeBuyItem(221544, 1) -- Buy by item id
inventory:storeBuyItem(3, 1) -- Buy by store index
All of these examples will do the same thing, buy 1 'Gold-wrapped Belt'.

item:moveTo(bag)
Moves the item to the specified bag. Accepted values for ''bag'' are; 'bags', 'bag1', 'bag2', 'bag3', 'bag4', 'bag5', 'bag6', 'magicbox' and 'itemshop'. If possible it will try to merge stackable items. This is particularly useful for moving itemshop items to the itemshop bag.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is strongly recommended to use '__WPL:setDirection(..)' instead of this function.

__WPL:setDirection( [WPT_FORWARD | WPT_BACKWARD] );
Set the direction in which order the waypoints should be proccessed. It is usefull to put that at the first and at the last waypoint if you want to run between two places. Remember to use WPT_FORWARD at the first and WPT_BACKWARD at the last waypoint to run between them.
Use this instead of '__WPL:reverse()' to avoid problems in your waypoint file.

__WPL:setWaypointIndex( number);
Set the waypoint # 'number' as next waypoint to reach

__WPL:getNearestWaypoint(player.X, player.Z);
Get back the number of the closest waypoint.

__WPL:setForcedWaypointType( [["NORMAL"] | ["TRAVEL"] | ["RUN"]]);
Set a forced waypoint type. The waypoint type overwrites the type settings within the waypoint file. The forced waypoint type is valid until you load a new waypoint file or you call the function '__WPL:setForcedWaypointType();' without argument.

== RoM API Functions ==
With the function sendMacro() or RoMScript() we can submit macros to the RoM API. For a complete list of RoM API functions, go to http://theromwiki.com/index.php/List_of_Functions

Here are some important API functions you can use:

sendMacro("SetSpellPoint( 4, 2 );");

Levelup a skill. First number is the tab (1=general, 2=general class skills, 4=only primary class skills). Second number is the number of the skill at the tab. You can test the numbers by entering following macro ingame:

<source lang="lua">/script _SkillName=GetSkillDetail(4,3); SendSystemChat(_SkillName);</source>That will print you the name of the given skill into the ingame system chat.

/script SendSystemChat(tonumber(string.sub(GetBagItemLink(GetBagItemInfo(1)), 8, 12), 16));
Print the itemid of slot-nr 1 into the system chat. Change the slot number to the item you want to get informations about or move that item to slot #1.

sendMacro("GetBagItemCount("..itemid..")")
Get back the quantity of an givem item ID in your bags.

occupiedSlots, totalSlots = sendMacro("GetBagCount();");
Get back the number of total slots in your bag and the number of the occupied slot in your bag.

== User Functions ==
Since version r413 users are able to use a userfunctions.lua file in the Rombot root directory to hold all of their own custom functions.

If you find that you repeat a particular set of code in your waypoint files, you can create your own function with that code in the userfunctions.lua file and use it anywhere with a simple call to that function.

eg.
<source lang="lua">------------------------------------------------
-- CancelBuff Script
-- buffname = name of buff as appears in player buffs
-- returns 'true' if buff was removed or 'false' if did not have buff.
------------------------------------------------
function CancelBuff(buffname)
if buffname == nil then
cprintf(cli.yellow,"No buff specified. Please use 'CancelBuff(buffname)'.\n")
return false
end
local buffnum=1
local buff=RoMScript("UnitBuff('player',"..buffnum..")");
while buff ~= nil do
if buff == buffname then
sendMacro("CancelPlayerBuff("..buffnum..");")
return true
end
buffnum=buffnum+1
buff=RoMScript("UnitBuff('player',"..buffnum..")");
end
return false
end</source>
With this function in my userfunctions.lua file I can cancel a buff with a 1 line command. For example, every time I want to dismount my Brown Horse I use
<source lang="lua">CancelBuff("Brown Horse")</source>

To use, simply create a text file in the rombot root directory named userfunctions.lua and place your functions within it.

Some user created custom functions can be found here: [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1125 New Feature: Userfunctions.lua]