View source for RoM Bot Api

== RoM Bot API and How To Use It ==
This API is a reference for information on events and functions usable with the RoM Bot. With this as your reference you can make the most customized script for your class ever! Due to recent and upcoming changes in the RoM Bot you will have the power to use item buffs with ease and cure\purify yourself as needed. Newer functions and events will be added as they are committed to the RoM Bot.

== Player Class Functions ==
The following functions are contained in the player class and can be used in any of the evens and profiles to further customize the RoM Bot to your liking.

''player:harvest( Id, secondTry)''

This function will attempt to harvest the Id given with the mouse, this means that the RoM client must be active and on top to successfully harvest.

''player:cast(skill)''

This function will make the player cast the skill given. Skill can be a skill object or a string with the name of the skill.


== RoM Bot Events ==
'''The following events occur based on the name of the tag, ex onDeath will be executed when the player dies.'''

''onLoad''

Lua code placed between the tags labeled onLoad in your profile will be executed before any waypoint script is loaded and thus before any combat and skill casting. This is useful to change the script or script parameters before the waypoint path is loaded.

''onDeath''

Lua code placed between the tags labeled onDeath in you profile will be executed when the player dies. This can be useful for a death based repair script that will automatically repair when you have died a certain amount of times.

''onLeaveCombat''

Lua code placed between the tags labeled onLeaveCombat in you profile will be executed when the player leaves combat, ex the player fights 2 Boars, once it kills both and is no longer fighting with anything else the event will be triggered. This is useful for checking if you have food buffs active and if not then to use the item.

''onLevelUp''

Lua code placed between the tags labeled onLevelUp in you profile will be executed when the player gains a level. This is useful for automatically increasing the level of the players skills.

'''The following events occur in order during the casting procedure of the RoM Bot.'''

''onPreSkillCast''

Lua code placed between the tags labeled onPreSkillCast in your profile will be executed before the skill is cast. This event is useful if you want to  
You must return true if you want the skill to be cast or false if you do not want to cast the skill.
arg1 holds the skill to be cast

''onSkillCast''

Lua code placed between the tags labeled onSkillCast in your profile will be executed after the skill has been cast. This event is useful for preforming combination attacks on the target.
arg1 holds the skill that was cast