== 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

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.

== 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.

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 target and interact with a nearby NPC with the name given by '_npcname'. This may be used for buying potions, arrows, and more. 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);
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.(Required)

_waittime = time to wait if the object takes time to action, in ms. (Optional, default is 0)

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

_donotignore = By default, when collecting multiple objects with the _harvestall option, the bot will ignore the current node when searching for the next nearest node so it can quickly move on to the next node while the current one is still disappearing. Set this option to 'true' if you don't want to ignore the current node because it requires more than 1 click to collect it. (Default is false).

Examples:

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

player:target_Object("Mysterious Mound",3000) -- Target then wait 3 seconds for search to end. Done only once.

player:target_Object("Ranch Hen", 8000, true, true) -- Feed all nearby hens, waiting 8s after each. And do not ignore the current hen when searching for the next closest.

player:findNearestNameOrId(_objnameorid)
Finds the nearest object without targeting it. Accepts the items name or id as argument. Returns the object table or nil if not found.

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.

== Inventory and Item Functions ==

inventory:getItemCount(itemId)

examples:
if( inventory:getItemCount(214536) > 25 ) then
loadPaths("deliver_quest");
end
Get the quantity for a item directly from the games client.

inventory:itemTotalCount(itemNameOrId)
Get the quantity for a item from the cached inventory. You have to be sure, that your inventory is up to date to get the right values. You can use the item-id or the name of the item

inventory:useItem(itemNameOrId)
Use a item from the cached inventory.

inventory:update()
Update the whole inventory from the games client. Depending from you slots, that takes about 10-15 seconds. Nevertheless from using that function, the bot updates the whole inventory at the bot starting time and about 3-4 slots after every fight and about 10-15 slots while the bot is looting.

By default the bot updates slot 1-60. If you want to use more slots please use the profile option
<option name="INV_MAX_SLOTS" value="120" /> 
Use the option
<option name="INV_MAX_SLOTS" value="0" /> 
if you want to deactivate the inventory update.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__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 Configuration

2010-08-28T17:16:56Z

203.219.213.111: /* Profile - Skills */

There are two main settings files for RoM bot: settings.xml and your profile.
Profiles contain character-specific settings, while settings.xml contains hotkey settings and general preferences.

== Settings.xml ==
Here is an example settings file:
<source lang="xml">
<settings>
<hotkeys>

<hotkey description="MOVE_FORWARD" key="VK_W" modifier="" />
<hotkey description="MOVE_BACKWARD" key="VK_S" modifier="" />
<hotkey description="ROTATE_LEFT" key="VK_A" modifier="" />
<hotkey description="ROTATE_RIGHT" key="VK_D" modifier="" />
<hotkey description="STRAFF_LEFT" key="VK_Q" modifier="" />
<hotkey description="STRAFF_RIGHT" key="VK_E" modifier="" />
<hotkey description="JUMP" key="VK_SPACE" modifier="" />

<hotkey description="TARGET" key="VK_TAB" modifier="" />
<hotkey description="TARGET_FRIEND" key="VK_J" modifier="" />
</hotkeys>

<options>
<option name="ENABLE_FIGHT_SLOW_TURN" value="false" />
<option name="MELEE_DISTANCE" value="45" />
<option name="LANGUAGE" value="english" />
<option name="DEBUGGING" value="true" />
</options>
</settings>
</source>

===Settings - Hotkeys===
The hotkey settings are mostly self-explanatory. MOVE_FORWARD, obviously, coresponds to the key that makes your character walk forward. This is "W" by default. Note that '''all''' keys must preceeded by 'VK_'.

You may also notice the 'modifier'. Modifiers are keys such as CONTROL, SHIFT, or ALT. However, be aware that modifiers currently '''do not work'''. You should not set modifiers or you may run into problems. Instead, just leave the modifier set to an empty string("").

If your Runes of Magic bindings file (By default, is located at 'My Documents/Runes of Magic/bindings.txt') can be found and loaded, the RoM bot will instead use these settings so that you will not need to manually change your hotkey settings.

===Settings - Options===
{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | ENABLE_FIGHT_SLOW_TURN
| style="border-bottom:1px dotted #000000;" | Allows you to enable or disable "slow turning" in combat. If you have click-to-move on, you should not need this. It should be set to either "true" or "false". The default is "false".
|-
| style="border-bottom:1px dotted #000000;" | MELEE_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance at which to conduct melee combat. A value of 45 is good and should not be changed unless you have problems with being either too close or too far away for melee combat. Default: "45".
|-
| style="border-bottom:1px dotted #000000;" | LANGUAGE
| style="border-bottom:1px dotted #000000;" | Allows you to set your prefered language. Acceptable values are "english", "deutsch", , "russian" and "french".
|-
| style="border-bottom:1px dotted #000000;" | USE_CLIENT_LANGUAGE
| style="border-bottom:1px dotted #000000;" | After loading the bot, we will automaticly use the game clients language as bot language.
|-
| style="border-bottom:1px dotted #000000;" | DEBUGGING
| style="border-bottom:1px dotted #000000;" | This is a debugging option. When set to true, it will instantly exit on memory read errors and provide better debugging information. Default: "false".
|}

== Character Profiles ==
There are a few things you should know about character profiles first:
* They typically are named after the character that will use them
* They must be inside the 'rom/profiles' folder
* They must follow proper XML formatting
* They may contain custom Lua code

There are many profile options that can be set so it is highly recommended you make a copy of the default profile (Default.xml) and modify that to your character's needs instead of starting from scratch.

'''If you have extension hiding turned off,''' the .xml extension will not show on any of your files. If this is the case, '''do not''' add the .xml extension or you will end up with a file named something like Default.xml.xml. This may cause the profile to not be found and you may get errors. However, if you are able to see extensions, you should of course include the .xml extension when naming your profile.

===Profile - Options===

<source lang="lua"><options>
<option name="HP_LOW" value="85" />
<option name="MP_LOW_POTION" value="50" />
<option name="HP_LOW_POTION" value="40" />
...
</source>

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Healing and Potions'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW
| style="border-bottom:1px dotted #000000;" | The percentage of health to use heal skills at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of health to use potions at
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW_POTION
| style="border-bottom:1px dotted #000000;" | The percentage of mana to use mana potions at
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Resting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HP_REST
| style="border-bottom:1px dotted #000000;" | If health falls below this percentage, then rest.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MP_LOW
| style="border-bottom:1px dotted #000000;" | If mana falls below this percentage, then rest.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Shopping options'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | HEALING_POTION
| style="border-bottom:1px dotted #000000;" | How many healing potions should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MANA_POTION
| style="border-bottom:1px dotted #000000;" | How many mana potions should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | ARROW_QUIVER
| style="border-bottom:1px dotted #000000;" | How many arrow quivers should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | THROWN_BAG
| style="border-bottom:1px dotted #000000;" | How many thrown bags should we have in the inventory after visiting a merchant.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | POISON
| style="border-bottom:1px dotted #000000;" | How many poison should we have in the inventory after visiting a merchant.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Ammunition reload'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RELOAD_AMMUNITION
| style="border-bottom:1px dotted #000000;" | Which kind of ammunition should we reload ( arrow | thrown | false) .
|}

{|
| style="background-color: #C0C0FF; text-align: center;" | '''Combat Options'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_TYPE
| style="border-bottom:1px dotted #000000;" | Either "melee" or "ranged". Whichever best fits your character. Default: empty string (""). When unset (default), it will determine this automatically based on your class. There is no need to change this.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_RANGED_PULL
| style="border-bottom:1px dotted #000000;" | Whether or not to attempt to "pull" enemies towards you with ranged skills while you are a melee-based class
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | COMBAT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The distance to remain at when fighting. This only affects your character when COMBAT_TYPE is "ranged" or when you use COMBAT_RANGED_PULL as melee.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | MAX_FIGHT_TIME
| style="border-bottom:1px dotted #000000;" | If you stop damaging a target within this amount of time, you will skip this target (prevents getting stuck).
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | DOT_PERCENT
| style="border-bottom:1px dotted #000000;" | Use DOTs on this target only if it has more than this percentage of HP.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | ANTI_KS
| style="border-bottom:1px dotted #000000;" | Whether or not to avoid stealing other players' kills. true or false.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Waypoint and Movement'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINTS
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use. Must reside in the 'waypoints' folder!
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RETURNPATH
| style="border-bottom:1px dotted #000000;" | The filename (including .xml extension) of the waypoint script to use for returning after death. Must reside in the 'waypoints' folder!
|-

| style="width: 200px; border-bottom:1px dotted #000000;" | PATH_TYPE
| style="border-bottom:1px dotted #000000;" | The type of movement to use. Should be either 'waypoints' or 'wander'. See path types for more information.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WANDER_RADIUS
| style="border-bottom:1px dotted #000000;" | The distance that your character is allowed to "wander" freely when using wander mode.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | WAYPOINT_DEVIATION
| style="border-bottom:1px dotted #000000;" | A 'random' offset applied to each waypoint in your path giving it less of a bot-like appearance; suggested value of 50. Lower value means you stick closer to your normal path; 0 means no deviation.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | QUICK_TURN
| style="border-bottom:1px dotted #000000;" | Whether or not to use quick turn mode. Quick turn mode emulates a click-to-move type movement style. This means your character does not stop to slowly turn around.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Level Difference'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_ABOVE
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy above your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels above your own.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | TARGET_LEVELDIF_BELOW
| style="border-bottom:1px dotted #000000;" | The maximum level of enemy below your own to engage in combat. i.e. a value of 5 means you will attack monsters up to 5 levels below your own.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Looting'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT
| style="border-bottom:1px dotted #000000;" | Whether you want to loot enemies or not. True or false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_IN_COMBAT
| style="border-bottom:1px dotted #000000;" | Whether or not you want to pick up loot when other enemies are still attacking you.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_DISTANCE
| style="border-bottom:1px dotted #000000;" | The max distance away a corpse can be that you will attempt to loot.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOOT_PAUSE_AFTER
| style="border-bottom:1px dotted #000000;" | A percentage probability to attempt a short "rest" (to look more human) after looting an enemy.
|}

{|
|-
| style="background-color: #C0C0FF; text-align: center;" | '''Log out & Resurrection Settings'''
|
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_TIME
| style="border-bottom:1px dotted #000000;" | Log out after this amount of time (in minutes). A value of 0 means you will not use this setting. Default: 0
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_WHEN_STUCK
| style="border-bottom:1px dotted #000000;" | If your character gets stuck and cannot unstuck himself, you can use this option to have him log off. Default: true
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | LOGOUT_SHUTDOWN
| style="border-bottom:1px dotted #000000;" | If you want to have the computer automatically shutdown after automatically logging out. Default: false.
|-
| style="width: 200px; border-bottom:1px dotted #000000;" | RES_AUTOMATIC_AFTER_DEATH
| style="border-bottom:1px dotted #000000;" | Whether or not your character should attempt resurrecting when he dies. Default: true
|}

===Profile - Friends===
The "Friends" list can be used to mark targets that you do not want to attack. This can be other players that may be marked for PVP, or targets that you want to ignore (ie. "Ystra Ferret"). You may also add players to your friend list to get the bot to assist them when it notices they are fighting something.

Example:
<source lang="xml">
<friends>

<friend name="Jack" /> 
<friend name="Jill" /> 
<friend name="Ambas" /> 
</friends>
</source>

If you want to use umlauts in your friends list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<friend name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Mobs===
The "Mobs" list can be used to limit the mobs we will attack. That can be helpful if you only want to attack one kind of mobs (e.g. for doing a daily). Leave the list empty if you don't want to restrict the bot.

Example:
<source lang="xml">
<mobs>

<mob name="Fungus" />
<mob name="" />
<mob name="" />
</mobs>
</source>

If you want to use umlauts in your list, you have to use the escape character with the proper ascii code, since LUA can't handle umlauts (ü=\129, ä=\132, ö=\148, ...). For a mob named 'Kuhkäfer' if would look like
<mob name="Kuhk\132fer" />
For more ASCII character look at the [http://www.cdrummond.qc.ca/cegep/informat/Professeurs/Alain/files/ascii.htm extended ASCII table].

===Profile - Hotkeys===
<source lang="xml"><hotkeys>

<hotkey name="MACRO" key="VK_0" />
</hotkeys></source>

Although your main hotkeys are configured either through settings.xml or your bindings.txt files, hotkeys for action bars are character or profile specific.

We need only the hotkey to your [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro].

{|
|- style="padding: 8px;" |
| style="width: 200px; border-bottom:1px dotted #000000;" | MACRO
| style="border-bottom:1px dotted #000000;" | The hotkey that we use to communicate with the [http://www.solarstrike.net/wiki/index.php5?title=RoM_Configuration#Settings_up_a_Macro ingame dummy macro]. We will call RoM API functions that way
|}

If you used a former bot version before: You now can delete your 'old' hotkeys like RES_MACRO, LOGOUT_MACRO, ...) We don't need them anymore.

===Profile - Skills===
The bot will only attempt to use skills that are noted in your profile. There are two different ways to set skills up: using the 'skills' tag (does not depend on class) or using 'skills_class' (where class is an actual in-game class) tags.

When using the 'skills' tag, it does not mater which main class your character currently is. This works pretty well for non-class specific skills that you wish to use for either class combination. For example, MAGE_FIREBALL is usable as both a mage/priest and priest/mage. Placing MAGE_FIREBALL into this tag will allow it to be used as either mage or priest primary class.

Example:
<source lang="xml">
<skills>
<skill name="MAGE_FIREBALL" hotkey="VK_7" priority="110" hpper="30" inbattle="true" />
</skills>
</source>

You may often use different sets of skills for your two classes. This is when a class-specific skill tag is strongly suggested (that way you don't need to re-confgiure your profile every time you change classes). Skills placed inside this tag will only be used when it matches your primary class. For example, 'skills_mage' skills will only be used when mage is your primary class.

Example:
<source lang="xml">
<skills_mage>
<skill name="MAGE_FLAME" hotkey="VK_3" priority="80" />
</skills_mage>

<skills_priest>
<skill name="PRIEST_RISING_TIDE" hotkey="VK_3" priority="80" />
</skills_priest>
</source>

'''Hotkeys:'''
You can only use hotkeys without modifiers. Normaly that are the keys 'a-z' and '0-9'. If you want to use special keys like MINUS, PLUS, ... take a look into the file '\micromacro\lib\mods\keyboard\en_uk.lua' to find the right virtual keyname. Alternately you can assign the hotkey "MACRO". In that case the skill will be cast by using the RoM API function 'CastSpellByName()' via the MACRO hotkey (it is not garanted, that all needed skill names are within the database file 'skills_local.xml').

'''Skill over-rides:'''
You can over-ride a few options to your skills. Particularly, those skills you want to limit to only use in battle, or set to use at a certain health percent (such as heals).

{|
|- style="padding: 8px;" |
| style="width: 100px; border-bottom:1px dotted #000000;" | priority
| style="border-bottom:1px dotted #000000;" | Higher priority means it will use it before other skills. Use 100+ for your opening attacks.
|-
| style="border-bottom:1px dotted #000000;" | hpper
| style="border-bottom:1px dotted #000000;" | Percentage of HP to use the skill at. Your HP % must be below that level (or above if using '!' eg. "!50") to use the skill. This will over-ride HP_LOW for heals!
|-
| style="border-bottom:1px dotted #000000;" | manaper
| style="border-bottom:1px dotted #000000;" | Percentage of Mana to use the skill at. Your Mana % must be below that level (or above if using '!' eg. "!50") to use the skill.
|-
| style="border-bottom:1px dotted #000000;" | inbattle
| style="border-bottom:1px dotted #000000;" | Either true or false. True means it only can be used in battle; false means if only can be used out of battle.
|-
| style="border-bottom:1px dotted #000000;" | targethp
| style="border-bottom:1px dotted #000000;" | Targets HP in healthpoints has to be below this level to use the skill (or above if using '!' eg. "!2000").
|-
| style="border-bottom:1px dotted #000000;" | targethpper
| style="border-bottom:1px dotted #000000;" | Targets HP in percentage has to be below this level to use the skill (or above if using '!' eg. "!50").
|-
| style="border-bottom:1px dotted #000000;" | rebuffcut
| style="border-bottom:1px dotted #000000;" | Recast that skill x seconds before the cooldown/duration fades out. Thats usefull for your own buffs.
|-
| style="border-bottom:1px dotted #000000;" | cooldown
| style="border-bottom:1px dotted #000000;" | Cooldown/duration value for that skill. If not set, we use the default value from the skill. You can overwrite that here for special situations.
|-
| style="border-bottom:1px dotted #000000;" | pullonly
| style="border-bottom:1px dotted #000000;" | Can only be used in the pull phase at the begin of a fight. They will not be used during the rest of the fight (only for melee classes if option 'COMBAT_RANGED_PULL' is set to 'true').
|-
| style="border-bottom:1px dotted #000000;" | maxuse
| style="border-bottom:1px dotted #000000;" | Skills with that option will only be used 'maxuse'-times within a fight.
|-
| style="border-bottom:1px dotted #000000;" | autouse
| style="border-bottom:1px dotted #000000;" | Skills with autouse=false will not be automaticly casted from the Bot. Thats usefull if you want to cast a skill only in a event like '<onSkillCast>' .
|}

===Profile - Events===
While botting, several events may be triggered. When these events are triggered, you may have custom Lua code executed. This code is placed directly in the event-specific tags inside your profile.

Events include:
* onLoad : When the profile is loaded
* onDeath: When your character dies
* onLeaveCombat: When leaving combat
* onSkillCast: Triggered after your character uses a skill

onSkillCast will, additionally, receive a Lua table ('arg1') that is a copy of the skill being cast. You can use this to query information about the skill. This can be useful in "skill chaining."

Examples:
<source lang="xml">
<onLoad>
-- Load a waypoint path based on level
if( player.Level > 10 ) then
loadPaths("some_path");
else
loadPaths("some_other_path");
end
</onLoad>

<onDeath>
printf("\a\a\a"); -- BEEP BEEP BEEP!
pauseOnDeath(); -- Wait for me. Do not continue script execution
</onDeath>

<onLeaveCombat>
if( player.Level > player.free_counter1) then
player.free_counter1 = player.Level;

-- levelup skills
-- 4 = third skill tab, 2 = mage flame
if( player.Level == 2 ) then
send_macro("SetSpellPoint( 4, 2 );");
yrest(1000);
send_macro("SetSpellPoint( 4, 2 );");
else
player.free_counter1 = player.Level;
send_macro("SetSpellPoint( 4, 2 );");
end

-- open giftbag and equipt content
-- updates first 18 bag slots / update all if empty
open_giftbag(player.Level, 18);
end
</onLeaveCombat>

<onSkillCast>
if( arg1.Name == "PRIEST_HOLY_AURA" ) then
yrest(1000);
player:cast("PRIEST_URGENT_HEAL");
end
</onSkillCast>
</source>

== In-Game Settings ==
In order for the bot to fully work, you will need to modify a few in-game settings. You should start with the Interface Settings and then set up your macro hotkey.

===Interface Settings===
Bring up your interface settings under the System menu. Under control, make sure that '''Click-to-move''' and '''Self Cast''' are checked. Under Miscellaneous, also check '''Auto loot'''.

===Settings up a Macro===
This macro is how the bot will interface with RoM's API. You should type ''/macro'' into the game's chat to bring up the macro window. Select the top-left most box and click '''New''', and in the new window that pops open click '''Save'''.

It should now look like this:

[[Image:rom_macro_screen.png]]

Now, all you need to do is click and drag this new icon in your macro window into your hotkey bar and set your MACRO hotkey in [[RoM_Configuration#Profile_-_Hotkeys|profile hotkeys]] to reflect this change.

Note that the macro slot directly to the right of the one you just created will also be used internally. Do not keep macros you intend to use there.

== Expert Settings ==

===Expert Profile - Options===

MAX_TARGET_DIST = 999, -- maximum distance to select a target (helpfull to limit at small places)
AUTO_ELITE_FACTOR = 4, -- mobs with x * your HP value counts as 'Elite' and we will not target it
SKILL_USE_PRIOR = 300, -- cast x ms before cooldown is finished
PK_COUNTS_AS_DEATH = true, -- count playerkill's as death
POTION_COOLDOWN = 15, -- allways 15
POTION_COOLDOWN_HP = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
POTION_COOLDOWN_MANA = 0, -- will only be used if not 0, if 0 POTION_COOLDOWN will be used
WAYPOINTS_REVERSE = false, -- use the waypoint file in reverse order
MAX_DEATHS = 10, -- maximal death if automatic resurrect befor logout
WAIT_TIME_AFTER_RES = 8000, -- time to wait after resurrection, needs more on slow PCs
RETURNPATH_SUFFIX = "_return", -- suffix for default naming of returnpath
HARVEST_SCAN_WIDTH = 10, -- steps horizontal
HARVEST_SCAN_HEIGHT = 8, -- steps vertical
HARVEST_SCAN_STEPSIZE = 35, -- wide of every step
HARVEST_SCAN_TOPDOWN = false, -- true = top->down false = botton->up
HARVEST_SCAN_XMULTIPLIER = 1.0, -- multiplier for scan width
HARVEST_SCAN_YMULTIPLIER = 1.1, -- multiplier for scan line height
HARVEST_SCAN_YREST = 10, -- scanspeed
HARVEST_SCAN_YMOVE = 1.1, -- move scan area top/down ( 1=middle of screen )
USE_SLEEP_AFTER_RESUME = false, -- enter sleep mode after pressing pause/resume key
IGNORE_MACRO_ERROR = false, -- ignore missing MACRO hotkey error (only temporary option while beta)
DEBUG_INV = false, -- to help to find the item use error (only temporary option while beta)
INV_MAX_SLOTS = 60, -- maximal slots to update in the inventory:update()

RoM Functions

2010-07-20T05:35:52Z

203.219.213.111: /* Player Functions */

== 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

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.

== 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.

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);
Attempts to target and interact with a nearby NPC with the name given by '_npcname'. This may be used for buying potions, arrows, and more.

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);
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.(Required)

_waittime = time to wait if the object takes time to open in ms. (Optional, default is 0)

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

_donotignore = By default, when collecting multiple objects with the _harvestall option, the bot will ignore the current node when searching for the next nearest node so it can quickly move on to the next node while the current one is still disappearing. Set this option to 'true' if you don't want to ignore the current node because it requires more than 1 click to collect it. (Default is false).

Examples:

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

player:target_Object("Mysterious Mound",3000) -- Target then wait 3 seconds for search to end. Done only once.

player:target_Object("Ranch Hen", 8000, true, true) -- Feed all nearby hens, waiting 8s after each. And do not ignore the current hen when searching for the next closest.

player:findNearestNameOrId(_objnameorid)
Finds the nearest object without targeting it. Accepts the items name or id as argument. Returns the object or nil if not found.

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.

== Inventory and Item Functions ==

inventory:getItemCount(itemId)

examples:
if( inventory:getItemCount(214536) > 25 ) then
loadPaths("deliver_quest");
end
Get the quantity for a item directly from the games client.

inventory:itemTotalCount(itemNameOrId)
Get the quantity for a item from the cached inventory. You have to be sure, that your inventory is up to date to get the right values. You can use the item-id or the name of the item

inventory:useItem(itemNameOrId)
Use a item from the cached inventory.

inventory:update()
Update the whole inventory from the games client. Depending from you slots, that takes about 10-15 seconds. Nevertheless from using that function, the bot updates the whole inventory at the bot starting time and about 3-4 slots after every fight and about 10-15 slots while the bot is looting.

By default the bot updates slot 1-60. If you want to use more slots please use the profile option
<option name="INV_MAX_SLOTS" value="120" /> 
Use the option
<option name="INV_MAX_SLOTS" value="0" /> 
if you want to deactivate the inventory update.

== Waypoint File Functions ==

__WPL:reverse();
Resort the waypoints. Means after running from 1 to 20 you can now run from 20 - 1. It is usefull to put that at the first and at the last waypoint if you want to run between two places.

__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]