org.osbot.rs07.api.util

Class ExperienceTracker

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.util.ExperienceTracker

public class ExperienceTracker
extends API

A tool to track gained experience.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
ExperienceTracker() Creates an instance of the ExperienceTracker to easily track gained experience.

Method Summary

Modifier and Type	Method and Description
MethodProvider	exchangeContext(Bot bot) This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions.
long	getElapsed(Skill skill) Calculates the milliseconds since the tracker was started for the specified skill.
int	getGainedLevels(Skill skill) Will return the levels gained in the specified skill since you have called the start method for that specific skill.
int	getGainedXP(Skill skill) Will return the experience gained in the specified skill since you have called the start method for that specific skill.
int	getGainedXPPerHour(Skill skill) Will return the experience gained per hour in the specified skill since you have called the start method for that specific skill.
long	getTimeToLevel(Skill skill) Will return the time that it will take until you reach the next level at your current experience per hour rate.
void	initializeModule()
void	start(Skill skill) Starts keeping track of experience gained in the specified skill.
void	startAll() Starts keeping track of all experience gained in each skill.

Methods inherited from class org.osbot.rs07.script.MethodProvider

execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperienceTracker

public ExperienceTracker()

Creates an instance of the ExperienceTracker to easily track gained experience.

Method Detail

exchangeContext

public MethodProvider exchangeContext(Bot bot)

This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions. If you create your own extensions you extend the API class or MethodProvider and if you want to provide the existing API components to your own extensions you override this method with a call to this method first by calling super.exchangeContext(bot) followed by the initialization of your own components on which you call this method on.

Overrides:

exchangeContext in class MethodProvider

Parameters:

bot - The Bot instance.

Returns:

The instance of this API extension.

startAll

public void startAll()

Starts keeping track of all experience gained in each skill. Using this method again will reset the counter.

start

public void start(Skill skill)

Starts keeping track of experience gained in the specified skill. Using this method again will reset the counter.

Parameters:

skill - The specific skill you want to track gained experience for.

getElapsed

public long getElapsed(Skill skill)

Calculates the milliseconds since the tracker was started for the specified skill.

Parameters:

skill - The skill.

Returns:

The time in milliseconds since the tracker was started for the specified skill.

getGainedXP

public int getGainedXP(Skill skill)

Will return the experience gained in the specified skill since you have called the start method for that specific skill.

Parameters:

skill - The skill you want to obtain the gained experience for.

Returns:

The amount of experience gained since the start method was called for the specific skill.

getGainedXPPerHour

public int getGainedXPPerHour(Skill skill)

Will return the experience gained per hour in the specified skill since you have called the start method for that specific skill.

Parameters:

skill - The skill you want to obtain the gained experience for.

Returns:

The amount of experience per hour gained since the start method was called for the specific skill.

getGainedLevels

public int getGainedLevels(Skill skill)

Will return the levels gained in the specified skill since you have called the start method for that specific skill.

Parameters:

skill - The skill you want to obtain the gained levels for.

Returns:

The amount of levels gained since the start method was called for the specific skill.

getTimeToLevel

public long getTimeToLevel(Skill skill)

Will return the time that it will take until you reach the next level at your current experience per hour rate.

Parameters:

skill - The skill you want to get the time to next level for.

Returns:

The amount of time in milliseconds until next level your current experience per hour rate.

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API