script-sdk/org.tribot.script.sdk/Combat

Combat

open class Combat

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

Constructors

Combat

constructor()

Types

AttackStyle

enum AttackStyle

An attack style that is selectable on the combat tab

AutocastableSpell

enum AutocastableSpell

A spell that can be autocast

WeaponType

enum WeaponType

Functions

activateSpecialAttack

open fun activateSpecialAttack(): Boolean

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

open fun activateSpecialAttack(orb: Boolean): Boolean

Attempts to activate special attack

canUseSpecialAttack

open fun canUseSpecialAttack(): Boolean

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

getAttackingPlayer

open fun getAttackingPlayer(): Optional<Player>

Gets the player that we are attacking

getAttackStyleIndexFor

open fun getAttackStyleIndexFor(style: Combat.AttackStyle): Optional<Integer>

Gets the current attack style index for the specified attack style

getAttackStyleNames

open fun getAttackStyleNames(): List<String>

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

getAutocastSpell

open fun getAutocastSpell(): Optional<Combat.AutocastableSpell>

Gets the currently selected autocast spell

getCurrentAttackStyle

open fun getCurrentAttackStyle(): Combat.AttackStyle

Gets the current AttackStyle

getSelectedAttackStyleIndex

open fun getSelectedAttackStyleIndex(): Int

Gets the selected attack style index

getSpecialAttackPercent

open fun getSpecialAttackPercent(): Int

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

getWeaponName

open fun getWeaponName(): Optional<String>

Gets the current weapon name

getWeaponSpecialAttackPercent

open fun getWeaponSpecialAttackPercent(): Int

Gets the special attack percent required for the current weapon

open fun getWeaponSpecialAttackPercent(id: Int): Int

Gets the special attack percent required for the specified weapon

getWeaponType

open fun getWeaponType(): Combat.WeaponType

Gets the current weapon type

getWildernessLevel

open fun getWildernessLevel(): Int

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

isAttackStyleAvailable

open fun isAttackStyleAvailable(style: Combat.AttackStyle): Boolean

Checks if the specified attack style is currently available

isAttackStyleSet

open fun isAttackStyleSet(style: Combat.AttackStyle): Boolean

Checks if the specified attack style is currently set

isAutoRetaliateOn

open fun isAutoRetaliateOn(): Boolean

Checks if auto retaliate is on

isDefensiveAutocasting

open fun isDefensiveAutocasting(): Boolean

Checks if we are defensive autocasting

isInMultiCombat

open fun isInMultiCombat(): Boolean

Checks if we are in a multi combat zone

isInWilderness

open fun isInWilderness(): Boolean

Determines if the player character is in the wilderness.

isSpecialAttackEnabled

open fun isSpecialAttackEnabled(): Boolean

Checks if special attack is enabled (ex.

isSpecOrbDisabled

open fun isSpecOrbDisabled(): Boolean

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

isWeaponSpecialAttackAvailable

open fun isWeaponSpecialAttackAvailable(): Boolean

Checks if the currently equipped weapon supports special attacks

setAttackByIndex

open fun setAttackByIndex(index: Int): Boolean

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

setAttackByName

open fun setAttackByName(actionName: String): Boolean

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

setAttackStyle

open fun setAttackStyle(style: Combat.AttackStyle): Boolean

Sets the specified attack style

setAutocastSpell

open fun setAutocastSpell(spell: Combat.AutocastableSpell): Boolean

Attempts to autocast the specified autocastable spell, not using defensive

open fun setAutocastSpell(spell: Combat.AutocastableSpell, defensive: Boolean): Boolean

Attempts to autocast the specified autocastable spell

setAutoRetaliate

open fun setAutoRetaliate(active: Boolean): Boolean

Attempts to enable or disable auto retaliate