RoM Functions - Revision history

74.7.51.187: /* Inventory and Item Functions */ Add deleteItemInSlot and information on how slots are numbered.

2013-03-07T16:57:41Z

‎Inventory and Item Functions: Add deleteItemInSlot and information on how slots are numbered.

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

2011-08-08T13:53:05Z

‎Waypoint File Functions: Added __WPL:getFileName() description

Pumbatoo: /* Player Functions */ using for code highlighting

2011-08-08T08:43:38Z

‎Player Functions: using <source lang="lua"> for code highlighting

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

2011-08-08T08:16:48Z

‎Waypoint File Functions: added function __WPL:setDirection(..)

203.219.213.111: /* General Functions */

2011-04-23T05:27:23Z

‎General Functions

203.219.213.111: /* Player Functions */

2011-04-19T06:57:24Z

‎Player Functions

203.219.213.111: /* General Functions */

2011-04-17T03:01:28Z

‎General Functions

203.219.213.111 at 06:20, 3 April 2011

2011-04-03T06:20:36Z

Rock5: /* Inventory and Item Functions */

2011-01-14T08:26:33Z

‎Inventory and Item Functions

Rock5: /* Player Functions */

2011-01-14T07:31:09Z

‎Player Functions

@@ Line 282: / Line 282: @@
   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 ==

@@ Line 304: / Line 304: @@
   __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 ==

@@ Line 226: / Line 226: @@
 '''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 example below targets all hens in the coop by checking their Z coordinate, with no ignoring.
- -- The evaluate function
+<source lang="lua">-- The evaluate function
- function henInCoop (address)
+function henInCoop (address)
    if CObject(address).Z > 3240 then
-   return true
+    return true
    else
-   return false
+    return false
    end
- end
+end
- -- The target hen command
+-- The target hen command
- player:target_Object("Ranch Hen", nil, true, true, henInCoop)
+player:target_Object("Ranch Hen", nil, true, true, henInCoop);</source>

← Older revision		Revision as of 08:16, 8 August 2011
Line 286:		Line 286:

	__WPL:reverse();		__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.	+	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.

@@ Line 6: / Line 6: @@
   changeProfileOption(_option, _value);
 change profile options and print values in MM protocol
   levelupSkill(_skillname [, _times] )

@@ Line 150: / Line 150: @@
        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);

@@ Line 36: / Line 36: @@
 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()
+  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).
+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)

@@ Line 42: / Line 42: @@
   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.
 == Player Functions ==

@@ Line 210: / Line 210: @@
 == Inventory and Item Functions ==
-  inventory:getItemCount(itemId)
+  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'.
-  examples:
-  if( inventory:getItemCount(214536) > 25 ) then
+example:
      loadPaths("deliver_quest");
   end
-  inventory:itemTotalCount(itemNameOrId)
+  inventory:getItemCount(itemNameOrId, range)
-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
+This function is obsolete. It is kept for backward compatibility. It is functionally the same as using inventory:itemTotalCount(itemNameOrId, range)
   inventory:useItem(itemNameOrId)
-Use a item from the cached inventory.
+Finds an item in the inventory by name or id then uses it.
   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.
+Update the whole inventory from the games client.
-By default the bot updates slot 1-60. If you want to use more slots please use the profile option
+ item:moveTo(bag)
- <option name="INV_MAX_SLOTS"	value="120" />	<!-- max slots for inventory scan -->
+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 ==

@@ Line 158: / Line 158: @@
        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.
+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:target_NPC(_npcname);