org.osbot.rs07.api

Class Combat

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Combat

public class Combat
extends API

Represents the API regarding combat functionality.

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
Combat()

Method Summary

Modifier and Type	Method and Description
int	getCombatLevel()
Character	getFighting() Retrieves the character which your player is fighting.
int	getSpecialPercentage() The amount of special attack energy you have in percentages.
void	initializeModule()
boolean	isAutoRetaliateOn() True if your auto retaliate is on.
boolean	isDiseased() Checks to see if you are diseased.
boolean	isFighting() Checks if your player is in combat with a character.
boolean	isPoisoned() Checks to see if you are poisoned.
boolean	isPoisonImmune() Checks to see if you are immune to poison.
boolean	isSpecialActivated() True if you special attack is activated.
boolean	isVenomed() Checks to see if you are venomed.
void	toggleAutoRetaliate(boolean activate) Sets your auto retaliate to activated or disabled.
void	toggleSpecialAttack(boolean activate) A convenience method for toggleSpecialAttack(boolean) with useOrb provided as true
void	toggleSpecialAttack(boolean activate, boolean useOrb) Sets your special attack to activated or disabled.

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

exchangeContext, 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

Combat

public Combat()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getSpecialPercentage

public int getSpecialPercentage()

The amount of special attack energy you have in percentages.

Returns:

Your special attack energy from 0 to 100.

isSpecialActivated

public boolean isSpecialActivated()

True if you special attack is activated.

Returns:

True if you special attack is activated.

isAutoRetaliateOn

public boolean isAutoRetaliateOn()

True if your auto retaliate is on.

Returns:

True if your auto retaliate is on.

isPoisoned

public boolean isPoisoned()

Checks to see if you are poisoned.

Returns:

True if your player is poisoned.

isVenomed

public boolean isVenomed()

Checks to see if you are venomed.

Returns:

True if your player is venomed.

isPoisonImmune

public boolean isPoisonImmune()

Checks to see if you are immune to poison.

Returns:

True if your player is immune to poison.

isDiseased

public boolean isDiseased()

Checks to see if you are diseased.

Returns:

True if your player is diseased.

getCombatLevel

public int getCombatLevel()

Returns:

Your current combat level.

toggleSpecialAttack

public void toggleSpecialAttack(boolean activate)

A convenience method for toggleSpecialAttack(boolean) with useOrb provided as true

toggleSpecialAttack

public void toggleSpecialAttack(boolean activate,
                                boolean useOrb)

Sets your special attack to activated or disabled.

Parameters:

activate - Whether to toggle on or off your special attack.

useOrb - True to enable usage of the minimap orbs if possible

toggleAutoRetaliate

public void toggleAutoRetaliate(boolean activate)

Sets your auto retaliate to activated or disabled.

Parameters:

activate - Whether to toggle on or off your auto retaliate.

getFighting

public Character getFighting()

Retrieves the character which your player is fighting.

Returns:

The character your player is fighting.

isFighting

public boolean isFighting()

Checks if your player is in combat with a character.

Returns:

True if you are in combat.