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

Enum SailingBonus

java.lang.Object

java.lang.Enum<SailingBonus>

net.runelite.client.plugins.skillcalculator.skills.SailingBonus

All Implemented Interfaces:

Serializable, Comparable<SailingBonus>, SkillBonus

public enum SailingBonus
extends Enum<SailingBonus>
implements SkillBonus

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREW_DECKHANDINESS_3
CREW_DECKHANDINESS_4
HORIZONS_LURE

Method Summary

Modifier and Type	Method	Description
Set<SailingBonus>	getCanBeStackedWith()	Gets the list of skill bonuses this skill bonus can be stacked with.
String	getName()	Gets the name of this skill bonus.
float	getValue()	Gets the multiplier for this skill bonus.
static SailingBonus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SailingBonus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HORIZONS_LURE

public static final SailingBonus HORIZONS_LURE

CREW_DECKHANDINESS_3

public static final SailingBonus CREW_DECKHANDINESS_3

CREW_DECKHANDINESS_4

public static final SailingBonus CREW_DECKHANDINESS_4

Method Detail

values

public static SailingBonus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SailingBonus c : SailingBonus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SailingBonus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCanBeStackedWith

public Set<SailingBonus> getCanBeStackedWith()

Description copied from interface: SkillBonus

Gets the list of skill bonuses this skill bonus can be stacked with.

Specified by:

getCanBeStackedWith in interface SkillBonus

Returns:

List of stackable skill bonuses

getName

public String getName()

Description copied from interface: SkillBonus

Gets the name of this skill bonus.

Specified by:

getName in interface SkillBonus

Returns:

The name of this skill bonus.

getValue

public float getValue()

Description copied from interface: SkillBonus

Gets the multiplier for this skill bonus. When multiplied with the skill action XP value, it yields the total amount of xp granted for that action. (eg. {@link SkillAction#getXp()} * {@link #getValue()} yields the full amount of xp gained)

Specified by:

getValue in interface SkillBonus

Returns:

The skill bonus multiplier.