Package net.runelite.client.plugins.skillcalculator.skills

Interface SkillAction

All Known Subinterfaces:

ItemSkillAction, NamedSkillAction

All Known Implementing Classes:

AgilityAction, ConstructionAction, CookingAction, CraftingAction, FarmingAction, FiremakingAction, FishingAction, FletchingAction, HerbloreAction, HunterAction, MagicAction, MiningAction, PrayerAction, RunecraftAction, SmithingAction, ThievingAction, WoodcuttingAction

public interface SkillAction

An object representing a single skill action which grants some xp.

Method Summary

Modifier and Type	Method	Description
default Set<? extends SkillBonus>	getExcludedSkillBonuses()
default int	getIcon()	Gets the item icon ID for this skill action, if applicable.
int	getLevel()	Gets the level required to perform this skill action.
String	getName(ItemManager itemManager)	Gets the name of this skill action, usually the item or object created, or the spell cast.
default int	getSprite()	Gets the sprite ID for this skill action, if applicable.
float	getXp()	Gets the amount of xp granted for performing this skill action.
default boolean	isBonusApplicable(SkillBonus bonus)	Returns true if this skill action is affected by the specified skill bonus, false otherwise.
boolean	isMembers(ItemManager itemManager)

Method Detail

getName

String getName(ItemManager itemManager)

Gets the name of this skill action, usually the item or object created, or the spell cast. This name may be fetched via ItemComposition.getMembersName() from some defined item ID or explicitly defined.

Parameters:

itemManager - An item manager instance.

Returns:

The name of this skill action.

getLevel

int getLevel()

Gets the level required to perform this skill action.

Returns:

The level required to perform this skill action.

getXp

float getXp()

Gets the amount of xp granted for performing this skill action.

Returns:

The amount of xp granted for performing this skill action.

getIcon

default int getIcon()

Gets the item icon ID for this skill action, if applicable.

Note: Either this method or getSprite() will always return -1, and the other will return some value 0 or greater.

Returns:

The item icon ID of this skill action, or -1 if its icon should be represented using a sprite.

See Also:

ItemID, getSprite()

getSprite

default int getSprite()

Gets the sprite ID for this skill action, if applicable.

Note: Either this method or getIcon() will always return -1, and the other will return some value 0 or greater.

Returns:

The sprite ID of this skill action, or -1 if its icon should be represented using an item icon.

See Also:

SpriteID, getIcon()

isBonusApplicable

default boolean isBonusApplicable(SkillBonus bonus)

Returns true if this skill action is affected by the specified skill bonus, false otherwise.

Returns:

true if this skill action is affected by the specified skill bonus, false otherwise.

isMembers

boolean isMembers(ItemManager itemManager)

getExcludedSkillBonuses

default Set<? extends SkillBonus> getExcludedSkillBonuses()