SolarStrike wiki - User contributions [en]

User Functions Repository

2011-06-15T10:55:49Z

Rock5: /* Other Files */

Below is a listing of user functions collected from the forums. Below that is a separate list for other relevant files that are not specifically user functions. Please remember that when adding items to the lists to also include a page for the relevant item, detailing it's usage, download, functions, details and the like.

== Terminology ==

'''Name:''' The name of the script. Click the name to go to the script's specific page.

'''Description:''' A brief description of the script.

'''Version:''' The version of the script stored here.

'''LKC Version:''' The '''L'''ast '''K'''nown '''C'''ompatiable Version, or the last revision of RoMbot this is known to work for.

'''Author:''' The creator of the script.

== User Functions List ==

''To download refer to the linked pages.''
{| border="1" cellspacing="0" cellpadding="2" width="100%"
| Name || Description || Version || LKC Version || Author
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1561 Rock5's Mail Mods] || General purpose mail handling functions. || 1.52 || Unknown || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1566 Rock5's catchCavy script] || Function to catch cavies. || 1.02 || Unknown || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1434 Rock5's Fusion Control Functions] || Functions for controlling the fusion addon and related functions. || 0.1 || Unknown || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1931 Teleport Addon] || A script to use a hacked teleport, it's a memory hack so It can't be used for long distances. It is currently used to provide teleporting inside Miller's Ranch in a file I created (Distance<129). Other Zones/Instances may have a different "rubber-band" threshold. (thx to fobsauce)|| 1.2 || r549 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1977 Use Food] ||USAGE: UseFood(_foodname[,_buffname]) _foodname is the name of the food and _buffname is meant to use when the buff hasn't got the same name as the food (e.g. house maid foods), note that this works for anything else you need to use and produces a buff.|| 1.00 || r551 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1984 showDQ] ||This simple code Is used to print how many dailies you have left to do. It also may create an ingame macro. I find it useful to spam this while doing dailies so I know how far along am I at a simple glimpse of the screen. USAGE: showDQ([slot_nr,macro_name])|| 2.00 || r553 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1985 swapClass] ||Swaps classes at an NPC. This code was submitted to me by raff, I only made small changes to it so I give him full credit for it. Hasn't been tested by me. || 2.0 || N/A || raff & jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?p=16844#p16844 lootBodies] ||When called tries to loot all lootable bodies in range. <span style="color:#FF0000"> * Obsolete. Built into bot as of revision 597 * </span>|| 1.1 || r554 || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2406 UseGoodie] ||Helps using housemaid potions, foods and should work also for other consumables. || V3 || Unknown || JDuarteDJ & Giram
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2034 track player] ||Records player info to a file. Can be adapted to record itemcount and much more. Easily used for multiboting. || 1.1 || N/A || lisa
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2068 gameText] ||This is used to print any kind of message to the game. for detailed info see the topic. USAGE: gameText(msg[,kind,channel,color,item])|| 1.00 || r560 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2184 QuestByName] ||This is usefull to accept/complete quests by their quest name or parts of it.|| 1.00 || r570 || JackBlonder
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2207 Guild Donation] ||This userfunction will Donate your resources to your guild.|| 1.2 || Unknown || lisa
|-
|}

== Other Files ==

''To download refer to the linked pages.''
{| border="1" cellspacing="0" cellpadding="2" width="100%"
| Name || Description || Version || LKC Version || Author

|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1956 Unknown Gift Grind] || A waypoint file with the sole purpose of mass accepting and decorating the Snowflake Tree || 1.00 || r549 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1931 Teleport Miller's Ranch Golden Eggs] || A waypoint file Modded from rock5's golden eggs script that uses teleport hack, and is made to optimize the duration of the script, also delivers now! || 1.2 || r562 || jduartedj
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1478 Miller's Ranch Eggs Script] ||Accepts and completes quest, collects feed sacks, feeds chickens, helps them lay and collects the eggs. ||2.0 || r513 || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=1478 Miller's Ranch Milk Script] || Accepts and completes quest, collects grass, feeds goat and collects milk. || 1.2 || r472 || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?p=10350#p10350 Autologin] || Options for auto login and character selection. || 1.3.1 || r464 || rock5
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2111&p=17607&sid=e31ee4b59fb283d0538073d4a810a846#p17607 Autologin 1.31 with boxes ] || Options for auto login and character selection wit account boxes. || 1.3.1 || r464 || swietlowka
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=21&t=2002 Assist_asHealer] || Waypointfile to let a healer assist the party. || 0.1 || r554 || JackBlonder
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=1931&start=83 Advanced Teleport Miller's Ranch Golden Eggs] || Waypoint files to collect a given number of fresh eggs before delivering the quest based on jduaredj's script || 1.11 || r561 || T_Zero
|-
| [http://www.solarstrike.net/phpBB3/viewtopic.php?f=27&t=2582 FDB Extractor and ROM .db LanguageFile Converter/Viewer] || fdb file extractor and db language converter/viewer || n/a || n/a || rock5
|-
|}

2010-07-06T18:05:04Z

Rock5:

== 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 '2' if the quest is completed and ready to be turned in, '1' if you have accepted the quest but haven't completed it yet and '0' if you have not accepted the quest. Some static variables have been set up to make it easier to use, COMPLETED, NOT_COMPLETED and NOT_ACCEPTED. For example:
if getQuestStatus("Strange Unity") == COMPLETED then -- Turn in quest

== Player Functions ==
player:harvest(["test"|id]);
Use 'player:harvest()' to scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground). Use 'player:harvest("test")' to list id's of objects in front of you (e.g. quest objects), use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id.

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 = CPawn(player.TargetPtr)
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 = CPawn(player.TargetPtr)
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: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 Functions

2010-07-06T17:50:55Z

Rock5:

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

== Player Functions ==
player:harvest(["test"|id]);
Use 'player:harvest()' to scan that waypoint for a harverst node and harvest that (at the moment only working if the RoM window is in foreground). Use 'player:harvest("test")' to list id's of objects in front of you (e.g. quest objects), use 'player:harvest(id-nr)' to scan and use/open a object with that given object-id.

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 = CPawn(player.TargetPtr)
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 = CPawn(player.TargetPtr)
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: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 Functions

2010-03-08T04:20:46Z

Rock5: /* User Functions */

RoM Functions

2010-03-08T03:22:42Z

Rock5: