Combat

public class Combat

Contains utility methods for interacting with the combat tab and obtaining other combat related information

Types

AttackStyle

public enum AttackStyle

An attack style that is selectable on the combat tab

AutocastableSpell

public enum AutocastableSpell

A spell that can be autocast

WeaponType

public enum WeaponType

Functions

activateSpecialAttack

static boolean activateSpecialAttack()

Attempts to activate special attack, using the spec orb if able

static boolean activateSpecialAttack(boolean orb)

Attempts to activate special attack

canUseSpecialAttack

static boolean canUseSpecialAttack()

Checks if we have enough special attack energy to use a special attack

getAttackingPlayer

static Optional<Player> getAttackingPlayer()

Gets the player that we are attacking

getAttackStyleIndexFor

static Optional<Integer> getAttackStyleIndexFor(Combat.AttackStyle style)

Gets the current attack style index for the specified attack style

getAttackStyleNames

static List<String> getAttackStyleNames()

Gets the available attack actions (the text on the combat style tabs).

getAutocastSpell

static Optional<Combat.AutocastableSpell> getAutocastSpell()

Gets the currently selected autocast spell

getCurrentAttackStyle

static Combat.AttackStyle getCurrentAttackStyle()

Gets the current AttackStyle

getSelectedAttackStyleIndex

static int getSelectedAttackStyleIndex()

Gets the selected attack style index

getSpecialAttackPercent

static int getSpecialAttackPercent()

Gets the current amount of special attack available (out of 100)

getWeaponName

static Optional<String> getWeaponName()

Gets the current weapon name

getWeaponSpecialAttackPercent

static int getWeaponSpecialAttackPercent()

Gets the special attack percent required for the current weapon

static int getWeaponSpecialAttackPercent(int id)

Gets the special attack percent required for the specified weapon

getWeaponType

static Combat.WeaponType getWeaponType()

Gets the current weapon type

getWildernessLevel

static int getWildernessLevel()

Gets the level of wilderness the player character is in, based on WorldTile position.

isAttackStyleAvailable

static boolean isAttackStyleAvailable(Combat.AttackStyle style)

Checks if the specified attack style is currently available

isAttackStyleSet

static boolean isAttackStyleSet(Combat.AttackStyle style)

Checks if the specified attack style is currently set

isAutoRetaliateOn

static boolean isAutoRetaliateOn()

Checks if auto retaliate is on

isDefensiveAutocasting

static boolean isDefensiveAutocasting()

Checks if we are defensive autocasting

isInMultiCombat

static boolean isInMultiCombat()

Checks if we are in a multi combat zone

isInWilderness

static boolean isInWilderness()

Determines if the player character is in the wilderness.

isSpecialAttackEnabled

static boolean isSpecialAttackEnabled()

Checks if special attack is enabled (ex.

isSpecOrbDisabled

static boolean isSpecOrbDisabled()

Checks if the spec orb is disabled due to being in a PvP zone

isWeaponSpecialAttackAvailable

static boolean isWeaponSpecialAttackAvailable()

Checks if the currently equipped weapon supports special attacks

setAttackByIndex

static boolean setAttackByIndex(int index)

Attempts to select the specified combat style index if not already selected

setAttackByName

static boolean setAttackByName(String actionName)

Attempts to select the specified attack action if not already selected.

setAttackStyle

static boolean setAttackStyle(Combat.AttackStyle style)

Sets the specified attack style

setAutocastSpell

static boolean setAutocastSpell(Combat.AutocastableSpell spell)

Attempts to autocast the specified autocastable spell, not using defensive

static boolean setAutocastSpell(Combat.AutocastableSpell spell, boolean defensive)

Attempts to autocast the specified autocastable spell

setAutoRetaliate

static boolean setAutoRetaliate(boolean active)

Attempts to enable or disable auto retaliate